Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 1.5 KB
Raw

Contributing to typos-lsp

This document contains information on how to contribute to the typos-lsp crate, which is the implementation of the Language Server Protocol (LSP) server.

The source code of typos-lsp can be found in the crates/typos-lsp/ directory.

Make sure you have installed the rust toolchain with rustup.

Setting up your development environment

How to run tests

cargo test

How to run the LSP server locally for development

First, compile the LSP server:

cargo build

Next, configure your editor to launch the LSP server.

Running locally in Neovim

For example, in Neovim, you can use the sample neovim LSP config in the following way:

-- Set the path of the LSP server to the compiled binary on your disk
require('lspconfig').typos_lsp.setup({
  -- ... other settings from the example
  cmd = { "/Users/me/git/typos-lsp/target/debug/typos-lsp" },
})

To test your configuration, you can use the following methods:

  • open e.g. crates/typos-lsp/tools/test.txt. You should see errors when opening the file.
  • you can also run :LspInfo in Neovim to see the status of the LSP server.
  • you can run cargo clean in the root directory of the project. After this, you can make sure Neovim displays errors when opening a file. Once finished, run cargo build to fix this