Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Enable warnings for undocumented QL entities

Abierto
#670 5 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
typescript, vscode
Área
developer-experience, tooling

Línea de trabajo

Comienza revisando la prueba existente de cobertura de QLDoc de CI y su script de shell; después, sigue el recorrido del language server/compiler que informa de los diagnósticos del editor. Define cómo se identifican los predicados, las clases y los módulos públicos, y si se requiere una configuración del usuario; se considerará terminado cuando los comentarios de QLDoc ausentes produzcan advertencias en el editor sin introducir regresiones en el comportamiento existente.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
TypeScript
Estrellas
539
Forks
240
Merge medio
2 d 6 h
PR fusionados (30 d)
29

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de github/vscode-codeql

Todos los issues de github/vscode-codeql

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.