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, profitieren Sie von folgenden Vorteilen:
- Automatische Vervollständigung in der lokalen IDE
- Optional: Strukturelle Typisierung
- Typinferenz, Schnittstellen
- ES6-Funktionen wie Klassen und Pfeilfunktionen.
In dieser Anleitung werden einige häufige Aufgaben für die Entwicklung eines Apps Script-Projekts mit TypeScript beschrieben.
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 versuchen, die in diesem Leitfaden beschriebenen Verfahren auszufü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 aktivieren, wird aber dringend empfohlen, da sie die Verfahren erheblich vereinfacht.
Bevor Sie eines der unten beschriebenen Verfahren ausprobieren, 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)
Wenn Sie clasp
noch nicht verwendet haben, sollten Sie sich unbedingt mit der clasp
-Dokumentation
vertraut machen.
TypeScript in einem Clasp-Projekt verwenden
Mit clasp
können Sie schnell ein neues lokales Apps Script-Projekt erstellen.
Mit diesem Befehl werden die Dateien appsscript.json
und Code.gs
erstellt, die die Grundlage eines Apps Script-Projekts bilden.
Wenn Sie TypeScript in einer App Script-Datei verwenden möchten, benennen Sie einfach die Dateiendung von gs
in ts
um.
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+-Funktionen wie Pfeilfunktionen und String-Interpolation (${var}
) schreiben. Diese Dateien werden in Apps Script-Konstrukte transpiliert, wenn Sie das Projekt auf den Apps Script-Server übertragen.
Lokales Apps Script-Projekt hochladen, das TypeScript verwendet
Wenn Sie die Bearbeitung der lokalen TypeScript- und Apps Script-Dateien abgeschlossen haben, können Sie die lokalen Dateien mit dem folgenden clasp
-Befehl in Google Drive hochladen:
clasp push --watch
Dieser Befehl überwacht Änderungen an TypeScript-Dateien und verwendet typescript
, um den Code zu kompilieren, und clasp
, um das Projekt in Google Drive hochzuladen.
Probleme melden oder Funktionsanfragen einreichen
Wenn Sie ein Problem mit dem Tool clasp
haben, 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.