Korzystanie z interfejsu wiersza poleceń za pomocą narzędzia clasp

Aby tworzyć projekty Google Apps Script i zarządzać nimi z poziomu terminala, a nie edytora skryptów Apps Script, użyj narzędzia open source clasp.

W claspcodelabie znajdziesz omówienie wszystkich funkcji clasp.

Funkcje

clasp zawiera następujące funkcje:

Opracowywanie lokalne

clasp umożliwia tworzenie projektów Apps Script lokalnie. Pisz kod na własnym komputerze i przesyłaj go do Apps Script po zakończeniu. Możesz też pobrać istniejące projekty Apps Script, aby edytować je offline. Podczas tworzenia projektów Apps Script możesz korzystać z ulubionych narzędzi programistycznych, takich jak git.

Zarządzanie wersjami wdrożenia

Tworzenie, aktualizowanie i wyświetlanie wielu wdrożeń projektu.

Kod struktury

clasp umożliwia porządkowanie kodu w katalogach, które są zachowywane po przesłaniu go na stronę script.google.com. Przykład:

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

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

Typy projektów

Za pomocą clasp możesz zarządzać zarówno samodzielnymi projektami skryptów, jak i projektami skryptów powiązanymi z kontenerem.

Projekty samodzielne

Samodzielny projekt jest wyświetlany jako osobny plik na Dysku Google. Nowy samodzielny skrypt możesz utworzyć za pomocą polecenia clasp create.

Projekty powiązane z kontenerem

Projekt powiązany z kontenerem jest dołączony do pliku Dokumentów Google, Arkuszy, Prezentacji lub Formularzy Google. Możesz utworzyć nowy skrypt powiązany z kontenerem, który będzie dołączony do nowego pliku, za pomocą polecenia clasp create. Możesz też dołączyć nowy skrypt do istniejącego pliku za pomocą flagi --parentId.

Inne typy projektów

clasp umożliwia też tworzenie skryptów do aplikacji internetowych i interfejsów API.

Wymagania

clasp jest napisany w Node.js i dystrybuowany za pomocą narzędzia npm. Zanim zaczniesz korzystać z clasp, musisz mieć zainstalowaną wersję 20.0.0 lub nowszą środowiska Node.js. Instalacja Node.js wymaga uprawnień administracyjnych.

Instalacja

Po zainstalowaniu Node.js użyj tego polecenia npm, aby zainstalować clasp:

npm install @google/clasp -g

Po zainstalowaniu użyj polecenia clasp z dowolnego katalogu na komputerze.

Używaj funkcji clasp

Używaj clasp do wykonywania różnych zadań z poziomu wiersza poleceń. W tej sekcji opisujemy typowe operacje, które można wykonywać podczas tworzenia aplikacji z użyciem clasp.

Zaloguj się

To polecenie loguje Cię i autoryzuje zarządzanie projektami Apps Script na Twoim koncie Google. Po uruchomieniu pojawi się prośba o zalogowanie się na konto Google, na którym są przechowywane projekty Apps Script.

clasp login

Wyloguj się

To polecenie powoduje wylogowanie z narzędzia wiersza poleceń. Zaloguj się ponownie za pomocą clasp login, aby ponownie uwierzytelnić się w Google, zanim zaczniesz dalej korzystać z clasp.

clasp logout

Tworzenie nowego projektu Apps Script

To polecenie tworzy w bieżącym katalogu nowy skrypt z opcjonalnym tytułem.

clasp create [scriptTitle] [--type <projectType>] [--parentId <parentId>]

To polecenie używa tych opcjonalnych parametrów:

  • scriptTitle: tytuł projektu skryptu.
  • --type <projectType>: typ projektu do utworzenia. Dozwolone wartości to standalone, docs, sheets, slides, forms, webapp i api.
  • --parentId <parentId>: identyfikator istniejącego pliku na Dysku Google (Dokumentów, Arkuszy, Prezentacji lub Formularzy), z którym ma być powiązany nowy projekt skryptu.

To polecenie tworzy też w bieżącym katalogu 2 pliki:

  • Plik .clasp.json zawierający identyfikator skryptu.
  • appsscript.json plik manifestu projektu zawierający metadane projektu;

Klonowanie istniejącego projektu

To polecenie klonuje istniejący projekt w bieżącym katalogu. Skrypt musi zostać utworzony lub udostępniony na Twoim koncie Google. Projekt skryptu do sklonowania określa się, podając jego identyfikator. Możesz klonować zarówno samodzielne projekty, jak i projekty powiązane z kontenerem.

Aby znaleźć identyfikator skryptu projektu:

  1. Otwórz projekt Apps Script.
  2. Po lewej stronie kliknij Ustawienia projektu .

  3. W sekcji Identyfikatory skopiuj Identyfikator skryptu.

    klon zapięcia