TypeScript ist eine typisierte Obermenge von JavaScript, die in einfaches Apps Script kompiliert werden kann. Die Verwendung von TypeScript bei der Entwicklung eines Apps Script-Projekts bietet folgende Vorteile:
- Automatische Vervollständigung in der lokalen IDE
- Optionale strukturelle Eingabe
- Typinferenz, Schnittstellen
- ES6-Features wie Klassen und Pfeilfunktionen
In diesem Leitfaden werden einige häufige Aufgaben bei der 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 eines der in diesem Leitfaden beschriebenen Verfahren anwenden.
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 die Verwendung von TypeScript in Apps Script zu aktivieren, wird jedoch dringend empfohlen, da es die Verfahren erheblich vereinfacht.
Bevor Sie einen der unten beschriebenen Prozesse ausführen, muss Folgendes installiert sein, um Ihre lokale Entwicklungsumgebung zu aktivieren:
- Knoten 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 von TypeScript-IDE)
Machen Sie sich mit der Dokumentation zu clasp
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 ein appsscript.json und ein Code.gs als Basis eines Apps Script-Projekts erstellt.
Wenn Sie TypeScript in einer App Script-Datei verwenden möchten, benennen Sie die Dateiendung einfach von gs in ts um.
Lokale TypeScript-Dateien bearbeiten
Mit Ihrem bevorzugten Editor können Sie lokale TypeScript-Dateien als .ts-Dateien in den 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+-Features wie Pfeilfunktionen und Stringinterpolation (${var}) schreiben. Diese Dateien werden in Apps Script-Konstrukte umgewandelt, wenn Sie das Projekt auf den Apps Script-Server übertragen.
Lokales Apps Script-Projekt hochladen, das TypeScript verwendet
Wenn Sie mit der Bearbeitung der lokalen TypeScript- und Apps Script-Dateien fertig sind, können Sie die lokalen Dateien mit dem folgenden clasp-Befehl in Google Drive hochladen:
clasp push --watch
Dieser Befehl sucht nach TypeScript-Dateiänderungen und verwendet typescript, um den Code zu kompilieren, und clasp, um das Projekt in Google Drive hochzuladen.
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 Programmfehler mit TypeScript selbst feststellen, können Sie es im GitHub-Repository von TypeScript melden.