README.md

typos-lsp

Source code spell checker for Visual Studio Code and LSP clients

typos is a low false-positive source code spell checker. This project exposes typos 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 Typos spell checker from the VSCode Marketplace.
• VSCodium: Install Typos spell checker from the Open VSX Registry.
• Neovim: Install typos-lsp using mason or download typos-lsp from the releases page.
• Helix: Download typos-lsp from the releases page and place it on your PATH.
• Other clients: Download typos-lsp from the releases page.

For configuration see:

• VS Code Settings
• Neovim LSP config
• Helix config

Features

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

  

Usage

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

Config file support

Supports config fields in typos.toml, _typos.toml, or .typos.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 typos defaults will be used.

Caveats

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

Why aren't my misspellings being corrected?

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