Currently it is too deep (10) which will cause evaluation slow and touching deprecated nixpkgs packages.

LSP Spec

Lifecycle Messages

• initialize
• initialized
• $/setTrace

Text Document Synchronization

• textDocument/didOpen #2
• textDocument/didChange #2
• textDocument/didClose #82

Language Features

• textDocument/publishDiagnostics #7
• textDocument/hover #22
• textDocument/completion
  #33
  #87
  #88
• textDocument/semanticTokens/* #52
• textDocument/declaration #93
• textDocument/definition
  #61
  #62
  #65
  #66
• textDocument/references
• textDocument/documentLink
• textDocument/formatting
  #78
  #79

Workspace Features

• workspace/configuration #23
• workspace/didChangeConfiguration #23

Non-LSP Notes

Nix Evaluator Extension

• nix::forceValueDepth
  #56
  #59
  #80
  #81

Milestones

• Evaluation performance #50

Vendor

• Flake package #41
• Flake overlay #55

Docs

• Developers' Manual #39
• User Guide #58

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_documentSymbol

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_semanticTokens

https://github.com/inclyc/nixd/blob/899988271170944fbff47c9ab59d2f4854fa4000/lib/nixd/src/Server.cpp#L89

In #78 we introduced automatically format via nixpkgs-fmt, so how to override this hardcoded excutable?

Currently the binaries are only tested on x86_64-linux. But actually nixd may work on other platforms (e.g. aarch64-linux).

If you have tested this please update the flake (if it works), or submit an issue (oops...).

nvim users expected "workspace configuration" in their "rootDir", not from LSP client.

• #115

• #113

If a variable is a "derivation", we can bring our user to the position that provides the package, the attribute path is under

".meta.position"

• low-level nix::Expr * support #62
• nixd::EvalAST #65

Most users would like to know just one thing: how to setup their editor to use nixd.

It would be good to document that in the README.md, in my case VSCode.

2023-06-02T08:04:05.4886792Z error: builder for '/nix/store/ddisyw8qp2bvqdnpnzpnl54ljjv6476x-nixd-0.0.1.drv' failed with exit code 1;
2023-06-02T08:04:05.4893892Z last 10 log lines:
2023-06-02T08:04:05.4894283Z > | |
2023-06-02T08:04:05.4909442Z > | std::string {aka std::__cxx11::basic_string}
2023-06-02T08:04:05.4910661Z > In file included from ../lib/nixd/include/nixd/CallbackExpr.h:4,
2023-06-02T08:04:05.4910984Z > from ../lib/nixd/include/nixd/AST.h:3,
2023-06-02T08:04:05.4911443Z > from ../lib/nixd/src/AST.cpp:1:
2023-06-02T08:04:05.4933509Z > /nix/store/y5w2djdr3mlqhr579wfnyh1idha6b9ji-nix-2.16.0-dev/include/nix/eval.hh:361:28: note: initializing argument 1 of 'void nix::EvalState::cacheFile(const nix::SourcePath&, const nix::SourcePath&, nix::Expr*, nix::Value&, bool)'
2023-06-02T08:04:05.4934037Z > 361 | const SourcePath & path,
2023-06-02T08:04:05.4934274Z > | ~~~~~~~~~~~~~~~~~~~^~~~
2023-06-02T08:04:05.4934668Z > [11/25] Compiling C++ object lib/nixd/libnixd-lsp.so.p/src_CallbackExpr.cpp.o
2023-06-02T08:04:05.4934995Z > ninja: build stopped: subcommand failed.
2023-06-02T08:04:05.4935446Z For full logs, run 'nix log /nix/store/ddisyw8qp2bvqdnpnzpnl54ljjv6476x-nixd-0.0.1.drv'.

Requesting completions fails with the following errors:

I[01:11:13.054] 2100851: <-- textDocument/completion(25)
I[01:11:13.055] 2100851: --> call nixd/ipc/textDocument/completion(266)
I[01:11:13.055] 2100851: --> call nixd/ipc/textDocument/completion(267)
I[01:11:13.055] 2225720: <-- nixd/ipc/textDocument/completion(266)
I[01:11:13.055] 2100851: --> call nixd/ipc/textDocument/completion(268)
I[01:11:13.055] 2225720: --> reply:nixd/ipc/textDocument/completion(266) no AST available on requested file /home/n/git/config/modules/nix.nix, error: 3
I[01:11:13.055] 2225724: <-- nixd/ipc/textDocument/completion(267)
I[01:11:13.055] 2100851: --> call nixd/ipc/textDocument/completion(269)
I[01:11:13.055] 2225724: --> reply:nixd/ipc/textDocument/completion(267) no AST available on requested file /home/n/git/config/modules/nix.nix, error: 3
I[01:11:13.055] 2225728: <-- nixd/ipc/textDocument/completion(268)
I[01:11:13.055] 2100851: <-- reply(266)
I[01:11:13.055] 2225732: <-- nixd/ipc/textDocument/completion(269)
E[01:11:13.055] 2100851: worker 0 reported error: -32001: no AST available on requested file /home/n/git/config/modules/nix.nix
I[01:11:13.055] 2225728: --> reply:nixd/ipc/textDocument/completion(268) no AST available on requested file /home/n/git/config/modules/nix.nix, error: 3
I[01:11:13.056] 2100851: <-- reply(267)
[truncated, more of the same]

As mentioned in

https://github.com/inclyc/nixd/blob/72d2bdbb58c02f4d9a149737bd7febdb7548a979/README.md?plain=1#L63

We should make a derivation in our flake.nix, and let our CI perform something like: nix build .#.

There is a way to do this via the LSP spec:
https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#progress

Other language servers like rust-analyzer or dartls do this. It's very useful as an "I'm working" signal.

nix::ExprAttrs nix::ExprLambda contain pos information on their own data structure, we may want to associate the expressions with that pos information, to get more accurate response.

I followed the instructions to the tee: https://github.com/nix-community/nixd/blob/main/docs/editor-setup.md#vscode

The result?

[Info  - 1:32:56 PM] Connection to server got closed. Server will restart.
[Error - 1:32:56 PM] Server initialization failed.
  Message: Pending response rejected since connection got disposed
  Code: -32097 
[Error - 1:32:56 PM] Nix client: couldn't create connection to server.
  Message: Pending response rejected since connection got disposed
  Code: -32097 

Is there anything I can do on my end to get more debug information?

Example:

{
  foo = {
    x = 1;
    y = 2;
  };
} // {
  bar = {
    xx = 1;
    y = 2;
  };
}

Currently nix just throw an exception for parsing error (and even name lookup error) which will destroy AST trees that might be useful for AST-based option completion, so we may need write some error handling logic to nix parser.

Make the parser memory-safe

provide static analysis without any nix::initGC.

• #181
• #182
• #184
• #186
• #191
• #199

Move all static analysis to controller

• #193
• #200
• #195
• #196
• #197
• #203
• #204
• #205

Basic error handling

• #206

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_semanticTokens

I actually don't know how to find coredumps on MacOS but every command segfaults immediately:

arian@Arians-MacBook-Pro nixos-stuff % nixd
zsh: segmentation fault  nixd
arian@Arians-MacBook-Pro nixos-stuff % nixd --help
zsh: segmentation fault  nixd --help

These features are lacking tests because we cannot provide "VFS" to nix, or, namely waiting for NixOS/nix#6530

After upstream pull being merged, the PRs listed here should be tested (i.e. regression tests required).

• #88
• #115
• #117
  This has been resolved by #131
• #140

s/Nix langauge server/ Nix language server

Hi,

I am using the 1.0.0 revision: e2ba0c4 and followed the usage section.

When building the I get multiple compilation errors, here is the log output:
https://gist.github.com/gaelreyrol/6ff901f8f171abacff8d2d06ebedab6d

Am I missing something?

• Configure workspace installable
• Specify workers
• Evaluation Depth

May be we should support "watchedFile" stuff, and if some exceptions raised on watched files, we should give up evaluation though.

Link: #36

Inspired by nil users, thanks. oxalica/nil#9

Curious if anybody got emacs(elgot) setup with nixd.

I've got basic elgot setup working with nixd:

(add-to-list 'eglot-server-programs '((nix-mode) "nixd"))

But I couldn't figure out how to config nixd properly with elgot:

(setq-default eglot-workspace-configuration
		'((nixd
		   (options
		    (enable . t)
		    (target
		     (installable . "/home/xx/myflake#nixosConfigurations.myhost.options"))))))

For example, if I hard coded above installable, I don't think it's doing anything. I'm pretty new to lsp and elgot, I have no idea how to debug this case.

Also, even without the installable, I found the complete result pretty weird:

for example, it completes builtins.fromTOML but obviously missing builtins.fromJSON somehow, maybe this is a separate issue.

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_foldingRange

add README.

After #136 #131, we have extended the parser that having ranges for all AST nodes (mostly, except ad-hoc created ones). So it will be nice to having documentLink on ExprPath s.

Some regression tests, like

https://github.com/inclyc/nixd/blob/2ee1ef796dd6dd5f0bc8cc4a3bc804972018c973/tools/nixd/test/basic-diagnostic.md?plain=1#L3

The arrow should be <--

Installable specified in workspace configuration is now evaluated at worker process, however, we just log the exception encountered, but not reported the bug to our client, how about send diagnostic issue at the first line of textDocument/did{Open,Change} ?

This is might be unnecessary because we will clear diagnostics later. You can test this locally, and if it is really unnecessary, just remove it!

Or, we should use this method instead:

clearDiagnostics

Maybe calling the nix lambda getSubOptions is sufficient for this, but we actually need #164 , to get precise completion list.

• #122
• #121