cspell¶
Bases: Tool[_R]
Bases: Tool[_R2]
__call__(
*args: str | PathLike[str],
color: Flag = ...,
config: Value = ...,
no_default_configuration: Flag = ...,
no_exit_code: Flag = ...,
validate_directives: Flag = ...,
**flags: Any,
) -> _R2
Spell check file(s) and display the result. The full file is displayed in color.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
color
|
Flag
|
Force color. |
...
|
config
|
Value
|
Configuration file to use. |
...
|
no_default_configuration
|
Flag
|
Do not load the default configuration and dictionaries. |
...
|
no_exit_code
|
Flag
|
Do not return an exit code if issues are found. |
...
|
validate_directives
|
Flag
|
Validate in-document CSpell directives. |
...
|
Bases: Tool[_R2]
__call__(
*args: str | PathLike[str],
cache: Flag = ...,
cache_location: Value = ...,
cache_reset: Flag = ...,
cache_strategy: Value = ...,
color: Flag = ...,
config: Value = ...,
continue_on_error: Flag = ...,
dictionary: Value = ...,
disable_dictionary: Value = ...,
dot: Flag = ...,
exclude: Value = ...,
fail_fast: Flag = ...,
file: Value = ...,
file_list: Value = ...,
gitignore: Flag = ...,
gitignore_root: Value = ...,
issue_template: Value = ...,
language_id: Value = ...,
locale: Value = ...,
max_file_size: Value = ...,
no_config_search: Flag = ...,
no_default_configuration: Flag = ...,
no_exit_code: Flag = ...,
no_issues: Flag = ...,
no_must_find_files: Flag = ...,
no_progress: Flag = ...,
no_relative: Flag = ...,
no_summary: Flag = ...,
quiet: Flag = ...,
report: Value = ...,
reporter: Value = ...,
root: Value = ...,
show_context: Flag = ...,
show_suggestions: Flag = ...,
silent: Flag = ...,
stop_config_search_at: Value = ...,
unique: Flag = ...,
validate_directives: Flag = ...,
verbose: Flag = ...,
words_only: Flag = ...,
**flags: Any,
) -> _R2
Run this verb.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cache
|
Flag
|
Use cache to only check changed files. |
...
|
cache_location
|
Value
|
Path to the cache file or directory. Defaults to |
...
|
cache_reset
|
Flag
|
Reset the cache file. |
...
|
cache_strategy
|
Value
|
Strategy to use for detecting changed files. |
...
|
color
|
Flag
|
Force color. |
...
|
config
|
Value
|
Configuration file to use. |
...
|
continue_on_error
|
Flag
|
Continue processing files even if there is a configuration error. |
...
|
dictionary
|
Value
|
Enable a dictionary by name. |
...
|
disable_dictionary
|
Value
|
Disable a dictionary by name. |
...
|
dot
|
Flag
|
Include files and directories starting with |
...
|
exclude
|
Value
|
Exclude files matching the glob pattern. May be repeated: a list emits the flag once per item. |
...
|
fail_fast
|
Flag
|
Exit after first file with an issue or error. |
...
|
file
|
Value
|
Specify files to spell check. May be repeated: a list emits the flag once per item. |
...
|
file_list
|
Value
|
Specify a list of files to be spell checked. |
...
|
gitignore
|
Flag
|
Ignore files matching glob patterns found in .gitignore files. |
...
|
gitignore_root
|
Value
|
Prevent searching for .gitignore files past root. |
...
|
issue_template
|
Value
|
Use a custom issue template. |
...
|
language_id
|
Value
|
Force programming language for unknown extensions. |
...
|
locale
|
Value
|
Set language locales. |
...
|
max_file_size
|
Value
|
Prevent checking large files. |
...
|
no_config_search
|
Flag
|
Disable automatic searching for additional configuration files in parent directories. |
...
|
no_default_configuration
|
Flag
|
Do not load the default configuration and dictionaries. |
...
|
no_exit_code
|
Flag
|
Do not return an exit code if issues are found. |
...
|
no_issues
|
Flag
|
Do not show the spelling errors. |
...
|
no_must_find_files
|
Flag
|
Do not error if no files are found. |
...
|
no_progress
|
Flag
|
Turn off progress messages. |
...
|
no_relative
|
Flag
|
Issues are displayed with absolute path instead of relative to the root. |
...
|
no_summary
|
Flag
|
Turn off summary message in console. |
...
|
quiet
|
Flag
|
Only show spelling issues or errors. |
...
|
report
|
Value
|
Set how unknown words are reported (choices: "all", "simple", "typos", "flagged"). |
...
|
reporter
|
Value
|
Specify one or more reporters to use. |
...
|
root
|
Value
|
Root directory, defaults to current directory. |
...
|
show_context
|
Flag
|
Show the surrounding text around an issue. |
...
|
show_suggestions
|
Flag
|
Show spelling suggestions. |
...
|
silent
|
Flag
|
Silent mode, suppress error messages. |
...
|
stop_config_search_at
|
Value
|
Specify a directory at which to stop searching for configuration files when walking up from the files being checked. |
...
|
unique
|
Flag
|
Only output the first instance of a word not found in the dictionaries. |
...
|
validate_directives
|
Flag
|
Validate in-document CSpell directives. |
...
|
verbose
|
Flag
|
Display more information about the files being checked. |
...
|
words_only
|
Flag
|
Only output the words not found in the dictionaries. |
...
|
Bases: Tool[_R2]
__call__(
*args: str | PathLike[str],
color: Flag = ...,
config: Value = ...,
dictionaries: Value = ...,
dictionary: Value = ...,
ignore_case: Flag = ...,
language_id: Value = ...,
locale: Value = ...,
no_include_ties: Flag = ...,
no_strict: Flag = ...,
num_changes: Value = ...,
num_suggestions: Value = ...,
repl: Flag = ...,
stdin: Flag = ...,
verbose: Flag = ...,
**flags: Any,
) -> _R2
Spelling Suggestions for words.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
color
|
Flag
|
Force color. |
...
|
config
|
Value
|
Configuration file to use. |
...
|
dictionaries
|
Value
|
Use the dictionaries specified. |
...
|
dictionary
|
Value
|
Use the dictionary specified. |
...
|
ignore_case
|
Flag
|
Alias of --no-strict. |
...
|
language_id
|
Value
|
Use programming language. |
...
|
locale
|
Value
|
Set language locales. |
...
|
no_include_ties
|
Flag
|
Force the number of suggested to be limited, by not including suggestions that have the same edit cost. |
...
|
no_strict
|
Flag
|
Ignore case and accents when searching for words. |
...
|
num_changes
|
Value
|
Number of changes allowed to a word. Defaults to |
...
|
num_suggestions
|
Value
|
Number of suggestions. Defaults to |
...
|
repl
|
Flag
|
REPL interface for looking up suggestions. |
...
|
stdin
|
Flag
|
Use stdin for input. |
...
|
verbose
|
Flag
|
Show detailed output. |
...
|
Bases: Tool[_R2]
__call__(
*args: str | PathLike[str],
all: Flag = ...,
allow_compound_words: Flag = ...,
color: Flag = ...,
config: Value = ...,
dictionary: Value = ...,
dictionary_path: Value = ...,
ignore_case: Flag = ...,
language_id: Value = ...,
locale: Value = ...,
no_default_configuration: Flag = ...,
no_dictionary: Value = ...,
only_found: Flag = ...,
stdin: Flag = ...,
**flags: Any,
) -> _R2
Trace words -- Search for words in the configuration and dictionaries.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
all
|
Flag
|
Show all dictionaries. |
...
|
allow_compound_words
|
Flag
|
Turn on allowCompoundWords. |
...
|
color
|
Flag
|
Force color. |
...
|
config
|
Value
|
Configuration file to use. |
...
|
dictionary
|
Value
|
Enable a dictionary by name. May be repeated: a list emits the flag once per item. |
...
|
dictionary_path
|
Value
|
Configure how to display the dictionary path. |
...
|
ignore_case
|
Flag
|
Ignore case and accents when searching for words. |
...
|
language_id
|
Value
|
Use programming language. |
...
|
locale
|
Value
|
Set language locales. |
...
|
no_default_configuration
|
Flag
|
Do not load the default configuration and dictionaries. |
...
|
no_dictionary
|
Value
|
Disable a dictionary by name. May be repeated: a list emits the flag once per item. Added in 9.6.4. |
...
|
only_found
|
Flag
|
Show only dictionaries that have the words. |
...
|
stdin
|
Flag
|
Read words from stdin. |
...
|