@kitschpatrol/cspell-config

@kitschpatrol/cspell-config

CSpell configuration for @kitschpatrol/shared-config.

Overview

It's a shared CSpell config.

See @kitschpatrol/shared-config for the recommended single-package approach.

Setup

To use just this CSpell config in isolation:

1. Install the .npmrc in your project root. This is required for correct PNPM behavior:

   pnpm dlx @kitschpatrol/repo-config --init
   

2. Add the package:

   pnpm add -D @kitschpatrol/cspell-config
   

3. Add the starter .cspell.json file to your project root, and add any customizations you'd like:

   pnpm exec cspell-config --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:

"scripts": {
  "spellcheck": "cspell-config --check"
}

CLI

Command: cspell-config

CSpell configuration for @kitschpatrol/shared-config.

Usage:

cspell-config [<file|glob> ...]

Option	Alias	Argument	Description
--check	-c		Check for and report issues. Same as cspell-config.
--init	-i		Initialize by copying starter config files to your project root.
--print-config	-p	<path>	Print the effective configuration at a certain path.
--help	-h		Print this help info.
--version	-v		Print the package version.

Configuration

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
• git
• gaming-terms
• npm
• data-science
• fullstack

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-misc Contains general and miscellaneous words
• kp-tech Tech-specific terminology, some ambiguity vs. "brands"
• kp-names Human names and usernames

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:

{
  "import": "@kitschpatrol/cspell-config",
  "dictionaries": [
    "!kp-acronyms",
    "!kp-brands"
    // ...Addtional !-prefixed dicitonary names
  ]
}

Adding project-scoped words

In your project's root .cspell.json:

{
  "import": "@kitschpatrol/cspell-config",
  "words": [
    "mountweazel",
    "steinlaus",
    "jungftak",
    "esquivalience"
    // ...Additional words
  ]
}

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.

License

MIT © Eric Mika