cspell

What is cspell?

cspell is a spell checker for code that helps developers identify and correct spelling errors in their codebase, comments, strings, and documentation. It is highly configurable and can be integrated into various development workflows.

What are cspell's main functionalities?

Basic Spell Checking

This command runs cspell to check for spelling errors in all TypeScript files within the 'src' directory and its subdirectories.

npx cspell 'src/**/*.ts'

Custom Dictionaries

You can add custom dictionaries to cspell by specifying them in the configuration file. This allows you to include domain-specific terms that are not in the default dictionary.

{
  "dictionaries": ["custom-words"]
}

Ignoring Files and Patterns

cspell allows you to ignore specific files or patterns by adding them to the 'ignorePaths' array in the configuration file. This is useful for excluding generated files or dependencies.

{
  "ignorePaths": ["node_modules/**", "dist/**"]
}

Configurable Language Settings

You can configure the language and locale settings in cspell to match the language used in your codebase. This ensures that the spell checker uses the correct dictionary and rules.

{
  "language": "en",
  "local": "en-US"
}

Integration with Code Editors

cspell can be integrated with popular code editors like VSCode. By enabling the cspell extension, you can get real-time spell checking as you write code.

/* Example for VSCode */
{
  "cSpell.enabled": true
}

Other packages similar to cspell

eslint-plugin-spellcheck

eslint-plugin-spellcheck is an ESLint plugin that checks for spelling errors in comments and string literals. It is less comprehensive than cspell but integrates directly with ESLint, making it a good choice for projects already using ESLint.

spellchecker

spellchecker is a simple spell checking library that can be used in Node.js applications. It provides basic spell checking functionality but lacks the extensive configuration options and integrations that cspell offers.

hunspell-spellchecker

hunspell-spellchecker is a Node.js wrapper for the Hunspell spell checker. It provides powerful spell checking capabilities but requires more setup and configuration compared to cspell.

README

cspell

A Spell Checker for Code!

cSpell is a spelling checker designed for checking code. It was initially built as a spell checker extension for Visual Studio Code.

Installation

npm install -g cspell

Usage

Example: recursively spell check all javascript files in src

cspell "src/**/*.js"

Help

cspell --help