README.md

cspell

The cspell mono-repo, a spell checker for code.

Support Future Development

• Become a Patreon!
• Support through

Documentation

Documentation - CSpell

Packages

• cspell -- cspell command-line application
• cspell-bundled-dicts -- collection of dictionaries bundled with cspell.
• cspell-glob -- glob library.
• cspell-io -- i/o library.
• cspell-lib -- cspell library used for code driven spelling checking (used by the application).
• cspell-types -- cspell types and JSON schema for cspell configuration files.
• cspell-tools -- tool used to compile dictionaries.
• cspell-trie-lib -- trie data structure used to store words.
• cspell-trie -- trie data tool used to store words.
• hunspell-reader -- reads Hunspell files and outputs words.

Related Packages

• cspell-cli -- cspell-cli is useful for including cspell directly from GitHub.

  Example install: npm install -g git+https://github.com/streetsidesoftware/cspell-cli.

  This will add the cspell-cli command, which is an alias of the cspell command.

CSpell for enterprise

Available as part of the Tidelift Subscription.

The maintainers of CSpell and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. Learn more.