Better content assist inside of comments

Offen

#391 erstellt am 22.5.2020 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 45/100

Issue-Typ: Feature
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: typescript, vscode
Bereich: developer-experience, tooling

Rechercherichtung

Beginne mit dem Language Server und der verlinkten QLDoc-Spezifikation, um die Kommentarstruktur, Tags und unterstützte Markdown-Syntax zu verstehen. Implementiere die Vervollständigung für die dokumentierten Tags und das automatische Schließen für Markdown-ähnliche Backticks und Unterstriche. Überprüfe anschließend beide Verhaltensweisen innerhalb von QLDoc-Kommentaren.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

enhancement VSCode

Inside of a QLDoc, there is structure and the editor can be more helpful at providing better content assist support for comments and tags.

Documentation on QLDoc: https://help.semmle.com/QL/ql-spec/qldoc.html

At a minimum, the editor should propose completion of well known tags, e.g. all the tags here-

/**
 * @name Useless assignment to local variable
 * @description An assignment to a local variable that is not used later on, or whose value is always
 *              overwritten, has no effect.
 * @kind problem
 * @problem.severity warning
 * @id cs/useless-assignment-to-local
 * @tags maintainability
 *       external/cwe/cwe-563
 * @precision very-high
 */

Also, since QLDoc accepts markdown syntax, we should auto-close markdown-ish tags, like backticks and _

This task will probably require changes to the language server.

Vorherrschende Sprache: TypeScript
Sterne: 539
Forks: 240
Ø Merge: 2 T. 18 Std.
Gemergte PRs (30 T.): 37

Beitragsleitfaden

Beitragsleitfaden öffnen

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

`createLockFileForStandardQuery` always creates temp lock because `packPacklist` doesn't return lock files Offen

bug VSCode

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

github/vscode-codeql#4471 · 1 Kommentar · Erstellt am 22.7.2026
Add ability to use contextual queries to find references when already on a reference Offen

bug enhancement VSCode

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

github/vscode-codeql#592 · 2 Kommentare · Erstellt am 27.9.2020
Allow reloading database contents from the UI Offen

enhancement VSCode

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100

github/vscode-codeql#4432 · 1 Kommentar · Erstellt am 20.6.2026
"Add Database Source to Workspace" does not preserve loaded database Offen

bug VSCode

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 52/100

github/vscode-codeql#4356 · Erstellt am 03.4.2026
"Show AST" not working in codeql tab Offen

bug VSCode

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 64/100

github/vscode-codeql#4339 · 1 Kommentar · Erstellt am 22.3.2026

Alle Issues in github/vscode-codeql