Enable warnings for undocumented QL entities
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Feature
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- typescript, vscode
- Bereich
- developer-experience, tooling
Rechercherichtung
Beginne mit der Überprüfung des bestehenden CI-Tests zur QLDoc-Abdeckung und seines Shell-Skripts. Verfolge anschließend den Pfad von Language Server/Compiler, der Editor-Diagnosen meldet. Lege fest, wie öffentliche Prädikate, Klassen und Module identifiziert werden und ob eine Benutzereinstellung erforderlich ist; als abgeschlossen gilt die Aufgabe, wenn fehlende QLDoc-Kommentare Editor-Warnungen erzeugen, ohne das bestehende Verhalten zu beeinträchtigen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 539
- Forks
- 240
- Ø Merge
- 2 T. 6 Std.
- Gemergte PRs (30 T.)
- 29
Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus github/vscode-codeql
-
bug VSCode
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
github/vscode-codeql#4471 · 1 Kommentar ·
-
bug enhancement VSCode
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
github/vscode-codeql#592 · 2 Kommentare ·
-
enhancement VSCode
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100
github/vscode-codeql#4432 · 1 Kommentar ·
-
bug VSCode
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 52/100
github/vscode-codeql#4356 ·
-
bug VSCode
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 64/100
github/vscode-codeql#4339 · 1 Kommentar ·
Alle Issues in github/vscode-codeql
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
safetrustcr/dApp-SafeTrust#426 ·
-
area:workflow bug ready-for-agent
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
fil-donadoni/tolaria#4409 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
Fission-AI/OpenSpec#1960 ·
-
Add dependabot Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
corsairdev/corsair#1764 ·