Markdown and plaintext order is suboptimal in `documentationFormat` and `contentFormat`

[krassowski]

This package can parse Markdown in hover/completion/signature:

codemirror-languageserver/src/index.ts

Lines 612 to 614 in d8c88a4

	if (contents.kind === "markdown") {
	value = marked.parse(value);
	}

Yet, it requests plaintext over markdown in all the cases:

codemirror-languageserver/src/index.ts

Line 143 in d8c88a4

documentationFormat: ["plaintext", "markdown"],

codemirror-languageserver/src/index.ts

Line 152 in d8c88a4

documentationFormat: ["plaintext", "markdown"],

codemirror-languageserver/src/index.ts

Line 129 in d8c88a4

contentFormat: ["plaintext", "markdown"],

which leads to sub-optimal user experience when used with servers complying with LSP specification which says:

The order describes the preferred format of the client

for each of these, e.g. https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#completionClientCapabilities

This is because servers will correctly return plaintext response in these cases. Moreover, plain text is not being correctly escaped resulting in jumbled up text

[krassowski]

To properly display doscstrings for completion the .info should be a function returning a Node, (https://codemirror.net/docs/ref/#autocomplete.Completion) currently the HTML is displayed as text

codemirror-languageserver/src/index.ts

Lines 453 to 455 in d8c88a4

	if (documentation) {
	completion.info = formatContents(documentation);
	}

[noobmaster19]

To properly display doscstrings for completion the .info should be a function returning a Node, (https://codemirror.net/docs/ref/#autocomplete.Completion) currently the HTML is displayed as text

codemirror-languageserver/src/index.ts

Lines 453 to 455 in d8c88a4

if (documentation) {
completion.info = formatContents(documentation);
}

Hey! Facing this issue now, did u have a workaround for this?

[mscolnick]

@noobmaster19 we've created a fork with many fixes and modernizations https://github.com/marimo-team/codemirror-languageserver

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs.