README.md

[expelledboy]

Hey @ebkalderon, excited to see this being written! Could you give me a quick intro to get it working? I used nix -> vim -> buildin vim language server. Any assistance would be great, even just an introduction.

[ebkalderon]

Hey there, @expelledboy! It should be usable like any other language server using the stdio transport. So for Vim, for example, you could use any of the following plugins:

• autozimu/LanguageClient-neovim (Vim8/Neovim)
• neoclide/coc.nvim (Vim8/Neovim)
• prabirshrestha/vim-lsp (Vim8/Neovim)

You can compile the language server in release mode with cargo build --release and the binary would be found in target/release/nix-language-server. Then, you would point your language client plugin to this path.

[ebkalderon]

Please do keep in mind that the existing parser is not fully feature-complete and is undergoing a redesign, as tracked in issue #11.

As such, parsing bugs for the old parser will not be tracked until the rewrite is complete. Current known bugs include:

• Trailing commas in functions with formal arguments, e.g. { x, }: x
• Ellipsis and bindings in functions with formal arguments, e.g. { ... }@x: x (Formal arg with ellipsis #7)
• Whitespace inside string interpolations, e.g. "foo ${bar baz} quux" (Preserved whitespace in interpolations breaks parser #10)

The existing parser should still work in the meantime, though, so any ongoing work on the new parser (current progress in the nix-lexer and nix-parser2 crates) will not break any existing functionality.

[ebkalderon]

In reference to the issue title, I haven't created a README for the project yet because the language server is nowhere near feature complete yet and is just a hobby project that I work on whenever I can. However, I do really appreciate the interest!