@kitschpatrol/cspell-config 5.6.0 → 5.7.1

package/bin/cli.js

@@ -5138,7 +5138,7 @@ var Yargs = YargsFactory(esm_default);
 var yargs_default = Yargs;
 
 // ../../package.json
-var version = "5.6.0";
+var version = "5.7.1";
 
 // ../../src/execa-utilities.ts
 function isErrorExecaError(error) {
@@ -5948,7 +5948,7 @@ var commandDefinition = {
   description: "Kitschpatrol's CSpell shared configuration tools. (Automated fixes are handled by ESLint.)",
   logColor: "cyan",
   logPrefix: "[CSpell]",
-  name: "kpi-cspell",
+  name: "ksc-cspell",
   order: 6
 };
 

package/dictionaries/kp-brands.txt

@@ -76,6 +76,7 @@ Cortina
 Cosm
 côte
 côte&ciel
+Crestron
 Cydwoq
 Daiso
 Danspace
@@ -268,6 +269,7 @@ Sephora
 Shippo
 Shopt
 Siig
+Smartsheet
 Smartwool
 Somaxis
 Sonicare

package/dictionaries/kp-eslint.txt

@@ -3,6 +3,7 @@ allman
 biblioref
 canonicalurl
 chunkname
+codespell
 curlies
 displaynames
 esmodule
@@ -21,6 +22,7 @@ helpes
 innerhtml
 iswellformed
 jsxdev
+lintroll
 lookarounds
 matchall
 maxsafeinteger

package/dictionaries/kp-misc.txt

@@ -58,6 +58,7 @@ checkin
 cheesery
 choco
 clicky
+clozed
 comparables
 confit
 connectome
@@ -139,6 +140,7 @@ jouissance
 Kabelwerk
 kanban
 katsu
+keytar
 kludgey
 kombucha
 kunst

package/dictionaries/kp-names.txt

@@ -189,6 +189,7 @@ Bubuck
 Buckminster
 Budd
 Buffett
+bullrich
 Burges
 Burgund
 Burndy
@@ -578,6 +579,7 @@ Hultén
 Husain
 Husted
 Hyman
+hyperse
 Iberti
 Ichiran
 Idah
@@ -743,7 +745,9 @@ Kutnow
 Kuzmin
 Kykuit
 Kyoko
+L’Óreal
 L'Rai
+L’Rai
 Laidlaw
 Laika
 Lalo
@@ -803,10 +807,8 @@ Löffler
 Lohman
 Loic
 Loong
-L’Óreal
 Lovejoy
 Lrai
-L’Rai
 Ludion
 Luiz
 Lupton

package/dictionaries/kp-tech.txt

@@ -66,6 +66,7 @@ cameraring
 camerawheel
 capsizecss
 certbot
+charuco
 checkjs
 cherrypy
 chezmoi
@@ -80,6 +81,7 @@ codebooga
 codellama
 codesigning
 Codespaces
+codespell
 codsen
 Colibri
 Collab
@@ -228,6 +230,7 @@ introstart
 InvisBox
 iosveka
 ipynb
+itson
 jetblack
 jpgs
 jphc
@@ -245,9 +248,10 @@ keyof
 Kinect
 kinects
 kiota
-kpi
 kputil
+ksc
 ksdiff
+labelot
 lanczos
 langchain
 latlon
@@ -399,6 +403,7 @@ openstreetmap
 optionator
 osascript
 oscreplayer
+osxkeychain
 osxphotos
 outfile
 outro
@@ -442,6 +447,7 @@ playsinline
 pngs
 pointerupoutside
 Polycode
+poptab
 poscene
 positionals
 Preact
@@ -512,6 +518,7 @@ smartmontools
 smupgd
 Snipster
 softphone
+softprops
 speex
 squoosh
 srgb

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@kitschpatrol/cspell-config",
-  "version": "5.6.0",
+  "version": "5.7.1",
   "description": "CSpell configuration for @kitschpatrol/shared-config.",
   "keywords": [
     "shared-config",
     "cspell-config",
     "cspell",
     "cli",
-    "kpi",
-    "kpi-cspell"
+    "ksc",
+    "ksc-cspell"
   ],
   "homepage": "https://github.com/kitschpatrol/shared-config/tree/main/packages/cspell-config",
   "bugs": "https://github.com/kitschpatrol/shared-config/issues",
@@ -33,7 +33,8 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {
-    "kpi-cspell": "bin/cli.js"
+    "kpi-cspell": "bin/cli.js",
+    "ksc-cspell": "bin/cli.js"
   },
   "files": [
     "bin/*",
@@ -51,12 +52,12 @@
     "cspell-lib": "^9.2.1",
     "execa": "^9.6.0",
     "find-workspaces": "^0.3.1",
-    "fs-extra": "^11.3.1",
+    "fs-extra": "^11.3.2",
     "prettier": "^3.6.2"
   },
   "devDependencies": {
-    "globby": "^14.1.0",
-    "untildify": "^5.0.0"
+    "globby": "^15.0.0",
+    "untildify": "^6.0.0"
   },
   "engines": {
     "node": ">=20.19.0"

package/readme.md

@@ -21,7 +21,11 @@
 
 ## Overview
 
-It's a shared [CSpell](https://cspell.org) config, plus a command-line tool `kpi-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).
+It's a shared [CSpell](https://cspell.org) config, plus a command-line tool `ksc-cspell` to perform CSpell-related project initialization and linting.
+
+In addition to basic CSpell functionality, this package bundles a few extra features: It identifies "unused" words in your local CSpell configuration's ignore list that don't actually appear anywhere in your project, and it incorporates [Case Police](https://github.com/antfu/case-police) to enforce case consistency.
+
+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).
 
 <!-- recommendation -->
 
@@ -29,7 +33,7 @@ It's a shared [CSpell](https://cspell.org) config, plus a command-line tool `kpi
 >
 > **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.**
 >
-> 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 `kpi` command
+> 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
 
 <!-- /recommendation -->
 
@@ -52,7 +56,7 @@ To use just this CSpell config in isolation:
 3. Add the starter `.cspell.json` file to your project root, and add any customizations you'd like:
 
    ```sh
-   pnpm exec kpi-cspell init
+   pnpm exec ksc-cspell init
    ```
 
 ## Usage
@@ -66,7 +70,7 @@ Integrate with your `package.json` scripts as you see fit, for example:
 ```json
 {
   "scripts": {
-    "spellcheck": "kpi-cspell lint"
+    "spellcheck": "ksc-cspell lint"
   }
 }
 ```
@@ -76,7 +80,7 @@ Integrate with your `package.json` scripts as you see fit, for example:
 To create a `cspell.config.js` in your project root:
 
 ```sh
-pnpm exec kpi-knip init
+pnpm exec ksc-knip init
 ```
 
 (Note that this will delete the `cspell` property in your `package.json`!)
@@ -86,11 +90,45 @@ _Or_
 To create a `cspell` property in `package.json`:
 
 ```sh
-pnpm exec kpi-cspell init --location package
+pnpm exec ksc-cspell init --location package
 ```
 
 (Note that this will delete the `cspell.config.js` file in your project root!)
 
+#### Ignoring files
+
+CSpell is configured to automatically ignore files and paths in `.gitignore` (via `"useGitignore": true`), and to ignore words inside of ` ``` ` code fences in Markdown and MDX files.
+
+Additional ignore patterns may be added to your project's CSpell config via the `ignorePaths` key.
+
+Ignored files are automatically excluded from Case Police checks as well.
+
+To exclude a specific file from Case Police checks, but to still check it with CSpell, include a comment:
+
+`// @case-police-disable`
+
+#### Ignoring specific words
+
+Many words are included in the bundled dictionaries used by the shared configuration.
+
+Additional words may be added to your project's CSpell config via the `words` key.
+
+Specific words may be ignored on a per-file basis by including a comment:
+
+`/* spell-checker: ignore $WORD, $ANOTHER_WORD, $YET_ANOTHER_WORD*/`
+
+Likewise to ignore certain Case Police words:
+
+`// @case-police-ignore $WORD, $ANOTHER_WORD, $YET_ANOTHER_WORD`
+
+#### Ignoring code
+
+See [the CSpell documentation](https://cspell.org/docs/Configuration/document-settings).
+
+Blocks:
+
+`/* spell-checker:disable */ ...  /* spell-checker:enable */`
+
 #### Disabling bundled dictionaries
 
 In additional to CSpell's default dictionary configuration, this shared configuration enables a number of dictionaries that ship with CSpell for all file types:
@@ -150,16 +188,16 @@ In your project's root `.cspell.json`:
 
 <!-- cli-help -->
 
-#### Command: `kpi-cspell`
+#### Command: `ksc-cspell`
 
 Kitschpatrol's CSpell shared configuration tools. (Automated fixes are handled by ESLint.)
 
-This section lists top-level commands for `kpi-cspell`.
+This section lists top-level commands for `ksc-cspell`.
 
 Usage:
 
 ```txt
-kpi-cspell <command>
+ksc-cspell <command>
 ```
 
 | Command        | Argument    | Description                                                                                                  |
@@ -175,14 +213,14 @@ kpi-cspell <command>
 
 _See the sections below for more information on each subcommand._
 
-#### Subcommand: `kpi-cspell init`
+#### Subcommand: `ksc-cspell init`
 
 Initialize by copying starter config files to your project root or to your package.json file.
 
 Usage:
 
 ```txt
-kpi-cspell init
+ksc-cspell init
 ```
 
 | Option              | Description         | Type                 | Default  |
@@ -191,14 +229,14 @@ kpi-cspell init
 | `--help`<br>`-h`    | Show help           | `boolean`            |          |
 | `--version`<br>`-v` | Show version number | `boolean`            |          |
 
-#### Subcommand: `kpi-cspell lint`
+#### Subcommand: `ksc-cspell lint`
 
 Check for spelling mistakes. Matches files below the current working directory by default.
 
 Usage:
 
 ```txt
-kpi-cspell lint [files..]
+ksc-cspell lint [files..]
 ```
 
 | Positional Argument | Description                    | Type    | Default  |
@@ -210,14 +248,14 @@ kpi-cspell lint [files..]
 | `--help`<br>`-h`    | Show help           | `boolean` |
 | `--version`<br>`-v` | Show version number | `boolean` |
 
-#### Subcommand: `kpi-cspell print-config`
+#### Subcommand: `ksc-cspell print-config`
 
 Print the resolved CSpell configuration. Package-scoped. Searches up to the root of a monorepo if necessary.
 
 Usage:
 
 ```txt
-kpi-cspell print-config
+ksc-cspell print-config
 ```
 
 | Option              | Description         | Type      |
@@ -231,8 +269,6 @@ kpi-cspell print-config
 
 This config includes a bunch of words I've happened to have needed to use. Your preferences will vary.
 
-CSpell is configured to automatically ignore files and paths in `.gitignore` (via `"useGitignore": true`), and to ignore words inside of ` ``` ` code fences in markdown and mdx files.
-
 As part of the `lint` command process, `@kitschpatrol/cspell-config` also runs a check to identify any words in your config file's `"words"` array that are _do not_ actually appear anywhere else in your project. This was inspired by [Zamiell's](https://github.com/Zamiell) [cspell-check-unused-words](https://github.com/complete-ts/cspell-check-unused-words) project.
 
 <!-- license -->