GESS Q.

Unterstützung für GESS Q. in Visual Studio Code – die Skriptsprache für Online-Befragungen von GESS. Sobald du eine .q-Datei öffnest, hilft die Erweiterung beim Schreiben und Prüfen des Fragebogenskripts: farbige Syntax, Vorschläge beim Tippen, Erklärungen zu jedem Befehl, Sprung zur Definition einer Frage, Hinweise auf typische Fehler.

Installation

Aus dem Marketplace (empfohlen):

1. In VS Code die Ansicht Erweiterungen öffnen (Strg+Shift+X).
2. Nach „GESS Q.“ suchen und installieren – oder direkt über den Eintrag im Marketplace.

Updates installiert VS Code künftig automatisch.

.q-Dateien werden als „GESS Q.“ erkannt (unten rechts in der Statusleiste sichtbar).

Was die Erweiterung kann

• Farbige Syntax für Fragetypen, ActionBlöcke, Filter, Direktiven, Labels, Kommentare usw. – inklusive des HTML-, CSS- und JavaScript-Codes in html= / text= / css= / javascript= / jsHandler=.

• Vorschläge beim Tippen (Strg+Leertaste erzwingt sie):

  • Schlüsselwörter der Sprache – mit Kurzbeschreibung,
  • Namen von Fragen, Blöcken, Screens, Makros und opennumformats, die irgendwo im geöffneten Projekt vorkommen,
  • nur passende Vorschläge je nach Stelle: Direktiven nach # bzw. @, Makronamen nach & und #domacro , html / thymeleaf nach rendering =,
  • die Antwortcodes einer Frage nach FRAGE. oder FRAGE eq / ne / … (mit dem jeweiligen Labeltext),
  • innerhalb einer labels=-Liste die Label-Attribute (random, single, fixed, flt, open, format, …) und group / splitcolumn / text.

• Erklärung beim Zeigen mit der Maus (Hover): zu praktisch jedem Schlüsselwort ein kurzer Syntaxhinweis, ein bis drei erklärende Sätze und ein Link ins GESS-Q.-Handbuch. Zeigst du auf einen selbst vergebenen Fragen-/Block-/Makronamen, steht dort, in welcher Datei und Zeile er definiert ist (die Angabe Datei:Zeile ist ein Link – Klick springt dorthin); wie viel sonst noch gezeigt wird, steuert gessq.hover.referenceDetail.

• Navigation im Skript (auch über #include hinweg):

  • Als „Projekt“ zählt script.q (genau dieser Name) plus alles, was von dort über #include / #includeifexists erreichbar ist – ältere Kopien wie script_v1.q liefern also keine veralteten Treffer mehr. Ist ein Ordner geöffnet, wird darin nach script.q gesucht; sonst neben der geöffneten Datei. Findet sich keine, gilt nur die geöffnete Datei samt ihren #includes.
  • Datei-Gliederung (Strg+Shift+O) und projektweite Suche nach Definitionen (Strg+T) – Fragen, opennumformat, Blöcke/Screens, Makros, ActionBlock-Ziele, array / vararray / quotavar / quotagroup.
  • Zur Definition springen (F12), Alle Verweise (Shift+F12) und Umbenennen (F2) – projektweit, inklusive &name;- und #domacro-Aufrufen bei Makros.
  • Über jeder Definition steht, wie oft sie verwendet wird (Klick zeigt die Fundstellen); alle Vorkommen des Worts unter dem Cursor werden markiert.

• #include / #includeifexists: der Dateiname ist anklickbar und öffnet die eingebundene Datei.

• Fehlerhinweise (abschaltbar, siehe Einstellungen):

  • unbalancierte { } oder ( ),
  • #macro ohne #endmacro, #ifdef / #ifndef ohne #endif,
  • #include-Datei nicht vorhanden,
  • derselbe Name doppelt vergeben,
  • #domacro auf ein Makro, das es nicht gibt,
  • rendering = mehrfach oder erst nach der ersten Frage gesetzt.

• Ein-/Ausklappen von #macro-Bereichen, #ifdef-Bereichen, { … } und Blockkommentaren.

• Parameterhinweise bei Makro- und Funktionsaufrufen.

• Echtes JavaScript / CSS in javascript = "…", jsHandler = "…" und css = "…": Hover, Autovervollständigung und Parameterhinweise kommen aus dem eingebauten JS/TS- bzw. CSS-Sprachdienst (über ein internes Hilfsdokument). Die JS-Sicht kennt die GESS-Q.-Globals – QDot (onSubmit, JsonData, logger, …), $ / jQuery, Android und die Android-Funktionen (startBackgroundAudioRecording, openCamera, openBarcodeScanner, hideq, insertLayer, addImage, …). @insert(…) und &makro; werden dabei ausgeblendet. Fehlerprüfung im Block gibt es (noch) nicht; abschaltbar über gessq.embeddedLanguages.enable.

• Snippets (Textbausteine) für Fragetypen, ActionBlöcke, Filter, Grids, Server-Einstellungen u. v. m.

• Automatische Einrückung – nur auf Befehl (Dokument formatieren), richtet die Einrückung nach der {/(-Verschachtelung aus. Experimentell.

• „Was ist neu?" – nach einer Installation oder einem Update öffnet sich einmalig die Release-Notes-Seite der neuen Version (falls vorhanden; abschaltbar über gessq.releaseNotes.showOnUpdate). Jederzeit erneut über die Befehlspalette (Strg+Shift+P): GESS Q.: Release Notes anzeigen. (Der Entwicklungsbefehl … Release-Notes-Status zurücksetzen erscheint nur in der Testumgebung, nicht in veröffentlichten Builds.)

Einstellungen

Über Datei → Einstellungen → Einstellungen nach „GESS Q.“ suchen, oder in der settings.json:

Bekannte Einschränkungen

• Innerhalb von javascript= / jsHandler= / css= gibt es Hover, Vervollständigung und Parameterhinweise, aber keine Fehlerprüfung (Diagnostics werden nicht weitergereicht). Die erste Hilfe je Datei kann einen Moment brauchen, bis der Sprachdienst geladen ist.
• Dokument formatieren ändert nur die Einrückung, sonst nichts.
• Die Handbuch-Links im Hover sind ein Schnappschuss; wenn GESS eine Handbuch-Seite verschiebt, kann ein Link ins Leere zeigen.

Fehler melden

Auffälligkeiten, falsche Erklärungen oder Wünsche bitte an Volker Dobler bzw. über die Issues des Projekts. Hilfreich: die betroffene Skriptzeile und was du erwartet hättest.

Lizenz

Academic Free License v3.0 (AFL-3.0) – siehe LICENSE.

Mitwirken

Wer am Quellcode der Erweiterung selbst arbeiten möchte:

npm install
npm run compile      # Bundle nach out/ (npm run watch: bei Änderungen neu)
npm run check        # Typprüfung + Lint
npm test             # Unit-Tests
npm run package      # .vsix bauen

Zum Ausprobieren im Debugger in VS Code die Startkonfiguration „Run Extension“ (F5) starten. Details zu den einzelnen Versionen: CHANGELOG.md.

Danke 🙏

• Sebastian Zagaria (GESS GmbH) – verbessertes Syntax-Highlighting
• alle GESS-GmbH-Programmiererinnen und -Programmierer – Snippets

Viel Erfolg beim Skripten!