fibbia - L'interfaccia a riga di comando di Apps Script

L'interfaccia a riga di comando di Apps Script, o clasp, è uno strumento che ti consente di creare, modificare ed eseguire il deployment dei progetti di Apps Script localmente. Consente di creare e pubblicare applicazioni web e componenti aggiuntivi per prodotti quali Fogli, Documenti, Moduli e Presentazioni dalla riga di comando. Puoi sviluppare Apps Script in due modi utilizzando script.google.com o in locale sul tuo computer. Impareremo quest'ultimo, come utilizzare clasp, lo strumento a riga di comando per Apps Script.

Funzionalità

  • Sviluppa a livello locale. clasp consente di scrivere codice sul tuo computer e di caricarlo in Apps Script quando hai finito. Puoi anche scaricare i progetti Apps Script esistenti e poi modificarli localmente. Una volta che il codice è locale, puoi utilizzare i tuoi strumenti di sviluppo preferiti, come git, per lavorare su progetti Apps Script.
  • Gestisci le versioni del deployment. Crea, aggiorna e visualizza più deployment del progetto.
  • Codice struttura. clasp converte automaticamente il tuo progetto semplice su script.google.com in cartelle. Ad esempio:
# On script.google.com:
├── tests/slides.gs
└── tests/sheets.gs

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

Obiettivi didattici

Questo codelab ti mostrerà come svolgere tre attività chiave con clasp:

  • Come creare nuovi progetti Apps Script
  • Come clonare, eseguire il pull e il push dei progetti esistenti
  • Come gestire i deployment degli script

Download dell'interfaccia a riga di comando

L'interfaccia a riga di comando di Apps Script (clasp) richiede Node.js >= v6.0.0 per essere installata. Installa Node.js qui.

Una volta creato il nodo, installa l'interfaccia a riga di comando in tutto il mondo (fibbia alias):

npm i @google/clasp -g

Accedi

Prova la fibbia. L'unico comando che ricordi è clasp.

clasp

Prima di iniziare a utilizzare lo strumento a riga di comando, dobbiamo accedere. Esegui questo comando:

clasp login

A questo punto, ti verrà chiesto di accedere a Google. Tutti i progetti creati con l'interfaccia a riga di comando sono associati a questo Account Google.

Creare un progetto autonomo

Per iniziare, crea un progetto autonomo di Google Apps Script con il comando seguente:

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

Hai appena creato un progetto Apps Script nella cartella "quosp;clasp_codelab"!

(Facoltativo) Clona un progetto esistente

Prova a creare uno script container-bound per un componente aggiuntivo di Presentazioni Google.

Per farlo, vai a slides.google.com e crea una nuova presentazione. Cambia il nome della presentazione in "clasp Codelab Test". Nell'intestazione, sotto Strumenti, premi Script Editor....

Il tuo progetto Apps Script verrà aperto all'indirizzo script.google.com. Per clonare un progetto, dobbiamo trovare l'icona Script ID. Puoi trovare questo valore andando a File > Proprietà del progetto > Informazioni > ID script (questo valore è disponibile anche nell'URL). Copia il valore e incollalo nel seguente comando:

clasp clone <scriptID>

L'output dovrebbe avere il seguente aspetto...

Ora che hai scaricato il progetto nella tua directory attuale, Utilizza il tuo editor preferito per visualizzare i contenuti di Code.gs (una funzione vuota).

Modifica il codice su script.google.com

Ora che sei in grado di clonare un progetto, scopriamo come eseguire il pull e il push dei file. Ti guideremo attraverso la procedura per la modifica nel cloud tramite script.google.com e ti reindirizzeremo localmente al tuo computer. Apriamo lo script nel cloud:

clasp open

Ora che disporremo l'editor online, modificheremo il codice online che recuperiremo in un secondo momento utilizzando clasp.

Nell'editor, crea un nuovo file scegliendo File > Nuovo > file script. Inserisci il nome utils/strings. Nel file appena creato, utils/strings.gs, sostituisci il codice con il seguente:

var world = "世界";

In Code.gs, sostituisci il codice esistente con il seguente:

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

Assicurati di salvare tutti i file. Prova a eseguire la funzione premendo Run > Run function > hello.

Vai su View > Logs per visualizzare l'annuncio.

Modifica il codice localmente

Torniamo alla riga di comando in cui abbiamo clonato l'ultima volta il progetto. Potresti notare che il nostro codice non è sincronizzato con l'editor online. Per risolvere il problema, proviamo a estrarre il codice dal nostro progetto online.

clasp pull

Ora torna al codice. Dovresti notare una cartella per i nostri utilità. L'interfaccia a riga di comando clasp converte automaticamente la barra / in cartelle del file system locale.

Nell'editor di testo che preferisci, vai a util/strings.gs e sostituisci il nome della variabile world a mondo. Inoltre, aggiorna il codice code.gs sostituendo world con mondo. Per aggiornare il codice aggiornato, vai al codice script.google.com.

clasp push

e il gioco è fatto. Il tuo codice è stato aggiornato il giorno script.google.com.

clasp consente di gestire versioni e deployment. Innanzitutto, un po' di vocabolario:

  • Versione: un'istantanea di un progetto di script. Una versione può essere considerata un ramo di sola lettura utilizzato per i deployment.
  • Deployment: una versione pubblicata di un progetto di script (spesso come componente aggiuntivo o app web). Richiede un numero di versione.

Creiamo una versione del nostro script:

clasp version "First version"

Utilizzando la stringa della versione registrata che abbiamo creato al posto di [version], possiamo eseguire il deployment dello script:

clasp deploy 1 "First deployment"

Il comando clasp deploy analizza il manifest e crea un nuovo deployment con versione. viene eseguito il deployment del codice come eseguibile. Scopri di più a riguardo nella guida ai deployment.

Ci auguriamo che l'interfaccia a riga di comando di Apps Script sia uno strumento semplice per la gestione dei progetti Apps Script.

Cosa abbiamo trattato

  • Come creare nuovi progetti Apps Script
  • Come clonare, eseguire il push e il pull dei progetti esistenti
  • Come gestire i deployment degli script

La chiusura è disponibile su GitHub e ti dà il benvenuto in nuove funzionalità e patch.

Non vediamo l'ora di scoprire che cosa crei.