@kitschpatrol/cspell-config 5.6.0 → 5.7.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/bin/cli.js +2 -2
- package/dictionaries/kp-brands.txt +2 -0
- package/dictionaries/kp-eslint.txt +2 -0
- package/dictionaries/kp-misc.txt +2 -0
- package/dictionaries/kp-names.txt +4 -2
- package/dictionaries/kp-tech.txt +8 -1
- package/package.json +5 -4
- package/readme.md +15 -15
package/bin/cli.js
CHANGED
|
@@ -5138,7 +5138,7 @@ var Yargs = YargsFactory(esm_default);
|
|
|
5138
5138
|
var yargs_default = Yargs;
|
|
5139
5139
|
|
|
5140
5140
|
// ../../package.json
|
|
5141
|
-
var version = "5.
|
|
5141
|
+
var version = "5.7.0";
|
|
5142
5142
|
|
|
5143
5143
|
// ../../src/execa-utilities.ts
|
|
5144
5144
|
function isErrorExecaError(error) {
|
|
@@ -5948,7 +5948,7 @@ var commandDefinition = {
|
|
|
5948
5948
|
description: "Kitschpatrol's CSpell shared configuration tools. (Automated fixes are handled by ESLint.)",
|
|
5949
5949
|
logColor: "cyan",
|
|
5950
5950
|
logPrefix: "[CSpell]",
|
|
5951
|
-
name: "
|
|
5951
|
+
name: "ksc-cspell",
|
|
5952
5952
|
order: 6
|
|
5953
5953
|
};
|
|
5954
5954
|
|
package/dictionaries/kp-misc.txt
CHANGED
|
@@ -189,6 +189,7 @@ Bubuck
|
|
|
189
189
|
Buckminster
|
|
190
190
|
Budd
|
|
191
191
|
Buffett
|
|
192
|
+
bullrich
|
|
192
193
|
Burges
|
|
193
194
|
Burgund
|
|
194
195
|
Burndy
|
|
@@ -578,6 +579,7 @@ Hultén
|
|
|
578
579
|
Husain
|
|
579
580
|
Husted
|
|
580
581
|
Hyman
|
|
582
|
+
hyperse
|
|
581
583
|
Iberti
|
|
582
584
|
Ichiran
|
|
583
585
|
Idah
|
|
@@ -743,7 +745,9 @@ Kutnow
|
|
|
743
745
|
Kuzmin
|
|
744
746
|
Kykuit
|
|
745
747
|
Kyoko
|
|
748
|
+
L’Óreal
|
|
746
749
|
L'Rai
|
|
750
|
+
L’Rai
|
|
747
751
|
Laidlaw
|
|
748
752
|
Laika
|
|
749
753
|
Lalo
|
|
@@ -803,10 +807,8 @@ Löffler
|
|
|
803
807
|
Lohman
|
|
804
808
|
Loic
|
|
805
809
|
Loong
|
|
806
|
-
L’Óreal
|
|
807
810
|
Lovejoy
|
|
808
811
|
Lrai
|
|
809
|
-
L’Rai
|
|
810
812
|
Ludion
|
|
811
813
|
Luiz
|
|
812
814
|
Lupton
|
package/dictionaries/kp-tech.txt
CHANGED
|
@@ -66,6 +66,7 @@ cameraring
|
|
|
66
66
|
camerawheel
|
|
67
67
|
capsizecss
|
|
68
68
|
certbot
|
|
69
|
+
charuco
|
|
69
70
|
checkjs
|
|
70
71
|
cherrypy
|
|
71
72
|
chezmoi
|
|
@@ -80,6 +81,7 @@ codebooga
|
|
|
80
81
|
codellama
|
|
81
82
|
codesigning
|
|
82
83
|
Codespaces
|
|
84
|
+
codespell
|
|
83
85
|
codsen
|
|
84
86
|
Colibri
|
|
85
87
|
Collab
|
|
@@ -228,6 +230,7 @@ introstart
|
|
|
228
230
|
InvisBox
|
|
229
231
|
iosveka
|
|
230
232
|
ipynb
|
|
233
|
+
itson
|
|
231
234
|
jetblack
|
|
232
235
|
jpgs
|
|
233
236
|
jphc
|
|
@@ -245,9 +248,10 @@ keyof
|
|
|
245
248
|
Kinect
|
|
246
249
|
kinects
|
|
247
250
|
kiota
|
|
248
|
-
kpi
|
|
249
251
|
kputil
|
|
252
|
+
ksc
|
|
250
253
|
ksdiff
|
|
254
|
+
labelot
|
|
251
255
|
lanczos
|
|
252
256
|
langchain
|
|
253
257
|
latlon
|
|
@@ -399,6 +403,7 @@ openstreetmap
|
|
|
399
403
|
optionator
|
|
400
404
|
osascript
|
|
401
405
|
oscreplayer
|
|
406
|
+
osxkeychain
|
|
402
407
|
osxphotos
|
|
403
408
|
outfile
|
|
404
409
|
outro
|
|
@@ -442,6 +447,7 @@ playsinline
|
|
|
442
447
|
pngs
|
|
443
448
|
pointerupoutside
|
|
444
449
|
Polycode
|
|
450
|
+
poptab
|
|
445
451
|
poscene
|
|
446
452
|
positionals
|
|
447
453
|
Preact
|
|
@@ -512,6 +518,7 @@ smartmontools
|
|
|
512
518
|
smupgd
|
|
513
519
|
Snipster
|
|
514
520
|
softphone
|
|
521
|
+
softprops
|
|
515
522
|
speex
|
|
516
523
|
squoosh
|
|
517
524
|
srgb
|
package/package.json
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kitschpatrol/cspell-config",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.7.0",
|
|
4
4
|
"description": "CSpell configuration for @kitschpatrol/shared-config.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"shared-config",
|
|
7
7
|
"cspell-config",
|
|
8
8
|
"cspell",
|
|
9
9
|
"cli",
|
|
10
|
-
"
|
|
11
|
-
"
|
|
10
|
+
"ksc",
|
|
11
|
+
"ksc-cspell"
|
|
12
12
|
],
|
|
13
13
|
"homepage": "https://github.com/kitschpatrol/shared-config/tree/main/packages/cspell-config",
|
|
14
14
|
"bugs": "https://github.com/kitschpatrol/shared-config/issues",
|
|
@@ -33,7 +33,8 @@
|
|
|
33
33
|
"main": "dist/index.js",
|
|
34
34
|
"types": "dist/index.d.ts",
|
|
35
35
|
"bin": {
|
|
36
|
-
"kpi-cspell": "bin/cli.js"
|
|
36
|
+
"kpi-cspell": "bin/cli.js",
|
|
37
|
+
"ksc-cspell": "bin/cli.js"
|
|
37
38
|
},
|
|
38
39
|
"files": [
|
|
39
40
|
"bin/*",
|
package/readme.md
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
## Overview
|
|
23
23
|
|
|
24
|
-
It's a shared [CSpell](https://cspell.org) config, plus a command-line tool `
|
|
24
|
+
It's a shared [CSpell](https://cspell.org) config, plus a command-line tool `ksc-cspell` to perform CSpell-related project initialization and linting. Note that automated fixes are handled via an ESLint integration provided in [@kitschpatrol/eslint-config](https://github.com/kitschpatrol/shared-config/tree/main/packages/eslint-config).
|
|
25
25
|
|
|
26
26
|
<!-- recommendation -->
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@ It's a shared [CSpell](https://cspell.org) config, plus a command-line tool `kpi
|
|
|
29
29
|
>
|
|
30
30
|
> **You can use this package on its own, but it's recommended to use [`@kitschpatrol/shared-config`](https://www.npmjs.com/package/@kitschpatrol/shared-config) instead for a single-dependency and single-package approach to linting and fixing your project.**
|
|
31
31
|
>
|
|
32
|
-
> This package is included as a dependency in [`@kitschpatrol/shared-config`](https://www.npmjs.com/package/@kitschpatrol/shared-config), which also automatically invokes the command line functionality in this package via its `
|
|
32
|
+
> This package is included as a dependency in [`@kitschpatrol/shared-config`](https://www.npmjs.com/package/@kitschpatrol/shared-config), which also automatically invokes the command line functionality in this package via its `ksc` command
|
|
33
33
|
|
|
34
34
|
<!-- /recommendation -->
|
|
35
35
|
|
|
@@ -52,7 +52,7 @@ To use just this CSpell config in isolation:
|
|
|
52
52
|
3. Add the starter `.cspell.json` file to your project root, and add any customizations you'd like:
|
|
53
53
|
|
|
54
54
|
```sh
|
|
55
|
-
pnpm exec
|
|
55
|
+
pnpm exec ksc-cspell init
|
|
56
56
|
```
|
|
57
57
|
|
|
58
58
|
## Usage
|
|
@@ -66,7 +66,7 @@ Integrate with your `package.json` scripts as you see fit, for example:
|
|
|
66
66
|
```json
|
|
67
67
|
{
|
|
68
68
|
"scripts": {
|
|
69
|
-
"spellcheck": "
|
|
69
|
+
"spellcheck": "ksc-cspell lint"
|
|
70
70
|
}
|
|
71
71
|
}
|
|
72
72
|
```
|
|
@@ -76,7 +76,7 @@ Integrate with your `package.json` scripts as you see fit, for example:
|
|
|
76
76
|
To create a `cspell.config.js` in your project root:
|
|
77
77
|
|
|
78
78
|
```sh
|
|
79
|
-
pnpm exec
|
|
79
|
+
pnpm exec ksc-knip init
|
|
80
80
|
```
|
|
81
81
|
|
|
82
82
|
(Note that this will delete the `cspell` property in your `package.json`!)
|
|
@@ -86,7 +86,7 @@ _Or_
|
|
|
86
86
|
To create a `cspell` property in `package.json`:
|
|
87
87
|
|
|
88
88
|
```sh
|
|
89
|
-
pnpm exec
|
|
89
|
+
pnpm exec ksc-cspell init --location package
|
|
90
90
|
```
|
|
91
91
|
|
|
92
92
|
(Note that this will delete the `cspell.config.js` file in your project root!)
|
|
@@ -150,16 +150,16 @@ In your project's root `.cspell.json`:
|
|
|
150
150
|
|
|
151
151
|
<!-- cli-help -->
|
|
152
152
|
|
|
153
|
-
#### Command: `
|
|
153
|
+
#### Command: `ksc-cspell`
|
|
154
154
|
|
|
155
155
|
Kitschpatrol's CSpell shared configuration tools. (Automated fixes are handled by ESLint.)
|
|
156
156
|
|
|
157
|
-
This section lists top-level commands for `
|
|
157
|
+
This section lists top-level commands for `ksc-cspell`.
|
|
158
158
|
|
|
159
159
|
Usage:
|
|
160
160
|
|
|
161
161
|
```txt
|
|
162
|
-
|
|
162
|
+
ksc-cspell <command>
|
|
163
163
|
```
|
|
164
164
|
|
|
165
165
|
| Command | Argument | Description |
|
|
@@ -175,14 +175,14 @@ kpi-cspell <command>
|
|
|
175
175
|
|
|
176
176
|
_See the sections below for more information on each subcommand._
|
|
177
177
|
|
|
178
|
-
#### Subcommand: `
|
|
178
|
+
#### Subcommand: `ksc-cspell init`
|
|
179
179
|
|
|
180
180
|
Initialize by copying starter config files to your project root or to your package.json file.
|
|
181
181
|
|
|
182
182
|
Usage:
|
|
183
183
|
|
|
184
184
|
```txt
|
|
185
|
-
|
|
185
|
+
ksc-cspell init
|
|
186
186
|
```
|
|
187
187
|
|
|
188
188
|
| Option | Description | Type | Default |
|
|
@@ -191,14 +191,14 @@ kpi-cspell init
|
|
|
191
191
|
| `--help`<br>`-h` | Show help | `boolean` | |
|
|
192
192
|
| `--version`<br>`-v` | Show version number | `boolean` | |
|
|
193
193
|
|
|
194
|
-
#### Subcommand: `
|
|
194
|
+
#### Subcommand: `ksc-cspell lint`
|
|
195
195
|
|
|
196
196
|
Check for spelling mistakes. Matches files below the current working directory by default.
|
|
197
197
|
|
|
198
198
|
Usage:
|
|
199
199
|
|
|
200
200
|
```txt
|
|
201
|
-
|
|
201
|
+
ksc-cspell lint [files..]
|
|
202
202
|
```
|
|
203
203
|
|
|
204
204
|
| Positional Argument | Description | Type | Default |
|
|
@@ -210,14 +210,14 @@ kpi-cspell lint [files..]
|
|
|
210
210
|
| `--help`<br>`-h` | Show help | `boolean` |
|
|
211
211
|
| `--version`<br>`-v` | Show version number | `boolean` |
|
|
212
212
|
|
|
213
|
-
#### Subcommand: `
|
|
213
|
+
#### Subcommand: `ksc-cspell print-config`
|
|
214
214
|
|
|
215
215
|
Print the resolved CSpell configuration. Package-scoped. Searches up to the root of a monorepo if necessary.
|
|
216
216
|
|
|
217
217
|
Usage:
|
|
218
218
|
|
|
219
219
|
```txt
|
|
220
|
-
|
|
220
|
+
ksc-cspell print-config
|
|
221
221
|
```
|
|
222
222
|
|
|
223
223
|
| Option | Description | Type |
|