Spell Checker LSP

This lsp performs spell checking in source code files, using the cspell library.

~This is a fork of vscode-spell-checker and adapted to work with the~
This was intended as a fork to but its now rewritten to be general basic spell check LSP.
Tested on Helix text editor, Neovim.
Community support for Zed by @mantou132 zed-cspell

Install

``
npm install -g @vlabo/cspell-lsp
`

Arguments

`
--config, -c -> path to cspell.json config file. If not supplied the lsp will try to create a file in the root of the project. (optional)
--sortWords -> Sorts the words in the config file (optional)
--stdio -> Type of communication with the editor.
`

cspell-lsp also reads the global cspell.json in:

- Linux: ~/.config/cspell/
- macOS: ~/Library/Preferences/cspell/
- Windows: %AppData%\cspell\Config\ -> Usually: C:\Users\\AppData\Roaming\cspell\config

Helix config


helix/languages.toml:
`toml
[language-server.cspell]
command = "cspell-lsp"
args = ["--stdio"]

Add for every language that you want to spell check

[[language]]
name = "rust"
language-servers = ["rust-analyzer", "cspell"]

[[language]]
name = "cpp"
language-servers = [ "clangd", "cspell" ]

[[language]]
name = "markdown"
language-servers = [ "marksman", "cspell" ]
`
For reference https://github.com/helix-editor/helix/blob/86023cf1e6c9ab12446061e40c838335c5790979/languages.toml

Neovim config

$3


Search from cspell-lsp in the mason registry.

$3

`lua
local lsp_configurations = require('lspconfig.configs')

if not lsp_configurations.cspell_lsp then
lsp_configurations.cspell_lsp = {
default_config = {
cmd = {"", "--stdio"},
filetypes = {"go", "rust", "js", "ts", "html", "css", "json", "yaml", "markdown", "gitcommit"},
root_dir = require('lspconfig.util').root_pattern('.git')
}
}
end
require('lspconfig').cspell_lsp.setup({})
`

Build


`
npm install
npm run build
``