TypeScript ist eine typisierte Obermenge von JavaScript, die in einfachen Apps Script-Code kompiliert werden kann. Wenn Sie TypeScript bei der Entwicklung eines Apps Script-Projekts verwenden, haben Sie folgende Vorteile:
- Autocomplete in der lokalen IDE
- Optionale strukturelle Typisierung
- Typinferenz, Schnittstellen
- ES6-Funktionen wie Klassen und Pfeilfunktionen
In diesem Leitfaden werden einige gängige Aufgaben für die Entwicklung eines Apps Script-Projekts mit TypeScript behandelt.
Voraussetzungen
Wenn Sie mit TypeScript nicht vertraut sind, lesen Sie die TypeScript-Dokumentation und die TypeScript-Kurzanleitung, um sich mit den grundlegenden Konzepten vertraut zu machen, bevor Sie die in diesem Leitfaden beschriebenen Verfahren ausführen.
Die folgenden Tools sind erforderlich, um TypeScript in Apps Script-Projekten mit clasp zu verwenden. Die Verwendung von clasp ist zwar nicht unbedingt erforderlich, um TypeScript in Apps Script zu verwenden, wird aber dringend empfohlen, da sie die Abläufe erheblich vereinfacht.
Bevor Sie einen der unten beschriebenen Prozesse ausführen, müssen Sie Folgendes installiert haben, um Ihre lokale Entwicklungsumgebung zu aktivieren:
- Node und npm
clasp:npm install -g @google/clasp- Typdefinitionen für Apps Script:
npm i -S @types/google-apps-script - Visual Studio Code (für die automatische Vervollständigung in der TypeScript-IDE)
Machen Sie sich mit der clasp-Dokumentation vertraut, wenn Sie clasp noch nicht verwendet haben.
TypeScript in einem Clasp-Projekt verwenden
Mit clasp können Sie schnell ein neues lokales Apps Script-Projekt erstellen.
Mit diesem Befehl werden appsscript.json und Code.gs erstellt, die Grundlage eines Apps Script-Projekts.
Wenn Sie TypeScript in einer Apps Script-Datei verwenden möchten, ändern Sie einfach die Dateiendung von gs in ts.
Lokale TypeScript-Dateien bearbeiten
Mit Ihrem bevorzugten Editor können Sie lokale TypeScript-Dateien als .ts-Dateien im Projektordner schreiben.
Eine Datei mit dem Namen index.ts könnte beispielsweise den folgenden TypeScript-Code enthalten:
const greeter = (person: string) => {
return `Hello, ${person}!`;
}
let user = 'Grant';
Logger.log(greeter(user));
Sie können TypeScript mit ES6- und höheren Funktionen wie Pfeilfunktionen und Stringinterpolation (${var}) schreiben. Diese Dateien werden in Apps Script-Konstrukte transpiliert, wenn Sie das Projekt auf den Apps Script-Server pushen.
Lokales Apps Script-Projekt mit TypeScript hochladen
Wenn Sie die lokalen TypeScript- und Apps Script-Dateien fertig bearbeitet haben, können Sie sie mit dem folgenden clasp-Befehl in Google Drive hochladen:
clasp push --watch
Mit diesem Befehl werden Änderungen an TypeScript-Dateien überwacht. Der Code wird mit typescript kompiliert und das Projekt mit clasp in Google Drive hochgeladen.
Probleme melden oder Funktionsanfrage stellen
Wenn ein Problem mit dem clasp-Tool auftritt, können Sie es auf GitHub melden.
Wenn Sie ein Problem oder einen Fehler mit TypeScript selbst feststellen, können Sie ihn im GitHub-Repository von TypeScript melden.