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

Enable warnings for undocumented QL entities

Aberta
#670 5 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
35/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
typescript, vscode
Domínio
developer-experience, tooling

Direção de pesquisa

Comece revisando o teste existente de cobertura de QLDoc da CI e seu script de shell; em seguida, rastreie o caminho do language server/compiler que relata os diagnósticos do editor. Defina como predicados, classes e módulos públicos são identificados e se uma configuração do usuário é necessária; considera-se concluído quando comentários QLDoc ausentes produzirem avisos no editor sem causar regressões no comportamento existente.

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

Descrição

Complexity: High enhancement VSCode

Is your feature request related to a problem? Please describe.
The CodeQL language teams track their QLDoc coverage and maintain it at a high level. We have CI checks on github/codeql that flag public QL APIs without QLDoc comments, to prevent coverage regressions. @yoff suggested it would be easier to see this feedback even earlier, in the editor, when writing a new part of the library.

Describe the solution you'd like
The editor shows warnings when a public CodeQL predicate, class, or module does not have a QLDoc comment.
Consider having a user setting to toggle this feature, since it might be too noisy for all users.

Describe alternatives you've considered
CI currently runs an internal test that builds all the QLDoc HTML and examines the textual differences using a shell script.

Additional context
This can be done through language server/compiler changes, but would become more involved if we wanted the ability to toggle it. We would also need to correctly identify which APIs are public, or overapproximate.

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

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.