cspell-cli 6.3.3 → 6.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +82 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -53,6 +53,88 @@ This repo also allows installing the `cspell-cli` directly from GitHub:
|
|
|
53
53
|
npm install -g git+https://github.com/streetsidesoftware/cspell-cli
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
+
## Docker
|
|
57
|
+
|
|
58
|
+
```sh
|
|
59
|
+
docker run -v $PWD:/workdir ghcr.io/streetsidesoftware/cspell:latest "**"
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Usage
|
|
63
|
+
|
|
64
|
+
```
|
|
65
|
+
Usage: cspell-cli lint [options] [globs...]
|
|
66
|
+
|
|
67
|
+
Check spelling
|
|
68
|
+
|
|
69
|
+
Options:
|
|
70
|
+
-c, --config <cspell.json> Configuration file to use. By default cspell
|
|
71
|
+
looks for cspell.json in the current directory.
|
|
72
|
+
|
|
73
|
+
-v, --verbose Display more information about the files being
|
|
74
|
+
checked and the configuration.
|
|
75
|
+
|
|
76
|
+
--locale <locale> Set language locales. i.e. "en,fr" for English
|
|
77
|
+
and French, or "en-GB" for British English.
|
|
78
|
+
|
|
79
|
+
--language-id <language> Force programming language for unknown
|
|
80
|
+
extensions. i.e. "php" or "scala"
|
|
81
|
+
|
|
82
|
+
--words-only Only output the words not found in the
|
|
83
|
+
dictionaries.
|
|
84
|
+
|
|
85
|
+
-u, --unique Only output the first instance of a word not
|
|
86
|
+
found in the dictionaries.
|
|
87
|
+
|
|
88
|
+
-e, --exclude <glob> Exclude files matching the glob pattern. This
|
|
89
|
+
option can be used multiple times to add
|
|
90
|
+
multiple globs.
|
|
91
|
+
|
|
92
|
+
--file-list <path or stdin> Specify a list of files to be spell checked. The
|
|
93
|
+
list is filtered against the glob file patterns.
|
|
94
|
+
Note: the format is 1 file path per line.
|
|
95
|
+
|
|
96
|
+
--no-issues Do not show the spelling errors.
|
|
97
|
+
--no-progress Turn off progress messages
|
|
98
|
+
--no-summary Turn off summary message in console.
|
|
99
|
+
-s, --silent Silent mode, suppress error messages.
|
|
100
|
+
--fail-fast Exit after first file with an issue or error.
|
|
101
|
+
-r, --root <root folder> Root directory, defaults to current directory.
|
|
102
|
+
--relative Issues are displayed relative to root.
|
|
103
|
+
--show-context Show the surrounding text around an issue.
|
|
104
|
+
--show-suggestions Show spelling suggestions.
|
|
105
|
+
--no-must-find-files Do not error if no files are found.
|
|
106
|
+
--cache Use cache to only check changed files.
|
|
107
|
+
--no-cache Do not use cache.
|
|
108
|
+
--cache-reset Reset the cache file.
|
|
109
|
+
--cache-strategy <strategy> Strategy to use for detecting changed files.
|
|
110
|
+
(choices: "metadata", "content")
|
|
111
|
+
--cache-location <path> Path to the cache file or directory. (default:
|
|
112
|
+
".cspellcache")
|
|
113
|
+
--dot Include files and directories starting with `.`
|
|
114
|
+
(period) when matching globs.
|
|
115
|
+
--gitignore Ignore files matching glob patterns found in
|
|
116
|
+
.gitignore files.
|
|
117
|
+
--no-gitignore Do NOT use .gitignore files.
|
|
118
|
+
--gitignore-root <path> Prevent searching for .gitignore files past
|
|
119
|
+
root.
|
|
120
|
+
--no-color Turn off color.
|
|
121
|
+
--color Force color.
|
|
122
|
+
--no-default-configuration Do not load the default configuration and
|
|
123
|
+
dictionaries.
|
|
124
|
+
--debug Output information useful for debugging
|
|
125
|
+
cspell.json files.
|
|
126
|
+
-h, --help display help for command
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
Examples:
|
|
130
|
+
cspell "*.js" Check all .js files in the current directory
|
|
131
|
+
cspell "**/*.js" Check all .js files from the current directory
|
|
132
|
+
cspell "src/**/*.js" Only check .js under src
|
|
133
|
+
cspell "**/*.txt" "**/*.js" Check both .js and .txt files.
|
|
134
|
+
cspell "**/*.{txt,js,md}" Check .txt, .js, and .md files.
|
|
135
|
+
cat LICENSE | cspell stdin Check stdin
|
|
136
|
+
```
|
|
137
|
+
|
|
56
138
|
## Versioning
|
|
57
139
|
|
|
58
140
|
The major version of `cspell-cli` tries to match the major version of `cspell`.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "cspell-cli",
|
|
3
|
-
"version": "6.
|
|
3
|
+
"version": "6.6.0",
|
|
4
4
|
"description": "CLI for cspell: A Spelling Checker for Code!",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"bin": {
|
|
@@ -34,6 +34,6 @@
|
|
|
34
34
|
"node": ">=14"
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"cspell": "^6.
|
|
37
|
+
"cspell": "^6.6.1"
|
|
38
38
|
}
|
|
39
39
|
}
|