Enable warnings for undocumented QL entities

未关闭

#670 创建于 2020年11月4日 5 条评论 0 个 reaction 已指派 0 人在 GitHub 查看

还没有人认领这个 Issue。

评估

难度: 5/5
预计耗时: 一周以上
新手友好度: 35/100

Issue 类型: 功能
描述清晰度: 基本清楚
活跃度: 停滞
技术栈: typescript, vscode
领域: developer-experience, tooling

调研方向

首先检查现有的 CI QLDoc 覆盖率测试及其 shell 脚本，然后跟踪报告编辑器诊断的 language server/compiler 路径。定义如何识别公共谓词、类和模块，以及是否需要用户设置；当缺失的 QLDoc 注释能够产生编辑器警告，且不导致现有行为回归时，即视为完成。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言: TypeScript
星标: 539
派生: 240
平均合并: 2 天 6 小时
30 天内合并 PR: 29

贡献指南

打开贡献指南

从这里开始

先读完整个 Issue，再读项目的贡献指南。
在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
Fork 仓库，在一个分支上完成修改。
提交 Pull Request，并在描述里引用这个 Issue 编号。

github/vscode-codeql 的其他 Issue

`createLockFileForStandardQuery` always creates temp lock because `packPacklist` doesn't return lock files 未关闭

bug VSCode

难度 2/5 1-3 小时新手友好度 68/100

github/vscode-codeql#4471 · 1 条评论 · 2026年7月22日创建
Add ability to use contextual queries to find references when already on a reference 未关闭

bug enhancement VSCode

难度 2/5 1-3 小时新手友好度 68/100

github/vscode-codeql#592 · 2 条评论 · 2020年9月27日创建
Allow reloading database contents from the UI 未关闭

enhancement VSCode

难度 3/5 1-2 天新手友好度 55/100

github/vscode-codeql#4432 · 1 条评论 · 2026年6月20日创建
"Add Database Source to Workspace" does not preserve loaded database 未关闭

bug VSCode

难度 3/5 1-2 天新手友好度 52/100

github/vscode-codeql#4356 · 2026年4月3日创建
"Show AST" not working in codeql tab 未关闭

bug VSCode

难度 3/5 1-2 天新手友好度 64/100

github/vscode-codeql#4339 · 1 条评论 · 2026年3月22日创建

查看 github/vscode-codeql 的全部 Issue

相似的 Issue

⚡perf(web): replace <img> with next/image in WalletSelectionModal (3 warnings) 未关闭

难度 2/5 1-3 小时新手友好度 75/100

safetrustcr/dApp-SafeTrust#426 · 2026年9月23日创建
fix: in-app bug reports carry the user-report label — ADR 0143's P1 door never fires 未关闭

area:workflow bug ready-for-agent

难度 2/5 1-3 小时新手友好度 75/100

fil-donadoni/tolaria#4409 · 2026年9月23日创建
Add GigaCode as a supported --tools target 未关闭

难度 2/5 1-3 小时新手友好度 70/100

Fission-AI/OpenSpec#1960 · 2026年9月23日创建
Add dependabot 未关闭

难度 2/5 1-3 小时新手友好度 70/100

TanStack/ai#1462 · 2026年9月23日创建
Missing security headers on corsair.dev (CSP, X-Frame-Options, etc.) 未关闭

难度 2/5 1-3 小时新手友好度 75/100

corsairdev/corsair#1764 · 2026年9月23日创建

更多 TypeScript Issue