codetypo-lsp

Source code spell checker for Visual Studio Code and LSP clients

codetypo is a low false-positive source code spell checker. This project exposes codetypo via a Language Server Protocol (LSP) server and Visual Studio Code extension to provide a fast, low memory, in-editor spell checker.

Install

• Vscode: Install Codetypo spell checker from the VSCode Marketplace.
• VSCodium: Install Codetypo spell checker from the Open VSX Registry.
• Neovim: Install codetypo-lsp using mason or download codetypo-lsp from the releases page.
• Helix: Download codetypo-lsp from the releases page and place it on your PATH.
• Zed: Install Codetypo from Zed's extension marketplace.
• Other clients: Download codetypo-lsp from the releases page.

For configuration see:

• VS Code Settings
• Neovim LSP config
• Helix config
• Zed config

Features

• Identify misspellings and provide a Quick Fix with suggested corrections:

  

Usage

Once installed codetypo will automatically execute when you open or edit any file.

Config file support

Supports config fields in codetypo.toml, _codetypo.toml, or .codetypo.toml, except:

• files.ignore* - have no effect.
• default.check-filename - file names are never spell checked.
• default.check-file - files are always checked.
• *.binary - binary files are always checked.

Config files will be read from the workspace folder or its parents. If there is no workspace folder, then no config file will be read and the codetypo defaults will be used.

Caveats

• File names are not spell checked.
• Server must be restarted after changing the config files (ie: codetypo.toml).

Why aren't my misspellings being corrected?

To minimise false-positives codetypo only suggests corrections for known misspellings, rather than unknown words like a traditional spell-checker. For more info see Why was ... not corrected?.

Contributing

See CONTRIBUTING.md to get started.