@envsa/cspell-config

@envsa/cspell-config

CSpell configuration for @envsa/shared-config.

Overview

It's a shared CSpell config.

See @envsa/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 @envsa/repo-config --init
   

2. Add the package:

   pnpm add -D @envsa/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 @envsa/shared-config.

Usage:

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

Option	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:

• envsa-acronyms Contains acronyms
• envsa-files File extensions and types
• envsa-misc Contains general and miscellaneous words
• envsa-names Human names and usernames
• envsa-tech Tech-specific terminology

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 envsa-acronyms and envsa-names dictionaries:

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

Adding project-scoped words

In your project's root .cspell.json:

{
  "import": "@envsa/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.

Credits

Eric Mika is the author of the original @kitschpatrol/shared-config project on which this is based.

License

MIT © Liam Rella