Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Enable warnings for undocumented QL entities

Open
#670 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript, vscode
Domain
developer-experience, tooling

Research direction

Start by reviewing the existing CI QLDoc coverage test and its shell script, then trace the language server/compiler path that reports editor diagnostics. Define how public predicates, classes, and modules are identified and whether a user setting is required; done means missing QLDoc comments produce editor warnings without regressing existing behavior.

Written by the indexing model from the issue text.

Description

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.

Dominant language
TypeScript
Stars
539
Forks
240
Avg merge
2d 6h
Merged PRs (30d)
29

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/vscode-codeql

All issues in github/vscode-codeql

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.