CSpell
The CSpell mono-repo, a spell checker for code.
Support Future Development
- Become a Patreon!
- Support through
- Open Collective
Documentation
Packages
- cspell -- cspell command-line application
- @cspell/eslint-plugin -- CSpell ESLint Plugin
- 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 includingcspell
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 thecspell
command.
RFCs
Link | Description | Status |
---|---|---|
rfc-0001 | Fixing common misspellings | Not started |
rfc-0002 | Improving Generated Suggestions | Done |
rfc-0003 | Plug-ins: Adding file parsers | In Progress |
rfc-0004 | Support Marking Issues as Known | Not started |
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.
Security contact information
To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.
Versions
version | Node | Status | Maintenance | End of Free Support | |
---|---|---|---|---|---|
cspell | 7.x | 16.x | In Active Development | TBD | TBD |
cspell | 6.x | 14.14.x | Transitioning to Maintenance | 2023-04-01 | 2023-05-01 |
cspell | 5.x | 12.x | Paid support only1 | - | 2022-10-01 |
cspell | 4.x | 10.x | Paid support only1 | - | 2022-05-01 |
Brought to you by Street Side Software