# @kitschpatrol/cspell-config
[](https://npmjs.com/package/@kitschpatrol/cspell-config)
[](https://opensource.org/licenses/MIT)
**CSpell configuration for @kitschpatrol/shared-config.**
## 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).
> [!IMPORTANT]
>
> **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
## Setup
To use just this CSpell config in isolation:
1. Install the `.npmrc` in your project root. This is required for correct PNPM behavior:
```sh
pnpm dlx @kitschpatrol/repo-config init
```
2. Add the package:
```sh
pnpm add -D @kitschpatrol/cspell-config
```
3. Add the starter `.cspell.json` file to your project root, and add any customizations you'd like:
```sh
pnpm exec kpi-cspell init
```
## Usage
The CSpell binary should be picked up automatically by VS Code plugins.
You can call it directly, or use the script bundled with the config.
Integrate with your `package.json` scripts as you see fit, for example:
```json
{
"scripts": {
"spellcheck": "kpi-cspell lint"
}
}
```
### Configuration
To create a `cspell.config.js` in your project root:
```sh
pnpm exec kpi-knip init
```
(Note that this will delete the `cspell` property in your `package.json`!)
_Or_
To create a `cspell` property in `package.json`:
```sh
pnpm exec kpi-cspell init --location package
```
(Note that this will delete the `cspell.config.js` file in your project root!)
#### 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:
- [`lorem-ipsum`](https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/lorem-ipsum/dict/lorem.txt)
- [`git`](https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/git/cspell-ext.json)
- [`gaming-terms`](https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/gaming-terms/dict/gaming-terms.txt)
- [`npm`](https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/npm/dict/npm.txt)
- [`data-science`](https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/data-science/dict/data-science.txt)
- [`fullstack`](https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/fullstack/dict/fullstack.txt)
It also includes a number of _custom_ dictionaries distributed with this package, all of which are enabled by default:
- `kp-acronyms` Contains acronyms
- `kp-brands` Contains proper nouns like brand names
- `kp-eslint` Names seen in eslint rules provided by `@kitschpatrol/eslint-config`
- `kp-files` File extensions and types
- `kp-misc` Contains general and miscellaneous words
- `kp-names` Human names and usernames
- `kp-tech` Tech-specific terminology, some ambiguity vs. "brands"
In your project's root `.cspell.json`, you can disable any combination of these dictionaries by adding them to the `dictionaries` array with a `!` prefix.
For example, do disable the `kp-acronyms` and `kp-brands` dictionaries:
```jsonc
{
"import": "@kitschpatrol/cspell-config",
"dictionaries": [
"!kp-acronyms",
"!kp-brands",
// ...Addtional !-prefixed dicitonary names
],
}
```
If you need a massive and permissive dictionary for large writing project, take a look at [@kitschpatrol/dict-en-wiktionary](https://github.com/kitschpatrol/dict-en-wiktionary).
#### Adding project-scoped words
In your project's root `.cspell.json`:
```jsonc
{
"import": "@kitschpatrol/cspell-config",
"words": [
"mountweazel",
"steinlaus",
"jungftak",
"esquivalience",
// ...Additional words
],
}
```
### CLI
#### Command: `kpi-cspell`
Kitschpatrol's CSpell shared configuration tools. (Automated fixes are handled by ESLint.)
This section lists top-level commands for `kpi-cspell`.
Usage:
```txt
kpi-cspell
```
| Command | Argument | Description |
| -------------- | ----------- | ------------------------------------------------------------------------------------------------------------ |
| `init` | | Initialize by copying starter config files to your project root or to your package.json file. |
| `lint` | `[files..]` | Check for spelling mistakes. Matches files below the current working directory by default. |
| `print-config` | | Print the resolved CSpell configuration. Package-scoped. Searches up to the root of a monorepo if necessary. |
| Option | Description | Type |
| ------------------- | ------------------- | --------- |
| `--help`
`-h` | Show help | `boolean` |
| `--version`
`-v` | Show version number | `boolean` |
_See the sections below for more information on each subcommand._
#### Subcommand: `kpi-cspell init`
Initialize by copying starter config files to your project root or to your package.json file.
Usage:
```txt
kpi-cspell init
```
| Option | Description | Type | Default |
| ------------------- | ------------------- | -------------------- | -------- |
| `--location` | TK | `"file"` `"package"` | `"file"` |
| `--help`
`-h` | Show help | `boolean` | |
| `--version`
`-v` | Show version number | `boolean` | |
#### Subcommand: `kpi-cspell lint`
Check for spelling mistakes. Matches files below the current working directory by default.
Usage:
```txt
kpi-cspell lint [files..]
```
| Positional Argument | Description | Type | Default |
| ------------------- | ------------------------------ | ------- | -------- |
| `files` | Files or glob pattern to lint. | `array` | `"**/*"` |
| Option | Description | Type |
| ------------------- | ------------------- | --------- |
| `--help`
`-h` | Show help | `boolean` |
| `--version`
`-v` | Show version number | `boolean` |
#### Subcommand: `kpi-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
```
| Option | Description | Type |
| ------------------- | ------------------- | --------- |
| `--help`
`-h` | Show help | `boolean` |
| `--version`
`-v` | Show version number | `boolean` |
## Notes
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
[MIT](license.txt) © Eric Mika