VS Code mit otris DOCUMENTS
Zweck und Voraussetzungen
Wir entwickeln PortalScripts für DOCUMENTS lokal in VS Code statt im Manager. So haben wir IntelliSense, schnelle Suche über alle Skripte und den vollen Editor-Komfort von VS Code.
Voraussetzungen
- VS Code (aktuelle Version), macOS, Windows oder Linux
- Netzwerkzugriff auf den DOCUMENTS-Server (Anwendungsport)
- DOCUMENTS-Benutzer mit Rechten zum Lesen und Schreiben von PortalScripts im Ziel-Mandanten (Principal)
Doku von otris
Für die otris-Doku ist ein otris-Account nötig. Den kann man per E-Mail an support@otris.de anfragen.
Einrichtung
Projektordner anlegen und öffnen Neues VS-Code-Fenster öffnen (Datei → Neues Fenster). Ordner fü...
Verbindung herstellen und Skripte herunterladen
Die documentsOS-Extension bietet einen Wizard (documentsOS: Wizard: Download / Create Project). D...
Arbeiten mit Typings in VS Code (DOCUMENTS)
Worum geht es? Typings sind Typbeschreibungen (.d.ts-Dateien und JSDoc-Kommentare), mit denen VS...
Projekt-Setup
Damit VS Code die Typings findet, braucht unser Workspace drei Dinge: eine jsconfig.json im Root,...
Grundlagen: Typen mit JSDoc
In JavaScript schreiben wir Typen nicht in den Code, sondern in JSDoc-Kommentare (/** ... */). VS...
Eigene Typen definieren
Sobald ein Objekt an mehreren Stellen vorkommt (Konfigurationen, Rückgabewerte, JSON von externen...
DOCUMENTS-API-Typen nutzen
Die wichtigsten Objekte sind ohne eigenes Zutun typisiert: context, util und alle API-Klassen wie...
Bibliotheken und eigene .d.ts-Dateien
Die otris-Bibliotheken otrUpgrade, otrAssert und util.otrLogger bringen eigene Typings mit, größt...
Stolperfallen
Die meisten Probleme haben eine Ursache: Ein Typ, den VS Code nicht kennt, wird ohne Typprüfung s...
Checkliste für neue Skripte
Kein // @ts-nocheck: checkJs prüft jedes neue Skript automatisch. Jede Funktion hat @param und ...
Empfohlene jsconfig.json
Diese Vorlage passt für jeden DOCUMENTS-Workspace: checkJs und alwaysStrict stehen auf true. Proj...