Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

QLDoc view omits `<code>` HTML elements

Aperta
#794 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
documentation

Direzione di ricerca

Riproduci il problema in un file di query passando il mouse sull’esempio QLDoc fornito nell’estensione VSCode. Traccia il percorso di hover/rendering di QLDoc per determinare perché il contenuto degli elementi code viene omesso. Il lavoro è completato quando il contenuto appare nel QLDoc renderizzato, idealmente con la formattazione del codice, senza introdurre regressioni negli altri elementi HTML mostrati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

bug VSCode

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
    ❌ 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

Lingua principale
TypeScript
Stelle
539
Fork
240
Merge medio
2g 6h
PR unite (30g)
29

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di github/vscode-codeql

Tutte le issue di github/vscode-codeql

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.