diff --git a/docs/features.md b/docs/features.md index ccbc54a..0b8a7fd 100644 --- a/docs/features.md +++ b/docs/features.md @@ -38,6 +38,11 @@ If the location is `["nms", "cmd"]` for an entryfile `cli.js`, the list of candi 5. `/index.js` - named import (`cmd`) 6. `/cli.js` - named import (`cmd`) +## Bash completion +`cli-er` includes a command to generate bash-completions for the cli. This can be configured through [`CliOptions.completion`](/docs/cli-options.md#completion), to change the name of such command, or to disable this behaviour. +The script was tested with `bash` version 3.2.57 and `zsh` version 5.9. +You can check [here](/examples/docker/completions.sh) the generated script for docker example. + ## Debug mode When active, the library will generate debug logs warning about problems, deprecations or suggestions. Two types exist: - `WARN`: to indicated misused or deprecated options. @@ -46,11 +51,5 @@ When active, the library will generate debug logs warning about problems, deprec If any `WARN` log is generated, the `exitCode` will be set to `1`, so a simple validation-workflow can be built with this. To see how to enable it check [`CliOptions.debug`](/docs/cli-options.md#debug). -## Bash completion -`cli-er` includes a command to generate bash-completions for the cli. This can be configured through [`CliOptions.completion`](/docs/cli-options.md#completion), to change the name of such command, or to disable this behaviour. -The script was tested with `bash` version 3.2.57 and `zsh` version 5.9. -You can check [here](/examples/docker/completions.sh) the generated script for docker example. - - ## Typescript support You can check [this example](/examples/ts-cli) on how to write a full typescript cli application. \ No newline at end of file