Enable warnings for undocumented QL entities
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- typescript, vscode
調査の方向性
まず、既存のCI QLDocカバレッジテストとそのシェルスクリプトを確認し、次にエディターの診断を報告するlanguage server/compilerの経路を追跡します。公開されている述語、クラス、モジュールをどのように識別するか、またユーザー設定が必要かどうかを定義します。既存の動作を後退させることなく、欠落しているQLDocコメントによってエディター警告が生成されれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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時間
- マージ済み PR（30日）
- 29
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
github/vscode-codeql のほかの issue
-
bug VSCode
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
github/vscode-codeql#4471 · コメント 1 件 ·
-
bug enhancement VSCode
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
github/vscode-codeql#592 · コメント 2 件 ·
-
enhancement VSCode
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
github/vscode-codeql#4432 · コメント 1 件 ·
-
bug VSCode
難易度 3/5 1〜2日 初心者へのやさしさ 52/100
github/vscode-codeql#4356 ·
-
bug VSCode
難易度 3/5 1〜2日 初心者へのやさしさ 64/100
github/vscode-codeql#4339 · コメント 1 件 ·
github/vscode-codeql の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
safetrustcr/dApp-SafeTrust#426 ·
-
area:workflow bug ready-for-agent
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
fil-donadoni/tolaria#4409 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
Fission-AI/OpenSpec#1960 ·
-
Add dependabot オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
corsairdev/corsair#1764 ·