Divekit VSCode Plugin

June 28, 2021 · View on GitHub

Beschreibung

Dieses Repository enthält den Sourcecode für das Divekit VSCode Plugin. Zusammen mit den Repositorys divekit-language-plugin-intellij und divekit-language-server bildet es die Codebasis für das Praxisprojekt "Entwicklung eines IDE Plugins zur Unterstützung bei der Erstellung individualisierter Praktika-und Klausuraufgaben".

Eine ausführliche Dokumentation der verschiedenen Projektbestandteile befindet sich im Wiki.

Nutzung

Das Plugin ist für die Nutzung im Projekt automated-repo-setup entwickelt worden.

Nach der Installation sind noch folgende Schritte erforderlich:

  • Divekit Language Server JAR muss auf dem lokalen Dateisystem vorhanden sein.

  • Der absolute Pfad zur JAR muss in den Einstellungen unter Settings -> Extensions -> Divekit eingetragen werden.

  • Der absolute Pfad zu den Dateien variationsConfig.json und variableExtensionsConfig.json kann in den Einstellungen eingetragen werden. Werden die Felder leer gelassen, sucht das Plugin automatisch in allen Verzeichnissen unterhalb des aktuell geöffneten Workspaces nach den Config-Dateien. Achtung: Das Plugin startet den Language Server nur, wenn die beiden Config-Dateien gefunden werden.

  • Daraufhin muss das Plugin noch über einen Haken im Kästchen bei den Einstellungen aktiviert werden. Hier kann das Plugin ebenfalls deaktiviert werden, wenn man an anderen Projekten arbeitet und nicht möchte, dass die Notifications vom Divekit Language Plugin nerven.

  • Anschließend kann das Projekt automated-repo-setup gestartet werden. Wenn es vorher schon geöffnet war, muss es einmal geschlossen und wieder geöffnet werden. Wenn unten rechts die Meldung erscheint, dass der Language Server in diesem Projekt genutzt werden kann, hat alles funktioniert.

  • Wenn man in einem Markdown- oder Java-File zwischen der Code-Completion des Platzhaltervariablensystemes und der Code-Completion für dementsprechend Java oder Markdown wechseln möchte, kann man dies über die Symbolleiste unterhalb des Editorfensters von VSCode. Nach einem Klick kann hier eine Sprache ausgewählt werden.

Weiterentwicklung & Anpassungen

  • Probleme & Fehler können auf GitHub zuerst unter der Issues eingetragen werden und anschließend von da abgearbeitet werden.

  • Vor dem Mergen empfiehlt sich in der Regel ein Pull-Request, da so die Code-Qualität hoch gehalten werden kann.

  • Im Reiter Run & Debug (CTRL + SHIFT + D) lässt sich über "Run Extension" (F5) eine neue VSCode Instanz mit installierter Extension zum schnellen Testen der Funktionalität öffnen.