Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

QLDoc view omits `<code>` HTML elements

Aberta
#794 2 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
35/100
Tipo de issue
Bug
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
typescript
Domínio
documentation

Direção de pesquisa

Reproduza o problema em um arquivo de consulta passando o cursor sobre o exemplo de QLDoc fornecido na extensão do VSCode. Rastreie o caminho de hover/renderização do QLDoc para determinar por que o conteúdo dos elementos code é omitido. Considera-se concluído quando o conteúdo aparece no QLDoc renderizado, idealmente com formatação de código, sem causar regressões nos outros elementos HTML exibidos.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
TypeScript
Estrelas
539
Forks
240
Merge médio
2d 18h
PRs com merge (30d)
37

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de github/vscode-codeql

Todas as issues de github/vscode-codeql

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.