Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add cli command to show suggestions. #2299

Merged
merged 3 commits into from
Jan 22, 2022
Merged

feat: Add cli command to show suggestions. #2299

merged 3 commits into from
Jan 22, 2022

Conversation

Jason3S
Copy link
Collaborator

@Jason3S Jason3S commented Jan 22, 2022

New command:

Usage: cspell suggestions|sug [options] [words...]

Spelling Suggestions for words.

Options:
  -c, --config <cspell.json>            Configuration file to use.  By default
                                        cspell looks for cspell.json in the
                                        current directory.
  --locale <locale>                     Set language locales. i.e. "en,fr" for
                                        English and French, or "en-GB" for
                                        British English.
  --language-id <language>              Use programming language. i.e. "php" or
                                        "scala".
  -s, --no-strict                       Ignore case and accents when searching
                                        for words.
  --ignore-case                         Alias of --no-strict.
  --num-changes <number>                Number of changes allowed to a word
                                        (default: 4)
  --num-suggestions <number>            Number of suggestions (default: 8)
  --no-include-ties                     Force the number of suggested to be
                                        limited, by not including suggestions
                                        that have the same edit cost.
  --stdin                               Use stdin for input.
  -v, --verbose                         Show detailed output. (default: 0)
  -d, --dictionary <dictionary name>    Use dictionary.
  --dictionaries <dictionary names...>  Use dictionaries
  --no-color                            Turn off color.
  --color                               Force color
  -h, --help                            display help for command

New command:

```
Usage: cspell suggestions|sug [options] [words...]

Spelling Suggestions for words.

Options:
  -c, --config <cspell.json>            Configuration file to use.  By default
                                        cspell looks for cspell.json in the
                                        current directory.
  --locale <locale>                     Set language locales. i.e. "en,fr" for
                                        English and French, or "en-GB" for
                                        British English.
  --language-id <language>              Use programming language. i.e. "php" or
                                        "scala".
  -s, --no-strict                       Ignore case and accents when searching
                                        for words.
  --ignore-case                         Alias of --no-strict.
  --num-changes <number>                Number of changes allowed to a word
                                        (default: 4)
  --num-suggestions <number>            Number of suggestions (default: 8)
  --no-include-ties                     Force the number of suggested to be
                                        limited, by not including suggestions
                                        that have the same edit cost.
  --stdin                               Use stdin for input.
  -v, --verbose                         Show detailed output. (default: 0)
  -d, --dictionary <dictionary name>    Use dictionary.
  --dictionaries <dictionary names...>  Use dictionaries
  --no-color                            Turn off color.
  --color                               Force color
  -h, --help                            display help for command
```
@Jason3S Jason3S merged commit 1db4777 into main Jan 22, 2022
@Jason3S Jason3S deleted the dev-sug-cli branch January 22, 2022 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant