Utilizzare l'interfaccia a riga di comando con la fibbia

Per sviluppare e gestire progetti Apps Script dal terminale anziché dall'editor di Apps Script, puoi utilizzare uno strumento open source chiamato clasp.

Il codelab clasp fornisce una panoramica di tutte le funzionalità di clasp.

Funzionalità

Sviluppare localmente

clasp ti consente di sviluppare i tuoi progetti Apps Script a livello locale. Puoi scrivere il codice sul tuo computer e caricarlo in Apps Script al termine. Puoi anche scaricare progetti Apps Script esistenti per modificarli quando sei offline. Poiché il codice è locale, puoi utilizzare i tuoi strumenti di sviluppo preferiti come git per creare progetti Apps Script.

Gestire le versioni di deployment

Crea, aggiorna e visualizza i vari deployment del tuo progetto.

Codice struttura

clasp ti consente di organizzare il codice in directory, che vengono conservate quando le carichi su script.google.com. Ad esempio:

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

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

Requisiti

clasp è scritto in Node.js e distribuito tramite lo strumento npm. Prima di utilizzare clasp, devi avere installato la versione 4.7.4 o successiva di Node.js. L'installazione di Node.js richiede privilegi amministrativi.

Installazione

Dopo aver installato Node.js, puoi utilizzare il seguente comando npm per installare clasp:

npm install @google/clasp -g

Dopo l'installazione, puoi utilizzare il comando clasp da qualsiasi directory sul computer.

In uso: clasp

Puoi utilizzare clasp per gestire una serie di attività dalla riga di comando. Questa sezione descrive le operazioni comuni che puoi utilizzare durante lo sviluppo con clasp.

Accedi

Questo comando consente di accedere e autorizzare la gestione dei progetti Apps Script del tuo Account Google. Una volta eseguito, ti viene chiesto di accedere a un account Google in cui sono archiviati i tuoi progetti Apps Script.

clasp login

Esci

Questo comando consente di uscire dallo strumento a riga di comando. Devi accedere di nuovo utilizzando clasp login per autenticarti di nuovo con Google prima di continuare a utilizzare clasp.

clasp logout

Crea un nuovo progetto Apps Script

Questo comando crea un nuovo script nella directory corrente con un titolo facoltativo.

clasp create [scriptTitle]

Questo comando crea anche due file nella directory corrente:

  • Un file .clasp.json che memorizza l'ID script.
  • Un file manifest del progetto appsscript.json contenente i metadati del progetto.

Clonare un progetto esistente

Questo comando clona un progetto esistente nella directory corrente. Lo script deve essere creato o condiviso con il tuo Account Google. Specifica il progetto di script da clonare fornendo il relativo ID script.

Per trovare l'ID script del progetto:

  1. Apri il progetto Apps Script.
  2. A sinistra, fai clic su Impostazioni progetto .

  3. In ID, copia l'ID script.

     clasp clone <scriptId>

Scaricare un progetto di script

Questo comando scarica il progetto di Apps Script da Google Drive nel file system del computer.

clasp pull

Caricare un progetto di script

Questo comando carica tutti i file di un progetto di script dal computer su Google Drive.

clasp push

Elenco delle versioni del progetto

Questo comando elenca il numero e la descrizione di ciascuna delle versioni di un progetto di script.

clasp versions

Eseguire il deployment di un progetto pubblicato

Puoi eseguire il deployment dei progetti di script come app web, componenti aggiuntivi o eseguibili. Puoi creare deployment nell'editor di script, nel manifest del progetto o utilizzando clasp.

Per eseguire il deployment di un progetto con clasp, crea prima una versione immutabile del progetto Apps Script. Una versione è uno "snapshot" di un progetto di script ed è simile a una release con branch di sola lettura.

clasp version [description]

Questo comando mostra il numero della versione appena creata. Utilizzando questo numero, puoi eseguire il deployment e il dis-deployment delle istanze del tuo progetto:

clasp deploy [version] [description]
clasp undeploy <deploymentId>

Questo comando aggiorna un deployment esistente con una nuova versione e descrizione:

clasp redeploy <deploymentId> <version> <description>

Elenca implementazioni

Questo comando elenca gli ID deployment, le versioni e le relative descrizioni del progetto di script.

clasp deployments

Apri il progetto nell'editor di Apps Script

Questo comando apre un progetto di script nell'editor di Apps Script. L'editor viene avviato come nuova scheda nel browser web predefinito.

clasp open

Contribuire al progetto open source clasp

Contribuisci a clasp su GitHub.