Extension should notify users when their QL libraries are out of date

Offen
#495 5 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
25/100
Issue-Typ
Feature
Klarheit
Muss geklärt werden
Aktivitätsstatus
Veraltet
Tech-Stack
typescript
Bereich
devtools

Rechercherichtung

Es werden keine Dateien, Tests oder Einstiegspunkte genannt. Beginne damit zu prüfen, wie die Erweiterung den vscode-codeql-starter-Arbeitsbereich und die Submodule behandelt, und kläre anschließend den im Issue beschriebenen Ansatz zur Versionsprüfung und Aktualisierung. Als abgeschlossen gilt die Arbeit, wenn Benutzer über neue getaggte QL-Bibliotheksversionen gewarnt werden und klare Anweisungen zur Aktualisierung erhalten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

enhancement VSCode

Background

Most users consume QL through the vscode-codeql-starter workspace. Some cli and ide features not work unless you have up to date QL libraries. Most users aren't aware of this and there is no mechanism to notify users that updates need to happen. The only situation where users are notified is when they add a new database built from a later version of the QL libraries. However, this is not sufficient.

Proposed solution

The extension should periodically check to see if there are new QL libraries available and warn the user if there are. Optionally, the extension could try to install the changes automatically. Otherwise, clear manual instructions should be given.

Caveats and questions

  1. This will only work for the vscode-codeql-starter workspace.
  2. What is considered a new version? We probably don't want to assume any change in master is new. Likely, we want to parse tags and look for new version numbers. Or we can do this through branches.
  3. We can attempt to automatically upgrade. This is just going to be pulling the submodules, which probably won't do any harm unless a user has made changes or commits to the core queries.

It might look like this:

  1. On restart or periodically, fetch the tags for submodules
  2. Check to see if any new tagged version exists.
  3. If so prompt the user to update their libraries
  4. Ensure there is clear instuctions on how to do this.
Vorherrschende Sprache
TypeScript
Sterne
539
Forks
240
Ø Merge
2 T. 6 Std.
Gemergte PRs (30 T.)
29

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus github/vscode-codeql

Alle Issues in github/vscode-codeql

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.