TypeScript 是 JavaScript 的類型化超集合,可編譯為純 Apps Script。在開發 Apps Script 專案時使用 TypeScript,可享有下列好處:
本指南涵蓋使用 TypeScript 開發 Apps Script 專案時的一些常見工作。
需求條件
如果您不熟悉 TypeScript,請先參閱 TypeScript 說明文件和 TypeScript 快速入門指南,瞭解基本概念,再嘗試執行本指南所述的任何程序。
如要在 Apps Script 專案中使用 TypeScript,必須搭配 clasp
使用下列工具。雖然使用 clasp
並非在 Apps Script 中啟用 TypeScript 的必要條件,但我們強烈建議您使用,因為這樣可大幅簡化程序。
按照下列任何一項程序操作前,請務必先安裝下列項目,啟用本機開發環境:
- Node 和 npm
clasp
:npm install -g @google/clasp
- Apps Script 的型別定義:
npm i -S @types/google-apps-script
- Visual Studio Code (適用於 TypeScript IDE 自動完成功能)
如果您先前未使用過 clasp
,請務必先詳閱clasp
說明文件
。
在 Clasp 專案中使用 TypeScript
您可以使用 clasp
快速建立新的本機 Apps Script 專案。這個指令會建立 appsscript.json
和 Code.gs
,也就是 Apps Script 專案的基礎。
如要在 App 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 存放區中回報。