cspell-cli 8.4.0 → 8.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 +12 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@ This repository enables using [cspell](https://github.com/streetsidesoftware/csp
|
|
|
10
10
|
# .pre-commit-config.yaml
|
|
11
11
|
repos:
|
|
12
12
|
- repo: https://github.com/streetsidesoftware/cspell-cli
|
|
13
|
-
rev: v8.
|
|
13
|
+
rev: v8.6.0
|
|
14
14
|
hooks:
|
|
15
15
|
- id: cspell
|
|
16
16
|
```
|
|
@@ -65,6 +65,8 @@ npm install -g git+https://github.com/streetsidesoftware/cspell-cli
|
|
|
65
65
|
docker run -v $PWD:/workdir ghcr.io/streetsidesoftware/cspell:latest "**"
|
|
66
66
|
```
|
|
67
67
|
|
|
68
|
+
See [Extending the Docker Container to include German](https://github.com/streetsidesoftware/cspell-cli/tree/main/docker/german/README.md)
|
|
69
|
+
|
|
68
70
|
## Usage
|
|
69
71
|
|
|
70
72
|
`cspell --help`:
|
|
@@ -144,6 +146,8 @@ Options:
|
|
|
144
146
|
--file-list <path or stdin> Specify a list of files to be spell checked. The
|
|
145
147
|
list is filtered against the glob file patterns.
|
|
146
148
|
Note: the format is 1 file path per line.
|
|
149
|
+
--file [file...] Specify files to spell check. They are filtered
|
|
150
|
+
by the [globs...].
|
|
147
151
|
--no-issues Do not show the spelling errors.
|
|
148
152
|
--no-progress Turn off progress messages
|
|
149
153
|
--no-summary Turn off summary message in console.
|
|
@@ -196,6 +200,13 @@ More Examples:
|
|
|
196
200
|
cspell . --reporter ./<path>/reporter.cjs
|
|
197
201
|
Use a custom reporter. See API for details.
|
|
198
202
|
|
|
203
|
+
cspell "*.md" --exclude CHANGELOG.md --files README.md CHANGELOG.md
|
|
204
|
+
Spell check only check "README.md" but NOT "CHANGELOG.md".
|
|
205
|
+
|
|
206
|
+
cspell "/*.md" --no-must-find-files --files $FILES
|
|
207
|
+
Only spell check the "/*.md" files in $FILES,
|
|
208
|
+
where $FILES is a shell variable that contains the list of files.
|
|
209
|
+
|
|
199
210
|
References:
|
|
200
211
|
https://cspell.org
|
|
201
212
|
https://github.com/streetsidesoftware/cspell
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "cspell-cli",
|
|
3
|
-
"version": "8.
|
|
3
|
+
"version": "8.6.0",
|
|
4
4
|
"description": "CLI for cspell; A Spelling Checker for Code!",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"module": "index.js",
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
"node": ">=18"
|
|
44
44
|
},
|
|
45
45
|
"dependencies": {
|
|
46
|
-
"cspell": "^8.
|
|
46
|
+
"cspell": "^8.6.0"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
49
|
"inject-markdown": "^3.0.0",
|