vscode-codeql icon indicating copy to clipboard operation
vscode-codeql copied to clipboard

QLDoc view omits `<code>` HTML elements

Open Marcono1234 opened this issue 4 years ago • 2 comments

Describe the bug According to the language specification QLDoc uses CommonMark, which supports raw HTML.

It appears that the VSCode extension supports HTML entity references (e.g. &ast;), and for some HTML elements simply shows their content without any special formatting (e.g. <b>bold</b>).

However, <code> elements are apparently completely omitted, not even their content is shown: QLDoc VSCode extension screenshot

My use case is that I would like to write /** ... */ (a Javadoc comment) in a QLDoc, however */ is recognized as end of the QLDoc. Therefore the only workaround might be to use <code>/** ... &ast;/</code>. But this is not super important, I could probably also just omit */ from my QLDoc comment.

To Reproduce

  1. In a query file write the following QLDoc comment or add it to an existing element
    /**
     * Test <code>code</code> &ast;/ <b>bold</b> <i>italic</i>
     */
    
  2. Hover over the QLDoc :x: The text "code" is completely missing from the shown rendered QLDoc

Expected behavior

  • At least the content of the <code> element should be shown in the rendered QLDoc (similar to how it is the case for <b>)
  • Or ideally the content of the <code> element is shown and formatted as code

Additional context The LGTM Query Console seems to support <code> and even formats the text as code in the preview when hovering over a documented element: Query Console QLDoc screenshot

Marcono1234 avatar Mar 20 '21 03:03 Marcono1234

Vscode doesn't support non-span tags in markdown and we pass the markdown directly to vscode so this will be tricky to support. See https://github.com/microsoft/vscode/issues/110945 for the upstream issue.

alexet avatar Mar 22 '21 15:03 alexet

Thanks for the information! Feel free to close this issue then if you think VSCode should fix this issue, unless you want to perform some pre-processing.

Marcono1234 avatar Mar 22 '21 16:03 Marcono1234