TypeScript — это типизированное надмножество JavaScript, которое можно компилировать в обычный Apps Script. Использование 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 - Определения типов для Apps Script :
npm i -S @types/google-apps-script - Visual Studio Code (для автодополнения 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 .