Render hover documentation as Markdown in LSP

[deotimedev]

Renders hover documentation as markdown instead of plaintext in LSP

Before:

After:

[vkleen]

This seems to trim the identation from code snippets, which is probably not intended.

[deotimedev]

True, it seems like the desired behavior should be like that of the indoc! macro which removes only the common indentation in the lines. Should I add the implementation for that macro, unindent, as a dependency, or make a seperate function for that?

[vkleen]

Since unindent is in our dependency tree already for indoc, using that seems like a reasonable thing to do 👍

[deotimedev]

Fixes a strange regression with the unindent crate that causes strings like this to be unindented properly:

But not this:

[yannham]

Could be worth adding this information directly in the code, via a comment.

[yannham]

LGTM, thanks! However, I'm a bit confused as to why we need to unindent here. The doc is parsed without the common indentation prefix (which I just checked by println! the raw documentation of std.contract.apply after parsing), that is, Nickel multiline strings should have the same effect as unindent already. Do you have any idea where does this indentation come from?

[deotimedev]

I see here that multiline strings should be getting parsed with indent removed:

However, it still seems like the indent remains in these strings anyways:

Not entirely sure why this is happening, also found this strip_indent_doc function, but it doesn't seem like its being used anywhere currently

[deotimedev]

Also seems like the documentation created from the nickel doc command keeps the indent in it:

[vkleen]

I'm tentatively suspecting pretty sure that's a line ending issue and should be fixed in the multiline string parser. With \n line endings the nickel doc output is correctly unindented for me.

[yannham]

Ah, \r\n is probably not considered an empty line, and thus the indentation prefix is set to 0 because of this. This is why we need more Windows tester 🙃 Then this is a bug in Nickel itself, and the LSP shouldn't try to handle this. @DeoTimeTheGithubUser, would that be ok to get rid of unindent here? We'll take care of the issue in the parsing of multiline strings separately.

[yannham]

Perfect, many thanks!