https://github.com/tekumara/typos-lsp
Source code spell checker for Visual Studio Code, Neovim and other LSP clients
https://github.com/tekumara/typos-lsp
lsp lsp-server spelling spelling-correction vscode
Last synced: 30 days ago
JSON representation
Source code spell checker for Visual Studio Code, Neovim and other LSP clients
- Host: GitHub
- URL: https://github.com/tekumara/typos-lsp
- Owner: tekumara
- License: mit
- Created: 2023-04-09T09:38:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-01T01:38:21.000Z (9 months ago)
- Last Synced: 2025-01-01T02:20:29.367Z (9 months ago)
- Topics: lsp, lsp-server, spelling, spelling-correction, vscode
- Language: Rust
- Homepage: https://marketplace.visualstudio.com/items?itemName=tekumara.typos-vscode
- Size: 940 KB
- Stars: 291
- Watchers: 2
- Forks: 7
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - tekumara/typos-lsp - Source code spell checker for Visual Studio Code, Neovim and other LSP clients (Rust)
README
# typos-lsp
[](https://github.com/tekumara/typos-lsp/actions/workflows/ci.yml)
[](https://github.com/tekumara/typos-lsp/actions/workflows/release.yml)
> **Source code spell checker for Visual Studio Code and LSP clients**
[typos](https://github.com/crate-ci/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
- VS Code: Install [Typos spell checker](https://marketplace.visualstudio.com/items?itemName=tekumara.typos-vscode) from the VSCode Marketplace.
- VSCodium: Install [Typos spell checker](https://open-vsx.org/extension/tekumara/typos-vscode) from the Open VSX Registry.
- Neovim: Install `typos-lsp` using [mason](https://mason-registry.dev/registry/list#typos-lsp).
- Zed: Install [Typos](https://zed.dev/extensions?query=typos) from Zed's extension marketplace.
### Other clients
For homebrew users:
```
brew install typos-lsp
```
For [cargo-binstall](https://github.com/cargo-bins/cargo-binstall) users:
```
cargo binstall --git https://github.com/tekumara/typos-lsp typos-lsp
```
For Linux users (via Cargo):
```sh
cargo install --git https://github.com/tekumara/typos-lsp typos-lsp
```
Or manually download `typos-lsp` from the [releases page](https://github.com/tekumara/typos-lsp/releases).
## Configuration
For configuration see:
- [VS Code Settings](docs/vscode-settings.md)
- [Neovim LSP config](docs/neovim-lsp-config.md)
- [Helix config](docs/helix-config.md)
- [Zed config](docs/zed-config.md)
# 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](https://github.com/crate-ci/typos/blob/master/docs/reference.md) 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?](https://github.com/crate-ci/typos?tab=readme-ov-file#why-was--not-corrected).
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) to get started.