cspell¶

footman._stubs.cspell.Cspell ¶

Bases: Tool

call ¶

__call__(*args: str, **flags: Any) -> Result

Spelling Checker for Code

check ¶

check(
    *args: str,
    color: _Flag = ...,
    config: _Value = ...,
    no_default_configuration: _Flag = ...,
    no_exit_code: _Flag = ...,
    validate_directives: _Flag = ...,
    **flags: Any,
) -> Result

Spell check file(s) and display the result. The full file is displayed in color.

Parameters:

Name	Type	Description	Default
`color`	`_Flag`	Force color. `color=off` emits `--no-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. `validate_directives=off` emits `--no-validate-directives`.	`...`

flags ¶

flags(**flags: Any) -> Cspell

Bind tool-level global options before the subcommand.

tools.docker.flags(host=...) puts a tool's own options ahead of the verb, where they belong.

lint ¶

lint(
    *args: 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,
) -> Result

Run this verb.

Parameters:

Name	Type	Description	Default
`cache`	`_Flag`	Use cache to only check changed files. `cache=off` emits `--no-cache`.	`...`
`cache_location`	`_Value`	Path to the cache file or directory. Defaults to `.cspellcache`.	`...`
`cache_reset`	`_Flag`	Reset the cache file.	`...`
`cache_strategy`	`_Value`	Strategy to use for detecting changed files.	`...`
`color`	`_Flag`	Force color. `color=off` emits `--no-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 `.` (period) when matching globs.	`...`
`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=off` emits `--no-gitignore`.	`...`
`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. `show_suggestions=off` emits `--no-show-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.	`...`

suggest ¶

suggest(
    *args: 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,
) -> Result

Spelling Suggestions for words.

Parameters:

Name	Type	Description	Default
`color`	`_Flag`	Force color. `color=off` emits `--no-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 `4`.	`...`
`num_suggestions`	`_Value`	Number of suggestions. Defaults to `8`.	`...`
`repl`	`_Flag`	REPL interface for looking up suggestions.	`...`
`stdin`	`_Flag`	Use stdin for input.	`...`
`verbose`	`_Flag`	Show detailed output.	`...`

trace ¶

trace(
    *args: 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,
) -> Result

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. `allow_compound_words=off` emits `--no-allow-compound-words`.	`...`
`color`	`_Flag`	Force color. `color=off` emits `--no-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. `ignore_case=off` emits `--no-ignore-case`.	`...`
`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.	`...`
`only_found`	`_Flag`	Show only dictionaries that have the words.	`...`
`stdin`	`_Flag`	Read words from stdin.	`...`

cspell¶

footman._stubs.cspell.Cspell ¶

__call__ ¶

check ¶

flags ¶

lint ¶

suggest ¶

trace ¶

call ¶