Skip to content

Commit

Permalink
docs(command): add did-you-mean section to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
c4spar committed Jan 10, 2021
1 parent afd8697 commit 4dc9991
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions command/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@
- [Auto generated help](#-auto-generated-help)
- [Help option](#help-option)
- [Help command](#help-command)
- [Did you mean](#-did-you-mean)
- [Shell completion](#-shell-completion)
- [Completions command](#completions-command)
- [Bash Completions](#bash-completions)
Expand Down Expand Up @@ -1097,6 +1098,16 @@ $ deno run https://deno.land/x/cliffy/examples/command/help_option_and_command.t
$ deno run https://deno.land/x/cliffy/examples/command/help_option_and_command.ts completions help
```

## ❯ Did you mean

Cliffy has build-in *did-you-mean* support to improve the user and developer experience. For example, cliffy prints some
suggestions, when the user executes an invalid command, or the developer has a typo in the name of a type.

```
$ deno run https://deno.land/x/cliffy/examples/command/demo.ts -g
error: Unknown option "-g". Did you mean option "-h"?
```

## ❯ Shell completion

Cliffy supports shell completion out of the box.
Expand Down

0 comments on commit 4dc9991

Please sign in to comment.