TypeScript — это типизированный расширенный набор JavaScript, который можно скомпилировать в простой скрипт приложений. Используя TypeScript при разработке проекта Apps Script, вы получаете следующие преимущества:
- Локальное автозаполнение IDE
- Необязательная структурная типизация
- Вывод типа , интерфейсы
- Возможности ES6, такие как классы и стрелочные функции .
В этом руководстве рассматриваются некоторые распространенные задачи по разработке проекта Apps Script с помощью TypeScript.
Требования
Если вы не знакомы с TypeScript, просмотрите документацию TypeScript и краткое руководство по TypeScript, чтобы ознакомиться с основными понятиями, прежде чем приступать к выполнению любой из процедур, описанных в этом руководстве.
Для использования TypeScript в проектах Apps Script с clasp требуются следующие инструменты. Хотя использование clasp не является строго необходимым для включения использования TypeScript в Apps Script, оно настоятельно рекомендуется, поскольку оно значительно упрощает процедуры.
Прежде чем приступать к любому из процессов, описанных ниже, убедитесь, что вы установили следующее, чтобы включить локальную среду разработки:
- Узел и npm
-
clasp:npm install -g @google/clasp - Определения типов для скрипта приложений :
npm i -S @types/google-apps-script - Код Visual Studio (для автодополнения TypeScript IDE)
Обязательно ознакомьтесь с документацией clasp , если вы ранее не использовали clasp .
Использование TypeScript в проекте Clasp
Вы можете использовать clasp для быстрого создания нового локального проекта Apps Script . Эта команда создает файлы appsscript.json и Code.gs , основу проекта Apps Script.
Чтобы использовать TypeScript в файле App Script, просто переименуйте расширение файла с gs на ts .
Редактировать локальные файлы TypeScript
Используя предпочитаемый вами редактор, вы можете писать локальные файлы TypeScript как файлы .ts в папке проекта.
Например, файл с именем index.ts может содержать следующий код TypeScript:
const greeter = (person: string) => {
return `Hello, ${person}!`;
}
let user = 'Grant';
Logger.log(greeter(user));
Вы можете писать TypeScript с такими функциями ES6+, как стрелочные функции и интерполяция строк ( ${var} ). Эти файлы передаются в конструкции Apps Script, когда вы отправляете проект на сервер Apps Script.
Загрузите локальный проект Apps Script, использующий TypeScript.
Завершив редактирование локальных файлов TypeScript и Apps Script, вы можете загрузить локальные файлы на Google Диск с помощью следующей команды clasp :
clasp push --watch
Эта команда отслеживает изменения файла TypeScript и использует typescript для компиляции кода и clasp для загрузки проекта на Google Диск.
Сообщить о проблемах или запросить функцию файла
Если вы столкнулись с проблемой при работе с инструментом clasp , вы можете сообщить об этом на GitHub .
Если вы столкнулись с проблемой или ошибкой в самом TypeScript, вы можете сообщить об этом в репозитории TypeScript на GitHub .