CSpell Configuration of Erin

Installation

pnpm add -D @erin-living/cspell

Usage

In your cspell.json:

{
  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
  "version": "0.2",
  "import": ["@erin-living/cspell/config"]
}

Override Configurations

Add your custom settings in your project's cspell.json. These will override the base configuration:

{
  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
  "version": "0.2",
  "import": ["@erin-living/cspell/config"],
  // Override existing settings
  "words": [
    "yourterm",
    "customword"
  ],
  "ignorePaths": [
    "custom-folder",
    "*.generated.ts"
  ],
  "dictionaries": [
    "typescript",
    "your-custom-dictionary"
  ],
  "patterns": [
    {
      "name": "custom_pattern",
      "pattern": "/your-pattern/g"
    }
  ]
}

Features

• Pre-configured dictionaries for TypeScript, Node.js, and web development
• Common technical terms whitelist
• Ignore patterns for build artifacts and dependencies
• File-specific dictionary configurations
• Support for code blocks in markdown
• Git-aware configuration