tbroadley/Spellchecker CLI
Spellcheck files in your repository.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| files | A list of files or globs to spellcheck, separated by spaces. | no | **/*.txt **/*.md |
| language | The language of the files. The default language is en-US. See Spellchecker CLI for details about which languages are supported. | no | — |
| dictionaries | A list of files to combine into a personal dictionary, separated by spaces. | no | — |
| noGitignore | Don't respect ignore files (.gitignore, .ignore, etc). | no | — |
| ignore | A list of regexes, separated by spaces. Spelling mistakes that match any of these regexes (after being wrapped with ^ and $) will be ignored. | no | — |
| plugins | A list of retext plugins to use. See Spellchecker CLI for details about default and available plugins. | no | — |
| noSuggestions | Do not print suggested replacements for misspelled words. This option will improve Spellchecker CLI's runtime when many errors are detected. | no | — |
| quiet | Do not output anything for files that contain no spelling mistakes. | no | — |
| frontmatterKeys | A list of frontmatter keys whose values should be spellchecked. By default, no values are spellchecked. Only valid when the frontmatter plugin is used. | no | — |
| reports | A list of report files to generate, separated by spaces. The type of the report is based on the extension of the file. (Supported: .junit.xml and .json) | no | — |
| config | A path to a config file. | no | — |
Outputs
no outputs