zapięcie – interfejs wiersza poleceń Apps Script

1. Wprowadzenie

Interfejs wiersza poleceń Apps Script, czyli clasp, to narzędzie, które umożliwia tworzenie, edytowanie i wdrażanie projektów Apps Script lokalnie. Umożliwia tworzenie i publikowanie aplikacji internetowych oraz dodatków do usług takich jak Arkusze, Dokumenty, Formularze i Prezentacje z poziomu wiersza poleceń. Apps Script możesz tworzyć na 2 sposoby: na stronie script.google.com lub lokalnie na komputerze. Poznamy drugą opcję, czyli używanie clasp, narzędzia wiersza poleceń do Apps Script.

Funkcje

• Opracowuj lokalnie. clasp umożliwia pisanie kodu na własnym komputerze i przesyłanie go do Apps Script po zakończeniu pracy. Możesz też pobrać istniejące projekty Apps Script i edytować je lokalnie. Gdy kod jest już lokalny, możesz używać ulubionych narzędzi programistycznych, takich jak git, do pracy nad projektami Apps Script.
• Zarządzaj wersjami wdrożenia Tworzenie, aktualizowanie i wyświetlanie wielu wdrożeń projektu.
• Kod struktury. clasp automatycznie przekształca płaski projekt na stronie script.google.com w foldery. Na przykład:

# On script.google.com:
├── tests/slides.gs
└── tests/sheets.gs

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

Czego się nauczysz

W tym ćwiczeniu dowiesz się, jak wykonać 3 kluczowe czynności w clasp:

• Tworzenie nowych projektów Apps Script
• Klonowanie, pobieranie i przesyłanie istniejących projektów
• Jak zarządzać wdrożeniami skryptów

2. Pierwsze kroki

Pobieranie interfejsu wiersza poleceń

Interfejs wiersza poleceń Apps Script (clasp) wymaga zainstalowania Node.js. Zainstaluj Node.js.

Uwaga: clasp wymaga Node.js w wersji 20.0.0 lub nowszej. Zaktualizuj Node.js za pomocą tych poleceń:

sudo npm install n -g

sudo n latest

Po zainstalowaniu Node zainstaluj interfejs wiersza poleceń globalnie (alias clasp):

npm i @google/clasp -g

3. Włączanie interfejsu Apps Script API

Zanim zaczniesz korzystać z Clasp, musisz włączyć interfejs Apps Script API w IDE Apps Script.

4. Zaloguj się

Zaloguj się

Wypróbujmy zapięcie. Jedynym poleceniem, które musisz zapamiętać, jest clasp.

clasp

Zainstalowaliśmy clasp globalnie na naszym komputerze, więc polecenie powinno działać wszędzie w systemie plików.

Zanim zaczniemy korzystać z narzędzia wiersza poleceń, musimy się zalogować. Uruchom to polecenie:

clasp login

lub jeśli używasz SSH:

clasp login --no-localhost

W tym momencie pojawi się prośba o zalogowanie się w Google. Wszystkie projekty utworzone za pomocą interfejsu CLI są powiązane z tym kontem Google.

5. Tworzenie nowego projektu

Tworzenie samodzielnego projektu

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;

Właśnie utworzono projekt Apps Script w folderze „clasp_codelab”.

Uwaga: polecenie clasp create utworzyło samodzielny skrypt. Oznacza to, że projekt nie jest połączony z plikem Arkuszy Google, Dokumentem, Formularzem ani Prezentacją Google. W następnej sekcji wyjaśnimy, jak utworzyć skrypt powiązany.

(Opcjonalnie) Sklonuj istniejący projekt

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

Aby to zrobić, wejdź na slides.google.com i utwórz nową prezentację. Zmień nazwę prezentacji na „clasp Codelab Test”. Na pasku menu Prezentacji Google w menu Rozszerzenia wybierz „Apps Script”.

Spowoduje to otwarcie projektu Apps Script na stronie script.google.com.

Utwórz nowy katalog dla projektu i cd do niego.

mkdir clasp_codelab_test
cd clasp_codelab_test

Aby sklonować projekt, potrzebujemy Script ID. Ten identyfikator znajdziesz w adresie URL projektu Apps Script po znaku /projects/. Skopiuj wartość i wklej ją w tym poleceniu:

clasp clone <scriptID>

Dane wyjściowe powinny wyglądać tak:

Projekt został pobrany do bieżącego katalogu. Użyj ulubionego edytora, aby wyświetlić zawartość pliku Code.gs (pusta funkcja).

6. Pobieranie i przesyłanie plików

Edytowanie kodu na stronie script.google.com

Wiesz już, jak klonować projekt, więc teraz dowiesz się, jak pobierać i przesyłać pliki. Przeprowadzimy Cię przez proces edycji w chmurze za pomocą script.google.com i pobierania na komputer. Otwórzmy skrypt w chmurze:

clasp open-script

W edytorze online zmodyfikujemy kod, który później pobierzemy za pomocą clasp.

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

var world = "世界";

W pliku Code.gs zastąp istniejący kod tym:

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

U góry kliknij Zapisz .

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

W dzienniku wykonania u dołu pojawi się powitanie.

Edytowanie kodu lokalnie

Wróćmy do wiersza poleceń, w którym ostatnio sklonowaliśmy projekt. Możesz zauważyć, że nasz kod nie jest już zsynchronizowany z edytorem online. Aby to naprawić, pobierzmy kod z naszego projektu online.

clasp pull

Teraz wróć do kodu. Powinien się tam znajdować folder z naszymi narzędziami. Interfejs wiersza poleceń clasp automatycznie przekształca znak ukośnika / w foldery w lokalnym systemie plików.

W ulubionym edytorze tekstu otwórz plik util/strings.gs i zmień nazwę zmiennej world na mondo. Zaktualizuj też plik Code.gs, zastępując world wartością mondo. Aby zaktualizować kod na stronie script.google.com, prześlij zmodyfikowany kod.

clasp push

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

clasp push zastępuje kod w script.google.com, a clasp pull zastępuje wszystkie pliki lokalnie. Dlatego postępuj zgodnie z tymi wskazówkami:

• Nie edytuj jednocześnie kodu lokalnie i na stronie script.google.com.
• Używaj systemu kontroli wersji, np. git.

7. Wersjonowanie i wdrażanie

clasp umożliwia zarządzanie wersjami i wdrożeniami. Najpierw kilka słów:

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

Utwórzmy wersję skryptu:

clasp create-version "First version"

Używając ciągu tekstowego zalogowanej wersji, który utworzyliśmy zamiast [version], możemy wdrożyć skrypt:

clasp create-deployment 1 "First deployment"

Polecenie clasp deploy sprawdza manifest i tworzy nowe wdrożenie z określoną wersją. Twój kod został wdrożony jako plik wykonywalny. Więcej informacji znajdziesz w przewodniku po wdrożeniach.

8. To wszystko.

Mamy nadzieję, że interfejs CLI Apps Script będzie prostym narzędziem do zarządzania projektami Apps Script.

Omówione zagadnienia

• Tworzenie nowych projektów Apps Script
• Klonowanie, przesyłanie i pobieranie istniejących projektów
• Jak zarządzać wdrożeniami skryptów

Clasp jest dostępny na GitHub. Możesz zgłaszać nowe funkcje i poprawki.

Nie możemy się doczekać, co stworzysz.