Argument

The name prop for the git commit -m <msg> arg object is "msg". But you could also make it "message" or "your message". It is only used for description purposes (you see it when you type the message), not for parsing!

"Your commit message"

This is used for all arguments in the rm spec.

For git reset <branch or commit>, a two common arguments to pass are "head" and "head^". Therefore, the spec suggests both of these by using the suggestion prop

cd uses the "folders" template

ls used ["filepaths", "folders"]. Why both? Because if I ls a directory, we want to enable a user to autoexecute on this directory. If we just did "filepaths" they couldn't autoexecute.

npm uninstall [packages…] uses fuzzy search to allow searching for installed packages ignoring the package scope

const figSpec: Fig.Spec {
  name: "npm",
  subcommands: [
    {
      args: {
        name: "packages",
        filterStrategy: "fuzzy", // search in suggestions provided by the generator (in this case) using fuzzy search
        generators: generateNpmDeps,
        isVariadic: true,
      },
    },
    // ... other npm commands
  ],
}

echo takes a variadic argument (echo hello world ...)

git add also takes a variadic argument

When true for git add's argument: git add file1 -v file2 will interpret -v as an option NOT an argument, and will continue interpreting file2 as a variadic argument to add after

When true for -T's argument, where -T is a variadic list of tags: cmd -T tag1 tag2 -p project tag3 will interpret -p as an option, but will then terminate the list of tags. So tag3 is not parsed as an argument to -T, but rather as a subcommand argument to cmd if cmd takes any arguments.

When false: echo hello -n world will treat -n as an argument NOT an option. However, in echo -n hello world it will treat -n as an option as variadic arguments haven't started yet

git push [remote] [branch] takes two optional args.

time and builtin have only one argument and this argument has the isCommand property. If I type time git, Fig will load up the git completion spec because the isCommand property is set.

python take one argument which is a .py file. If I have a main.py file on my desktop and my current working directory is my desktop, if I type python main.py[space] Fig will look for a completion spec in ~/Desktop/.fig/autocomplete/build/main.py.js

For python -m, the user can input a specific module such as http.server. Each module is effectively a mini CLI tool that should have its own completions. Therefore the argument object for -m has isModule: "python/". Whatever the modules user inputs, Fig will look under the ~/.fig/autocomplete/python/ directory for completion spec.

npm install and pip install send debounced network requests after inactive typing from users.

git takes git aliases. These aliases are defined in a user's gitconfig file. Let's say a user has an alias for p=push, then if a user typed git p[space], this function would take the p token, return push and then offer suggestions as if the user had typed git push[space]

npm run <script> also takes an arg called "script". This arg is technically an alias for another shell command that is specified in the package.json. If the user typed npm run start[space], the package.json had script start=node index.js, then Fig would start offering suggestions for as if you had just typed node index.js[space]

Note: In both cases, the alias function is only used to expand a given alias NOT to generate the list of aliases. To generate a list of aliases, scripts etc, use a generator.