rnix-lsp Crates.io

A syntax-checking language server using rnix.

This is beta-level quality at best - I didn't expect maintaining a language server when writing rnix, the goal was that others would flock around the parser and write a bunch of editor tooling :)

Breakages are expected. No semver compatibility before 1.x.y.

Turn on logging with RUST_LOG=trace, and redirect stderr to a file.

sh bash -c "env RUST_LOG=trace rnix-lsp 2> /tmp/rnix-lsp.log"

Install

$ nix-env -i -f https://github.com/nix-community/rnix-lsp/archive/master.tar.gz

Integrate with your editor

These instructions are not fully tested - see issue #3. Please raise an issue and/or send a PR if a config below didn't work out of the box.

Vim/Neovim

coc.nvim

```vim { "languageserver": { "nix": { "command": "rnix-lsp", "filetypes": [ "nix" ] } } }

```

LanguageClient-neovim

vim let g:LanguageClient_serverCommands = { \ 'nix': ['rnix-lsp'] \ }

vim-lsp

vim if executable('rnix-lsp') au User lsp_setup call lsp#register_server({ \ 'name': 'rnix-lsp', \ 'cmd': {server_info->[&shell, &shellcmdflag, 'rnix-lsp']}, \ 'whitelist': ['nix'], \ }) endif

Emacs

lsp-mode

elisp (add-to-list 'lsp-language-id-configuration '(nix-mode . "nix")) (lsp-register-client (make-lsp-client :new-connection (lsp-stdio-connection '("rnix-lsp")) :major-modes '(nix-mode) :server-id 'nix))

eglot

elisp (add-to-list 'eglot-server-programs '(nix-mode . ("rnix-lsp")))

Kakoune

kak-lsp

kak-lsp has builtin configuration since version v9.0.0:

toml [language.nix] filetypes = ["nix"] roots = ["flake.nix", "shell.nix", ".git"] command = "rnix-lsp"

If you run into an issue regarding "missing roots" see this issue.

VSCode

vscode-nix-ide

json { "nix.enableLanguageServer": true }

RIP jd91mzm2

Sadly, the original author of this project, @jD91mZM2 has passed away. His online presence was anonymous and what we have left is his code. This is but one of his many repos that he contributed to.