typos/crates/typos-cli/tests/cmd/help.toml

55 lines
2.6 KiB
TOML
Raw Normal View History

2023-10-02 14:10:05 -04:00
bin.name = "typos"
args = "--help"
stdout = """
Source Code Spelling Correction
2023-10-02 14:22:44 -04:00
Usage: typos[EXE] [OPTIONS] [PATH]...
2023-10-02 14:10:05 -04:00
Arguments:
[PATH]... Paths to check with `-` for stdin [default: .]
Options:
2023-04-06 19:39:21 -04:00
--file-list <FILE_LIST> Read the list of newline separated paths from file or stdin (if `-`)
-j, --threads <THREADS> The approximate number of threads to use [default: 0]
2024-02-07 17:06:19 -05:00
--sort Sort results
2023-04-06 19:39:21 -04:00
--force-exclude Respect excluded files even for paths passed explicitly
-h, --help Print help
-V, --version Print version
2023-10-02 14:22:44 -04:00
Config:
-c, --config <CUSTOM_CONFIG> Custom config file
--isolated Ignore implicit configuration files
--exclude <GLOB> Ignore files & directories matching the glob
--hidden Search hidden files and directories
--no-ignore Don't respect ignore files
--no-ignore-dot Don't respect .ignore files
--no-ignore-global Don't respect global ignore files
--no-ignore-parent Don't respect ignore files in parent directories
--no-ignore-vcs Don't respect ignore files in vcs directories
--binary Search binary files
--no-check-filenames Skip verifying spelling in file names
--no-check-files Skip verifying spelling in files
--no-unicode Only allow ASCII characters in identifiers
2024-03-01 10:18:03 -05:00
--locale <LOCALE> Language locale to suggest corrections for [possible values: en,
en-us, en-gb, en-ca, en-au]
2023-10-02 14:22:44 -04:00
Mode:
2023-10-02 14:10:05 -04:00
--diff Print a diff of what would change
-w, --write-changes Write fixes out
--files Debug: Print each file that would be spellchecked
--file-types Debug: Print each file's type
--identifiers Debug: Print each identifier that would be spellchecked
--words Debug: Print each word that would be spellchecked
--dump-config <DUMP_CONFIG> Write the current configuration to file with `-` for stdout
--type-list Show all supported file types
2023-10-02 14:22:44 -04:00
Output:
2024-03-01 10:18:03 -05:00
--format <FORMAT> Render style for messages [default: long] [possible values: silent, brief,
long, json]
--color <WHEN> Controls when to use color [default: auto] [possible values: auto, always,
never]
-v, --verbose... Increase logging verbosity
-q, --quiet... Decrease logging verbosity
2023-10-02 14:10:05 -04:00
"""
stderr = ""