застежка — интерфейс командной строки сценариев приложений

1. Введение

Интерфейс командной строки Apps Script, или clasp , — это инструмент, который позволяет создавать, редактировать и развертывать проекты Apps Script локально. Он позволяет создавать и публиковать веб-приложения и надстройки для таких продуктов, как Таблицы, Документы, Формы и Презентации, из командной строки. Существует два способа разработки Apps Script: с помощью script.google.com или локально на вашем компьютере. Последнее мы изучим, как использовать clasp , инструмент командной строки для Apps Script.

Функции

  • Развивайтесь локально. clasp позволяет вам писать код на своем компьютере и загружать его в Apps Script, когда вы закончите. Вы также можете скачать существующие проекты Apps Script, а затем редактировать их локально. Как только код станет локальным, вы сможете использовать свои любимые инструменты разработки, такие как git, для работы над проектами Apps Script.
  • Управление версиями развертывания . Создавайте, обновляйте и просматривайте несколько развертываний вашего проекта.
  • Структурный код. clasp автоматически преобразует ваш плоский проект на script.google.com в папки . Например: 
# On script.google.com:
├── tests/slides.gs
└── tests/sheets.gs

# Locally:
├── tests/
│   ├─ slides.gs
│   └─ sheets.gs

Что вы узнаете

В этой кодовой лаборатории показано, как выполнить три ключевых действия с помощью clasp :

  • Как создавать новые проекты Apps Script
  • Как клонировать, извлекать и отправлять существующие проекты
  • Как управлять развертыванием ваших скриптов

2. Начало работы

Загрузка интерфейса командной строки

Интерфейс командной строки Apps Script ( clasp ) требует установки Node.js >= v6.0.0. Установите Node.js здесь .

Если у вас есть Node, установите CLI глобально (псевдоним clasp ): 

npm i @google/clasp -g

3. Войти

Авторизоваться

Давайте попробуем застежку ! Единственная команда, которую вам следует запомнить, — это clasp .

clasp

Прежде чем мы начнем использовать инструмент командной строки, мы должны войти в систему. Запустите эту команду:

clasp login

или если вы используете SSH:

clasp login --no-localhost

На этом этапе вам будет предложено войти в Google. Любые проекты, которые вы создаете с помощью CLI, связаны с этой учетной записью Google.

4. Создайте новый проект

Создать автономный проект

Начните с создания автономного проекта Google Apps Script с помощью следующей команды:

mkdir clasp_codelab;
cd clasp_codelab;
clasp create --title "Clasp Codelab"  --type standalone;

Вы только что создали проект сценария приложений в папке «clasp_codelab»!

(Необязательная альтернатива) Клонировать существующий проект.

Давайте попробуем создать привязанный к контейнеру скрипт для надстройки Google Slides.

Для этого перейдите на сайтlides.google.com и создайте новую презентацию. Измените имя презентации на « clasp Codelab Test ». В заголовке в разделе «Инструменты» нажмите «Редактор сценариев...» .

Откроется ваш проект Apps Script по адресу script.google.com . Чтобы клонировать проект, нам понадобится Script ID . Этот идентификатор можно найти в URL-адресе проекта Apps Script после /projects/ . Скопируйте значение и вставьте его в следующую команду:

clasp clone <scriptID>

Вывод должен выглядеть так...

4e3b128f4dcf6467.gif

Теперь вы загрузили проект в свой текущий каталог . Используйте свой любимый редактор для просмотра содержимого Code.gs (пустая функция).

5. Извлечение и пересылка файлов

Измените код на сайте script.google.com.

Теперь, когда вы можете клонировать проект, давайте научимся извлекать и отправлять файлы. Мы покажем вам, как редактировать данные в облаке через script.google.com и переносить их локально на свой компьютер. Откроем скрипт в облаке:

clasp open

Теперь, когда мы находимся в онлайн-редакторе, мы отредактируем онлайн некоторый код, который позже получим с помощью clasp .

Чтобы создать новый файл Apps Script, в левой части редактора рядом с пунктом «Файлы» нажмите «Добавить файл». добавить файл > Скрипт . Введите имя utils/strings . Во вновь созданном файле utils/strings.gs замените код следующим:

var world = "世界";

В Code.gs замените существующий код следующим:

function hello() {
  Logger.log("Hello, " + world);
}

Вверху нажмите Сохранить сохранять .

Чтобы запустить функцию, в верхней части редактора выберите hello из раскрывающегося списка функций и нажмите « Выполнить» .

Приветствие отображается внизу журнала выполнения.

Редактировать код локально

Давайте вернемся к командной строке, в которой мы в последний раз клонировали проект. Вы можете заметить, что наш код теперь не синхронизирован с онлайн-редактором. Чтобы это исправить, давайте возьмем код из нашего онлайн-проекта.

clasp pull

Теперь вернитесь к коду. Вы должны заметить, что здесь есть папка для наших утилит. Интерфейс командной строки clasp автоматически преобразует символ косой черты / в папки локальной файловой системы.

В вашем любимом текстовом редакторе перейдите к util/strings.gs и замените имя переменной world на mondo . Также обновите Code.gs, заменив world на mondo . Чтобы обновить обновленный код на script.google.com , отправьте отредактированный код.

clasp push

И все! Ваш код теперь обновлен на script.google.com .

6. Управление версиями и развертывание

clasp позволяет вам управлять версиями и развертываниями. Для начала немного словарного запаса:

  • Версия : «Моментальный снимок» проекта сценария. Версией можно считать ветвь, доступную только для чтения, используемую для развертываний.
  • Развертывание : опубликованный выпуск проекта сценария (часто в виде надстройки или веб-приложения). Требуется номер версии.

Давайте создадим версию нашего скрипта:

clasp version "First version"

Используя строку зарегистрированной версии, которую мы создали вместо [version] , мы можем развернуть скрипт:

clasp deploy 1 "First deployment"

Команда clasp deploy просматривает ваш манифест и создает новую версию развертывания. Теперь ваш код развернут как исполняемый файл. Подробнее об этом читайте в руководстве по развертыванию .

7. Вот и все!

Мы надеемся, что интерфейс командной строки Apps Script — это простой инструмент, который поможет вам управлять проектами Apps Script.

Что мы рассмотрели

  • Как создавать новые проекты Apps Script
  • Как клонировать, отправлять и извлекать существующие проекты
  • Как управлять развертыванием ваших скриптов

Clasp доступен на GitHub и приветствует новые функции и исправления.

Нам не терпится увидеть, что вы создадите!