使用 TypeScript 開發 Apps Script

TypeScript 是 JavaScript 的類型化超集合,可編譯為純 Apps Script。在 Apps Script 專案開發作業中使用 TypeScript,可享有下列優點:

本指南將介紹使用 TypeScript 開發 Apps Script 專案時的常見工作。

需求條件

如果您不熟悉 TypeScript,請先參閱 TypeScript 說明文件TypeScript 快速入門,熟悉基本概念,再嘗試執行本指南所述的任何程序。

如要在 Apps Script 專案中使用 clasp 的 TypeScript,必須使用下列工具。雖然在 Apps Script 中啟用 TypeScript 功能不一定要使用 clasp,但我們強烈建議您使用 clasp,因為這樣可以大幅簡化程序。

在嘗試下列任何程序之前,請務必先安裝下列項目,啟用本機開發環境:

如果您之前未曾使用 clasp,請務必熟悉 clasp 說明文件

在 Clasp 專案中使用 TypeScript

您可以使用 clasp 快速建立新的本機 Apps Script 專案。這個指令會建立 appsscript.jsonCode.gs,這是 Apps Script 專案的基礎。

如要在 Apps Script 檔案中使用 TypeScript,只要將檔案副檔名從 gs 重新命名為 ts 即可。

編輯本機 TypeScript 檔案

您可以使用偏好的編輯器,將本機 TypeScript 檔案寫入專案資料夾中的 .ts 檔案。

舉例來說,名為 index.ts 的檔案可能包含下列 TypeScript 程式碼:

const greeter = (person: string) => {
  return `Hello, ${person}!`;
}

let user = 'Grant';
Logger.log(greeter(user));

您可以使用 ES6+ 功能 (例如箭頭函式和字串插補 (${var})) 編寫 TypeScript。當您將專案推送至 Apps Script 伺服器時,這些檔案會轉譯為 Apps Script 結構。

上傳使用 TypeScript 的本機 Apps Script 專案

編輯本機 TypeScript 和 Apps Script 檔案後,您可以使用下列 clasp 指令將本機檔案上傳至 Google 雲端硬碟:

clasp push --watch

這個指令會監控 TypeScript 檔案變更,並使用 typescript 編譯程式碼,以及使用 clasp 將專案上傳至 Google 雲端硬碟。

回報問題或提出功能要求

如果您在使用 clasp 工具時遇到問題,可以前往 GitHub 回報。

如果您遇到 TypeScript 本身的問題或錯誤,可以前往 TypeScript 的 GitHub 存放區回報。