Documentation: Add Fig Autocompletion to README.md #993

sagiegurari · Dec 15, 2023 · 5d65539 · 5d65539
1 parent 630ec7f
commit 5d65539
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ### v0.38.5
 
 * Enhancement: Enable setting default profile by env variable #996 (thanks @Johnabell)
+* Documentation: Add Fig Autocompletion to README.md #993 (thanks @beeinger)
 * Maintenance: update dependencies and build
 
 ### v0.37.4 (2023-10-31)

diff --git a/README.md b/README.md
@@ -117,6 +117,7 @@
     * [Shell Completion](#usage-shell-completion)
         * [Bash](#usage-shell-completion-bash)
         * [zsh](#usage-shell-completion-zsh)
+        * [Fig / Amazon CodeWhisperer for command line](#usage-shell-completion-fig)
     * [Global Configuration](#cargo-make-global-config)
 * [Makefile Definition](#descriptor-definition)
 * [Task Naming Conventions](#task-name-conventions)
@@ -4013,7 +4014,6 @@ source ./extra/shell/makers-completion.bash
 It will enable auto completion for the **makers** executable.
 
 <a name="usage-shell-completion-fig"></a>
-
 #### Fig / Amazon CodeWhisperer for command line
 
 Fig supports cargo-make as of [this PR](https://github.com/withfig/autocomplete/pull/2180), no special configuration is needed, just download the latest version of [Fig](https://fig.io/) or [Amazon CodeWhisperer for command line](https://aws.amazon.com/blogs/devops/introducing-amazon-codewhisperer-for-command-line/).

diff --git a/docs/_includes/content.md b/docs/_includes/content.md
@@ -3876,6 +3876,19 @@ source ./extra/shell/makers-completion.bash
 
 It will enable auto completion for the **makers** executable.
 
+<a name="usage-shell-completion-fig"></a>
+#### Fig / Amazon CodeWhisperer for command line
+
+Fig supports cargo-make as of [this PR](https://github.com/withfig/autocomplete/pull/2180), no special configuration is needed, just download the latest version of [Fig](https://fig.io/) or [Amazon CodeWhisperer for command line](https://aws.amazon.com/blogs/devops/introducing-amazon-codewhisperer-for-command-line/).
+
+Double check if `cargo-make` is globally installed by running:
+
+```bash
+cargo --list
+```
+
+If you can see `make` on the list, Fig should work and load the completion automatically from `./Makefile.toml` or any directory you specify with `--makefile <path>`
+
 <a name="cargo-make-global-config"></a>
 ### Global Configuration
 Some of the default CLI values and cargo-make behaviour can be configured via optional global configuration file `config.toml` located in the cargo-make directory.

diff --git a/docs/_includes/nav.md b/docs/_includes/nav.md
@@ -106,6 +106,7 @@
     * [Shell Completion](#usage-shell-completion)
         * [Bash](#usage-shell-completion-bash)
         * [zsh](#usage-shell-completion-zsh)
+        * [Fig / Amazon CodeWhisperer for command line](#usage-shell-completion-fig)
     * [Global Configuration](#cargo-make-global-config)
 * [Makefile Definition](#descriptor-definition)
 * [Task Naming Conventions](#task-name-conventions)