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 天 18 小時
30 天內合併 PR: 37

貢獻指南

開啟貢獻指南

從這裡開始

先讀完整個 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

[MagmaFusion] rapports qualité - contenus des rubriques en anglais manquants 未關閉

難度 2/5 1-3 小時新手友好度 65/100

InseeFr/Bauhaus#1634 · 2026年9月23日建立
[Bug]: SSH host picker duplicates configured aliases and known_hosts targets 未關閉

難度 2/5 1-3 小時新手友好度 75/100

pingdotgg/t3code#13270 · 2026年9月23日建立
resetSseResponseWait and noteRequestProgress silently fail to re-arm the 60s relay timeout if progress tokens arrive as strings 未關閉

bug v2

難度 2/5 1-3 小時新手友好度 75/100

modelcontextprotocol/inspector#2458 · 1 則留言 · 2026年9月23日建立
Resources: Update work of changsha 未關閉

難度 1/5 1 小時以內新手友好度 75/100

railmapgen/rmp-gallery#4068 · 2026年9月23日建立
sass-1.105.0.tgz: 1 vulnerabilities (highest severity is: 7.5) 未關閉

Mend: dependency security vulnerability status: needs triage 🕵️‍♀️

難度 2/5 1-3 小時新手友好度 70/100

carbon-design-system/ibm-products#9907 · 2026年9月23日建立

更多 TypeScript Issue