-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathsyntax_test_codespell.txt
118 lines (115 loc) · 6.59 KB
/
syntax_test_codespell.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# SYNTAX TEST "cmd-help.sublime-syntax"
usage: codespell [-h] [--version] [-d] [-c] [-w] [-D DICTIONARY]
[--builtin BUILTIN-LIST] [--ignore-regex IGNORE_REGEX]
[-I FILE] [-L WORDS] [--uri-ignore-words-list WORDS]
[-r REGEX] [--uri-regex URI_REGEX] [-s] [--count] [-S SKIP]
[-x FILE] [-i INTERACTIVE] [-q QUIET_LEVEL] [-e] [-f] [-H]
[-A LINES] [-B LINES] [-C LINES] [--config CONFIG]
[files ...]
#nice: add tests/locks for argparse headings here
positional arguments:
files files or directories to check
options:
-h, --help show this help message and exit
--version show program's version number and exit
-d, --disable-colors disable colors, even when printing to terminal (always
set for Windows)
-c, --enable-colors enable colors, even when not printing to terminal
-w, --write-changes write changes in place if possible
-D DICTIONARY, --dictionary DICTIONARY
custom dictionary file that contains spelling
corrections. If this flag is not specified or equals
"-" then the default dictionary is used. This option
can be specified multiple times.
--builtin BUILTIN-LIST
# ^^^^^^^^^^^^ entity.name.function.option.cmd-help keyword.other.argument.cmd-help
comma-separated list of builtin dictionaries to
include (when "-D -" or no "-D" is passed). Current
options are:
- 'clear' for unambiguous errors
- 'rare' for rare (but valid) words that are likely to
be errors
- 'informal' for making informal words more formal
- 'usage' for replacing phrasing with recommended
terms
- 'code' for words from code and/or mathematics that
are likely to be typos in other contexts (such as
uint)
- 'names' for valid proper names that might be typos
- 'en-GB_to_en-US' for corrections from en-GB to en-US
The default is 'clear,rare'.
--ignore-regex IGNORE_REGEX
regular expression that is used to find patterns to
ignore by treating as whitespace. When writing regular
expressions, consider ensuring there are boundary non-
word chars, e.g., "\bmatch\b". Defaults to
empty/disabled.
-I FILE, --ignore-words FILE
file that contains words that will be ignored by
codespell. File must contain 1 word per line. Words
are case sensitive based on how they are written in
the dictionary file
-L WORDS, --ignore-words-list WORDS
comma separated list of words to be ignored by
codespell. Words are case sensitive based on how they
are written in the dictionary file
--uri-ignore-words-list WORDS
comma separated list of words to be ignored by
codespell in URIs and emails only. Words are case
sensitive based on how they are written in the
dictionary file. If set to "*", all misspelling in
URIs and emails will be ignored.
-r REGEX, --regex REGEX
regular expression that is used to find words. By
default any alphanumeric character, the underscore,
the hyphen, and the apostrophe is used to build words.
This option cannot be specified together with --write-
changes.
--uri-regex URI_REGEX
regular expression that is used to find URIs and
emails. A default expression is provided.
-s, --summary print summary of fixes
--count print the number of errors as the last line of stderr
-S SKIP, --skip SKIP comma-separated list of files to skip. It accepts
globs as well. E.g.: if you want codespell to skip
.eps and .txt files, you'd give "*.eps,*.txt" to this
option.
-x FILE, --exclude-file FILE
ignore whole lines that match those in the file FILE.
The lines in FILE should match the to-be-excluded
lines exactly
-i INTERACTIVE, --interactive INTERACTIVE
set interactive mode when writing changes:
- 0: no interactivity.
- 1: ask for confirmation.
- 2: ask user to choose one fix when more than one is
available.
- 3: both 1 and 2
-q QUIET_LEVEL, --quiet-level QUIET_LEVEL
bitmask that allows suppressing messages:
- 0: print all messages.
- 1: disable warnings about wrong encoding.
- 2: disable warnings about binary files.
- 4: omit warnings about automatic fixes that were
disabled in the dictionary.
- 8: don't print anything for non-automatic fixes.
- 16: don't print the list of fixed files.
As usual with bitmasks, these levels can be combined;
e.g. use 3 for levels 1+2, 7 for 1+2+4, 23 for
1+2+4+16, etc. The default mask is 2.
-e, --hard-encoding-detection
use chardet to detect the encoding of each file. This
can slow down codespell, but is more reliable in
detecting encodings other than utf-8, iso8859-1, and
ascii.
-f, --check-filenames
check file names as well
-H, --check-hidden check hidden files and directories (those starting
with ".") as well.
-A LINES, --after-context LINES
print LINES of trailing context
-B LINES, --before-context LINES
print LINES of leading context
-C LINES, --context LINES
print LINES of surrounding context
--config CONFIG path to config file.