zapięcie – interfejs wiersza poleceń Apps Script

1. Wprowadzenie

Interfejs wiersza poleceń Apps Script (clasp) to narzędzie umożliwiające tworzenie, edytowanie i wdrażanie projektów Apps Script. Pozwala tworzyć i publikować aplikacje internetowe oraz dodatki do usług takich jak Arkusze, Dokumenty, Formularze i Prezentacje za pomocą wiersza poleceń. Apps Script można tworzyć na dwa sposoby: za pomocą Script.google.com lub lokalnie na komputerze. Zapoznamy się z tą ostatnią funkcją: jak używać clasp – narzędzia wiersza poleceń Apps Script.

Funkcje

  • Działaj lokalnie. clasp umożliwia pisanie kodu na własnym komputerze i przesyłanie go do Apps Script. Możesz też pobrać istniejące projekty Apps Script i edytować je lokalnie. Gdy kod będzie dostępny lokalnie, możesz używać swoich ulubionych narzędzi dla programistów, takich jak git, do pracy nad projektami Apps Script.
  • Zarządzanie wersjami wdrożenia Twórz, aktualizuj i wyświetlaj wiele wdrożeń projektu.
  • Kod struktury. clasp automatycznie konwertuje płaski projekt na script.google.com na foldery. Na przykład:
# On script.google.com:
├── tests/slides.gs
└── tests/sheets.gs

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

Czego się nauczysz

Dzięki temu ćwiczeniu w Codelabs dowiesz się, jak za pomocą narzędzia clasp wykonać 3 kluczowe działania:

  • Jak tworzyć nowe projekty Apps Script
  • Jak klonować, pobierać i przekazywać istniejące projekty
  • Jak zarządzać wdrożeniami skryptów

2. Pierwsze kroki

Pobieram interfejs wiersza poleceń

Interfejs wiersza poleceń Apps Script (clasp) wymaga zainstalowania środowiska Node.js w wersji 6.0.0 w wersji 6.0.0. Zainstaluj Node.js tutaj.

Gdy masz już węzeł, zainstaluj interfejs wiersza poleceń globalnie (alias clasp):

npm i @google/clasp -g

3. Zaloguj się

Zaloguj się

Wypróbujmy zapięcie. Jedyne polecenie, które musisz zapamiętać, to clasp.

clasp

Zanim zaczniemy używać narzędzia wiersza poleceń, musimy się zalogować. Uruchom to polecenie:

clasp login

lub SSH:

clasp login --no-localhost

W tym momencie pojawi się prośba o zalogowanie się na konto Google. Wszystkie projekty utworzone przez Ciebie za pomocą interfejsu wiersza poleceń są powiązane z tym kontem Google.

4. Utwórz nowy projekt

Utwórz samodzielny projekt

Zacznij od utworzenia samodzielnego projektu Google Apps Script za pomocą tego polecenia:

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

Udało Ci się utworzyć projekt Apps Script w folderze „clasp_codelab”.

(Opcjonalnie) Klonowanie istniejącego projektu

Spróbujmy utworzyć skrypt powiązany z kontenerem dla dodatku do Prezentacji Google.

Aby to zrobić, otwórz stronę slides.google.com i utwórz nową prezentację. Zmień nazwę prezentacji na „clasp Codelab Test”. W sekcji Narzędzia w nagłówku kliknij Edytor skryptów...

Spowoduje to otwarcie projektu Apps Script na stronie script.google.com. Aby skopiować projekt, potrzebujemy Script ID. Znajdziesz ten identyfikator w adresie URL projektu Apps Script po /projects/. Skopiuj wartość i wklej ją w tym poleceniu:

clasp clone <scriptID>

Dane wyjściowe powinny wyglądać tak...

4e3b128f4dcf6467.gif

Udało Ci się pobrać projekt z bieżącego katalogu. Użyj swojego ulubionego edytora, aby wyświetlić zawartość funkcji Code.gs (pustej funkcji).

5. Zaciąganie i Przekazywanie plików

Edytuj kod na script.google.com

Po skopiowaniu projektu dowiedz się, jak pobierać i wypychać pliki. Przeprowadzimy Cię przez wszystkie etapy edytowania pliku w chmurze przez script.google.com i pobierania na Twój komputer. Otwórzmy skrypt w chmurze:

clasp open

Edytor online edytujemy teraz kod online, który zostanie pobrany później za pomocą funkcji clasp.

Aby utworzyć nowy plik Apps Script, po lewej stronie edytora obok opcji Pliki kliknij Dodaj plik dodaj plik > Skrypt. Wpisz nazwę utils/strings. W nowo utworzonym pliku utils/strings.gs zastąp kod następującym:

var world = "世界";

W programie Code.gs zastąp istniejący kod następującym:

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

U góry kliknij Zapisz zapisz.

Aby uruchomić funkcję, u góry edytora wybierz hello z listy funkcji i kliknij Uruchom.

Powitanie pojawi się na dole dziennika wykonywania.

Edytuj kod lokalnie

Wróćmy do wiersza poleceń, gdzie ostatnio sklonowano projekt. Możesz zauważyć, że nasz kod nie jest teraz zsynchronizowany z edytorem online. Aby rozwiązać ten problem, pobierz kod z naszego projektu online.

clasp pull

Teraz wróć do kodu. Powinien być tam folder zawierający nasze narzędzia. Interfejs wiersza poleceń clasp automatycznie konwertuje ukośnik / na foldery w lokalnym systemie plików.

W ulubionym edytorze tekstu przejdź do strony util/strings.gs i zastąp nazwę zmiennej world nazwą mondo. Zaktualizuj też Code.gs, zastępując world na mondo. Aby zaktualizować zaktualizowany kod na stronie script.google.com, przekaż zmieniony kod.

clasp push

To wszystko. Twój kod został zaktualizowany script.google.com.

6. Obsługa wersji i wdrażanie

clasp umożliwia zarządzanie wersjami i wdrożeniami. Na początek trochę słownictwa:

  • Wersja: „zrzut”. w ramach projektu skryptu. Wersję można uznać za gałąź tylko do odczytu używaną na potrzeby wdrożeń.
  • Wdrożenie: opublikowana wersja projektu skryptu (często jako dodatek lub aplikacja internetowa). Wymaga numeru wersji.

Utwórzmy wersję naszego skryptu:

clasp version "First version"

Korzystając z ciągu znaków wersji zapisanej, który utworzyliśmy zamiast [version], możemy wdrożyć skrypt:

clasp deploy 1 "First deployment"

Polecenie clasp deploy analizuje plik manifestu i tworzy nowe wdrożenie z różnymi wersjami. Twój kod został wdrożony jako wykonywalny. Więcej informacji znajdziesz w przewodniku po wdrożeniach.

7. Znakomicie.

Mamy nadzieję, że interfejs wiersza poleceń Apps Script jest prostym narzędziem, które ułatwi Ci zarządzanie projektami Apps Script.

Omówione zagadnienia

  • Jak tworzyć nowe projekty Apps Script
  • Jak klonować, przenosić i pobierać istniejące projekty
  • Jak zarządzać wdrożeniami skryptów

Aplikacja Clasp jest dostępna na GitHub i wraz z nowymi funkcjami oraz poprawkami.

Chętnie zobaczymy, co stworzysz!