Codebook is currently only available for the Zed editor. To install, go to the Extension tab in Zed and look for "Codebook".
To keep visual noise low, Codebook only checks for spelling on save.
Codebook is a spellchecker for code. It binds together the venerable Tree Sitter and the fast spell checker Spellbook. Included is a Language Server for use in any editor. Everything is done in Rust to keep response times snappy and memory usage low.
Codebook is being developed, but the Zed extension is now live! Currently only US English is supported.
| Language | Status |
|---|---|
| Markdown | ✅ |
| Plain Text | ✅ |
| HTML | |
| CSS | |
| Go | |
| JavaScript | ✅ |
| TypeScript | |
| Python | |
| Rust | ✅ |
| TOML | ✅ |
✅ = Good to go
Codebook has an optional configuration file you can put in the root of your project. Either codebook.toml or .codebook.toml will work.
Here are the options:
# Currently unused. Will add more dictionaries soon.
# Default: ["en_us"]
dictionaries = ["en_us"]
# List of words to ignore. Case-insensitive. Codebook will add words here when you select "Add to dictionary".
# Default: []
words = ["codebook"]
# List of words to always flag as incorrect.
# Default: []
flag_words = ["todo", "fixme"]
# List of path globs to ignore when spell checking.
# Default: []
ignore_paths = ["target/**/*", "**/*.json", ".git/**/*"]Spellchecking is complicated and opinions about how it should be done, especially with code, differs. This section is about the trade offs that steer decisions.
No remote calls for spellchecking or analytics. Once dictionaries are cached, Codebook needs to be usable offline. Codebook will never send the contents of files to a remote server.
Codebook should have high signal and low noise. It should only highlight words that users have control over. For example, a misspelled word in an imported function should not be highlighted as the user can't do anything about it.
All features will be weighed against their impact on CPU and memory impact. Codebook should be fast enough to spellcheck on every keystroke on even low-end hardware.
Codebook will only check the parts of your code where a normal linter wouldn't. Comments, string literals and variable definitions for example. Codebook knows how to split camel case and snake case variables, and makes suggestions in the original case.
Codebook comes with a language server. Originally developed for the Zed editor, this language server can be integrated into any editor that supports the language server protocol.
Codebook comes with a dictionary manager, which will automatically download and cache dictionaries for a large number of written languages.
- Support more languages than US English
- Support custom project dictionaries
- Support custom global dictionaries
- Support per file extension dictionaries
- Add code actions to correct spelling
Run test with make test after cloning.
- Harper: https://writewithharper.com/
- Harper Zed: https://github.com/Stef16Robbe/harper_zed
- Spellbook: https://github.com/helix-editor/spellbook
- cSpell for VSCode: https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker
- Vale: https://github.com/errata-ai/vale-ls
- TreeSitter Visualizer: https://intmainreturn0.com/ts-visualizer/
- common-words: https://github.com/anvaka/common-words
- Hunspell dictionaries in UTF-8: https://github.com/wooorm/dictionaries
To update the Language server:
- Run
make release-lsp - Follow instructions
- Go to GitHub Releases
- Un-mark "prerelease" and publish
To update the Zed Extension:
- Go to blopker/codebook-zed
- Update the version in extension.toml
- Make a PR to zed/extensions with the updated submodule