Awesome
CSpell
The CSpell mono-repo, a spell checker for code.
Support Future Development
<!--- @@inject: static/sponsor.md --->
Documentation
Third-Party Video Presentations
Some videos related to CSpell and the Code Spell Checker for VS Code.
- Spell Checking Documentation in DevOps Pipelines by Houssem Dellai
- Don't Worry About Spelling...VS Code Can Do It For You!! by James Q Quick
- Spell Checking In VSCode - VSCode Pro Tips
- Spell Check in VS Code with Code Spell Checker - Extension Highlight
- Spell check your code from the command line with Cspell
- How to Use VS Code Spell Checker - Detailed walkthrough to setup and use multiple languages
- Code Spell Checker Extension for Visual Studio Code
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-cliis useful for includingcspelldirectly from GitHub.Example install:
npm install -g git+https://github.com/streetsidesoftware/cspell-cli.This will add the
cspell-clicommand, which is an alias of thecspellcommand.
Live Discussions
Join us on:
<img src="./assets/images/zulip-icon-circle.svg" width="32">
RFCs
| Link | Description | Status |
|---|---|---|
| rfc-0001 | Fixing common misspellings | Done |
| 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 email security@streetsidesoftware.com or use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.
Versions
| version | Node | Status | Maintenance | End of Free Support | |
|---|---|---|---|---|---|
| cspell | 8.x | 18.x | In Active Development | TBD | TBD |
| cspell | 7.x | 16.x | Maintenance | 2023-10-01 | 2023-11-07 |
| cspell | 6.x | 14.14.x | Paid support only1 | 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 |
Contributing
Contributions are welcome! See our contribution notes. Note: To add or remove words in a dictionary, visit cspell-dicts.
🙏 Special thanks to all of our amazing contributors! 🥰
<!--- @@inject: static/contributors.md ---> <!--- cspell:disable ---><img alt="Contributor Jason3S" src="https://avatars.githubusercontent.com/u/3740137?v=4&size=128" width=64> <img alt="Contributor street-side-software-automation[bot]" src="https://avatars.githubusercontent.com/u/50543896?v=4&size=128" width=64> <img alt="Contributor dependabot[bot]" src="https://avatars.githubusercontent.com/in/29110?v=4&size=128" width=64> <img alt="Contributor nschonni" src="https://avatars.githubusercontent.com/u/1297909?v=4&size=128" width=64> <img alt="Contributor Jason-Rev" src="https://avatars.githubusercontent.com/u/4850573?v=4&size=128" width=64> <img alt="Contributor amanoji" src="https://avatars.githubusercontent.com/u/17751138?v=4&size=128" width=64> <img alt="Contributor jrylan" src="https://avatars.githubusercontent.com/u/178806156?v=4&size=128" width=64> <img alt="Contributor mad-gooze" src="https://avatars.githubusercontent.com/u/1188779?v=4&size=128" width=64> <img alt="Contributor snyk-bot" src="https://avatars.githubusercontent.com/u/19733683?v=4&size=128" width=64> <img alt="Contributor zo" src="https://avatars.githubusercontent.com/u/518711?v=4&size=128" width=64> <img alt="Contributor dsanders11" src="https://avatars.githubusercontent.com/u/5820654?v=4&size=128" width=64> <img alt="Contributor coliff" src="https://avatars.githubusercontent.com/u/1212885?v=4&size=128" width=64> <img alt="Contributor github-actions[bot]" src="https://avatars.githubusercontent.com/in/15368?v=4&size=128" width=64> <img alt="Contributor dakotaJang" src="https://avatars.githubusercontent.com/u/22528264?v=4&size=128" width=64> <img alt="Contributor bisubus" src="https://avatars.githubusercontent.com/u/2905949?v=4&size=128" width=64> <img alt="Contributor aimagic" src="https://avatars.githubusercontent.com/u/40253639?v=4&size=128" width=64> <img alt="Contributor abdusabri" src="https://avatars.githubusercontent.com/u/25670682?v=4&size=128" width=64> <img alt="Contributor caaatisgood" src="https://avatars.githubusercontent.com/u/12913401?v=4&size=128" width=64> <img alt="Contributor pzmarzly" src="https://avatars.githubusercontent.com/u/8074163?v=4&size=128" width=64> <img alt="Contributor naveensrinivasan" src="https://avatars.githubusercontent.com/u/172697?v=4&size=128" width=64> <img alt="Contributor matt9ucci" src="https://avatars.githubusercontent.com/u/8044346?v=4&size=128" width=64> <img alt="Contributor lostintangent" src="https://avatars.githubusercontent.com/u/116461?v=4&size=128" width=64> <img alt="Contributor Zamiell" src="https://avatars.githubusercontent.com/u/5511220?v=4&size=128" width=64> <img alt="Contributor dflock" src="https://avatars.githubusercontent.com/u/47756?v=4&size=128" width=64> <img alt="Contributor DenysVuika" src="https://avatars.githubusercontent.com/u/503991?v=4&size=128" width=64> <img alt="Contributor ScottRudiger" src="https://avatars.githubusercontent.com/u/26824724?v=4&size=128" width=64> <img alt="Contributor rivy" src="https://avatars.githubusercontent.com/u/80132?v=4&size=128" width=64> <img alt="Contributor rasa" src="https://avatars.githubusercontent.com/u/220772?v=4&size=128" width=64> <img alt="Contributor roman-petrov" src="https://avatars.githubusercontent.com/u/18419515?v=4&size=128" width=64> <img alt="Contributor orta" src="https://avatars.githubusercontent.com/u/49038?v=4&size=128" width=64> <img alt="Contributor ollelauribostrom" src="https://avatars.githubusercontent.com/u/16004130?v=4&size=128" width=64> <img alt="Contributor alexandear" src="https://avatars.githubusercontent.com/u/3228886?v=4&size=128" width=64> <img alt="Contributor ndelangen" src="https://avatars.githubusercontent.com/u/3070389?v=4&size=128" width=64> <img alt="Contributor nvuillam" src="https://avatars.githubusercontent.com/u/17500430?v=4&size=128" width=64> <img alt="Contributor 74th" src="https://avatars.githubusercontent.com/u/1060011?v=4&size=128" width=64> <img alt="Contributor ssbarnea" src="https://avatars.githubusercontent.com/u/102495?v=4&size=128" width=64> <img alt="Contributor regseb" src="https://avatars.githubusercontent.com/u/1262990?v=4&size=128" width=64> <img alt="Contributor zwaldowski" src="https://avatars.githubusercontent.com/u/170812?v=4&size=128" width=64> <img alt="Contributor fisker" src="https://avatars.githubusercontent.com/u/172584?v=4&size=128" width=64> <img alt="Contributor hzhu" src="https://avatars.githubusercontent.com/u/1811365?v=4&size=128" width=64> <img alt="Contributor jonz94" src="https://avatars.githubusercontent.com/u/16042676?v=4&size=128" width=64> <img alt="Contributor mrazauskas" src="https://avatars.githubusercontent.com/u/72159681?v=4&size=128" width=64> <img alt="Contributor wtgtybhertgeghgtwtg" src="https://avatars.githubusercontent.com/u/18507762?v=4&size=128" width=64> <img alt="Contributor wujekbogdan" src="https://avatars.githubusercontent.com/u/533954?v=4&size=128" width=64> <img alt="Contributor siosio34" src="https://avatars.githubusercontent.com/u/7166022?v=4&size=128" width=64> <img alt="Contributor ADTC" src="https://avatars.githubusercontent.com/u/6047296?v=4&size=128" width=64> <img alt="Contributor AlexJameson" src="https://avatars.githubusercontent.com/u/33040934?v=4&size=128" width=64> <img alt="Contributor AlekSi" src="https://avatars.githubusercontent.com/u/11512?v=4&size=128" width=64> <img alt="Contributor alicewriteswrongs" src="https://avatars.githubusercontent.com/u/6207644?v=4&size=128" width=64> <img alt="Contributor aminya" src="https://avatars.githubusercontent.com/u/16418197?v=4&size=128" width=64> <img alt="Contributor screendriver" src="https://avatars.githubusercontent.com/u/149248?v=4&size=128" width=64> <img alt="Contributor d2s" src="https://avatars.githubusercontent.com/u/135053?v=4&size=128" width=64> <img alt="Contributor dimitropoulos" src="https://avatars.githubusercontent.com/u/15232461?v=4&size=128" width=64> <img alt="Contributor evenstensberg" src="https://avatars.githubusercontent.com/u/16735925?v=4&size=128" width=64> <img alt="Contributor tribut" src="https://avatars.githubusercontent.com/u/719105?v=4&size=128" width=64> <img alt="Contributor HoussemDellai" src="https://avatars.githubusercontent.com/u/6548359?v=4&size=128" width=64> <img alt="Contributor jmatsuzawa" src="https://avatars.githubusercontent.com/u/545426?v=4&size=128" width=64> <img alt="Contributor joshje" src="https://avatars.githubusercontent.com/u/813784?v=4&size=128" width=64> <img alt="Contributor kamontat" src="https://avatars.githubusercontent.com/u/14089557?v=4&size=128" width=64> <img alt="Contributor kenji-miyake" src="https://avatars.githubusercontent.com/u/31987104?v=4&size=128" width=64> <img alt="Contributor fughilli" src="https://avatars.githubusercontent.com/u/6869039?v=4&size=128" width=64> <img alt="Contributor Ki-er" src="https://avatars.githubusercontent.com/u/32241933?v=4&size=128" width=64> <img alt="Contributor Maxim-Mazurok" src="https://avatars.githubusercontent.com/u/7756211?v=4&size=128" width=64> <img alt="Contributor exhuma" src="https://avatars.githubusercontent.com/u/65717?v=4&size=128" width=64>
<!--- cspell:enable ---> <!--- @@inject-end: static/contributors.md ---> <!--- @@inject: static/footer.md ---> <br/><p align="center">Brought to you by<a href="https://streetsidesoftware.com" title="Street Side Software"><img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software</a></p> <!--- @@inject-end: static/footer.md ---> <!--- cspell:ignore Houssem Dellai --->