This repo contains the source for all of Fig tools related with autocomplete.
-
You can see the list of Fig's packages on the NPM registry here: https://www.npmjs.com/~withfig
-
You can see the source code and related README for each package in the
./packages
folder
@fig/autocomplete-generators
@fig/autocomplete-merge
@withfig/autocomplete-tools
@withfig/autocomplete-types
@withfig/clap
@withfig/cobra
@fig/complete-commander
@fig/eslint-config-autocomplete
@withfig/eslint-plugin-fig-linter
@withfig/oclif
@withfig/swift-argument-parser
Run yarn workspace <workspace name> publish
e.g.
yarn workspace @withfig/autocomplete-types publish
Note:
<workspace name>
is not the name of the folder, but the name specified inside the package.json of the package to publish.
- If namespaced it SHOULD be
@fig/complete[-_]($FRAMEWORK_NAME)
- If not namespaced it SHOULD be
($FRAMEWORK_NAME)[-_]complete[-_]fig
According to language conventions you can use a dash or an underscore to separate the words.
Examples:
@fig/complete-commander
@fig/complete-oclif
clap_complete_fig
Most of our CLI integration tools allow to set the name of the subcommand added to the CLI but we also provide a default value for that.
That default name MUST be generate-fig-spec
such that running $CLI generate-fig-spec
prints the spec.
The functions exported from the integration can:
- Create a new framework subcommand which will print the spec when invoked
- Generate a spec and return it
In all the cases the names are standardized and SHOULD be:
addCompletionSpecCommand
orcreateCompletionSpecCommand
for functions creating a new subcommandgenerateCompletionSpec
for functions that return the spec as a string
According to language conventions these function names can be transformed to snake case, etc...
Docs MUST conform to the rules listed above too.