nixd/hover: hover documentation for options

[inclyc]

Give option documentation to our user.

[Atemu]

This would be great.

What would be especially helpful would be the type signature; that's what I'd want to see in my single line of emacs minibuffer when hovering.

[inclyc]

What would be especially helpful would be the type signature; that's what I'd want to see in my single line of emacs minibuffer when hovering.

This is already shown in the completion list, I suppose I'd rather straightforward to do this.

Contributors who wants to take this should:

Write a class OptionsHoverProvider in this anonymous namespace here:

nixd/nixd/lib/Controller/Hover.cpp

Line 88 in a8d7322

This content looks like:

nixd/nixd/lib/Controller/Definition.cpp

Line 170 in a8d7322

class OptionsDefinitionProvider {

The class shown above is used for "providing" locations, thus for hover request the new class should provide "Hover" information.

After writing that class, invoke

nixd/nixd/lib/Controller/Definition.cpp

Line 241 in a8d7322

auto R = findAttrPath(*N, PM, Scope);

here (in Controller::onHover), to get attrpath used for RPC request.

nixd/nixd/lib/Controller/Hover.cpp

Line 106 in a8d7322

const ParentMapAnalysis &PM = *TU->parentMap();

Finally, update the tests

Should be a new entry, like "hover-options.md", put it here

https://github.com/nix-community/nixd/blob/main/nixd/tools/nixd/test/

The content looks like https://github.com/nix-community/nixd/blob/main/nixd/tools/nixd/test/hover-package.md, and options list can be provided like this:

nixd/nixd/tools/nixd/test/completion-options.md

Line 2 in a8d7322

# RUN: --nixos-options-expr="{ foo.bar = { _type = \"option\"; }; }" \

[inclyc]

Anyone who wants to take this please comment here, and I can give you commit access after patches merged! (Functional improvements).

[Grafcube]

I would like to try and implement this feature.

[Grafcube]

I've opened the PR at #526