@canideploy/cspell-config

This package contains dictionaries for the cspell spell checker.

Dictionaries

| Name | Description | | --------------------- | ----------------------------------------------- | | acronyms.txt | Acronyms | | common-filenames.txt | Common filenames | | identifiers.txt | Any identifier, such as a variable or parameter | | packages.txt | NPM package names | | people.txt | People's names | | places.txt | Any place, such as a city, state, or country | | programming-terms.txt | Programming terms | | things.txt | Other things that might not fit elsewhere | | usernames.txt | Usernames |

Installation

pnpm add @canideploy/cspell-config -D

Usage

Create a cspell.json file at the root of your project with the following content:

{
  "version": "0.2",
  "import": ["@canideploy/cspell-config"],
  "words": [],
  "ignorePaths": []
}

Add a spellcheck script to your package.json:

{
  "scripts": {
    "spellcheck": "cspell --no-progress \"./{.github,packages}/**/*.{md,js,mjs,cjs,ts,mts,cts,tsx,json,yml}\" \"./*.{md,js,mjs,cjs,ts,mts,cts,tsx,json}\""
  }
}

Run spellcheck in your as part of your lint-staged configuration:

export default {
  '*.{js,cjs,mjs,ts,cts,mts,json,yml,yaml,md}': ['cspell lint --no-progress --no-summary --no-must-find-files'],
  '*': (files) => [
    // Spell check file names
    `sh -c 'echo "${files.join('\n')}" | cspell --show-context stdin'`,
  ],
};