nixd/hover: hover documentation for options #526
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
inclyc
reviewed
Jun 19, 2024
inclyc
reviewed
Jun 19, 2024
There was a problem hiding this comment.
The unit test is insufficient because it just tests the old behaviour but I couldn't figure out how to test an actual docstring.
Just use
meson test -C <your-build-dir>
it will be executed automatically. The CHECK: strings are obtained from command standard outputs.
Do this in your shell:
<installed-nixd-bin> --lit-test --nixos-options-expr="{ foo.bar = { _type = \"option\"; }; }" nixd/tools/nixd/test/hover-options.md
And it should emit some JSON outputs, prefix the important response with CHECK and CHECK-NEXT, just like other tests.
Currently the CI is failing because the behavior is not "old" (we can pop options doc now!)
https://github.com/nix-community/nixd/actions/runs/9584839786?pr=526
inclyc
reviewed
Jun 19, 2024
inclyc
approved these changes
Jun 21, 2024
inclyc
changed the title
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #174
This patch implements hover documentation for options.