Tutorial de Apps Script CLI

Guía practica de inicio.

La CLI de Apps Script, o clasp, es una herramienta que nos permite crear, editar e implementar proyectos de Apps Script localmente. La CLI nos permite crear y publicar aplicaciones web y complementos para productos como Hojas de cálculo, Documentos, Formularios y Diapositivas desde la línea de comandos. Hay dos formas de desarrollar Apps Script, usando script.google.com o localmente en nuestras computadoras. Nosotros para caso practico de CLI aprenderemos de la segunda manera, cómo usar clasp, la herramienta de línea de comandos para Apps Script.

Características

• Desarrollar localmente. clasp nos permite escribir código en nuestra propia computadora y subirlo a Apps Script cuando hayamos terminado. También podemos descargar proyectos existentes de Apps Script y luego editarlos localmente. Una vez que el código es local, podemos usar nuestras herramientas de desarrollo favoritas como git para trabajar en proyectos de Apps Script.
• Gestionar versiones de implementación . Crear, actualizar y ver múltiples implementaciones de su proyecto.
• Código de estructura. claspcombierte automáticamente nuestros proyectos planos en script.google.com en carpetas . Como se muestra en el siguiente ejemplo:

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

Lo que aprenderemos en este tutorial.

En este tutorial aprenderemos cómo hacer 3 actividades clave con clasp:

• Cómo crear nuevos proyectos de Apps Script
• Cómo clonar, extraer y empujar proyectos existentes
• Cómo administrar las implementaciones de nuestros scripts

Descargar la CLI

La CLI de Script de aplicaciones ( clasp) requiere la instalación de Node.js> = v6.0.0. Instala Node.js aquí .

Nota: los claspusos requieren Node.js> = v6.0.0 . Actualice Node.js con estos comandos:

sudo npm install n -g

sudo n latest

Una vez que tenga Node, instale la CLI globalmente (alias clasp ):

npm i @google/clasp -g

Iniciar sesión

¡Probemos broche ! El único comando que debes recordar es clasp.

clasp

Hemos instalado clasp globalmente en nuestra computadora, por lo que el comando debería funcionar en todas partes en su sistema de archivos.

Antes de comenzar a usar la herramienta de línea de comandos, debemos iniciar sesión. Ejecute este comando:

clasp login

En este punto, se le solicita que inicie sesión en Google. Todos los proyectos que cree con la CLI están asociados con esta cuenta de Google.

Crear un nuevo proyecto

Crear un proyecto independiente

Comience creando un proyecto independiente de Google Apps Script con el siguiente comando:

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

¡Acaba de crear un proyecto de script de aplicaciones en la carpeta “clasp_codelab”!

Nota: El clasp createcomando creó una secuencia de comandos independiente. Esto significa que el proyecto no está conectado a una hoja, documento, formulario o presentación de Google. Sin embargo, veremos cómo crear una secuencia de comandos enlazada en la siguiente sección.

(Alternativa opcional) Clonar un proyecto existente

Intentemos crear una secuencia de comandos enlazada al contenedor para un complemento de Presentaciones de Google.

Para hacer esto, vaya a slides.google.com y cree una nueva presentación. Cambie el nombre de la presentación a “ prueba Codelab de cierre “. En la cabecera, bajo Herramientas , pulse Editor de secuencias … .

Esto abrirá su proyecto de Apps Script en script.google.com . Para clonar un proyecto, necesitamos encontrar el Script ID. Puede encontrar este valor yendo a Archivo> Propiedades del proyecto> Información> ID de secuencia de comandos (este valor también se encuentra en la URL). Copie el valor y péguelo en el siguiente comando:

clasp clone <scriptID>

La salida debería verse así …

Ahora ha descargado el proyecto en su directorio actual . Use su editor favorito para ver el contenido de Code.gs(una función vacía).

Tirando y empujando archivos

Editar código en script.google.com

Ahora que puede clonar un proyecto, aprendamos cómo extraer y enviar archivos. Le guiaremos a través de los pasos para editar en la nube script.google.comy acceder a su computadora localmente. Abramos el script en la nube:

clasp open

Ahora que estamos en el editor en línea, editaremos un código en línea que luego buscaremos usando clasp.

En el editor, cree un nuevo archivo seleccionando Archivo> Nuevo> Archivo de script . Ingresa el nombre utils/strings. En el archivo recién creado utils/strings.gs, reemplace el código con lo siguiente:

var world = "世界";

En Code.gs, reemplace el código existente con lo siguiente:

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

Asegúrese de guardar todos los archivos. Intente ejecutar la función presionando Run > Run function > hello.

Ve a View > Logsver el saludo.

Editar código localmente

Volvamos a la línea de comando donde clonamos el proyecto por última vez. Puede notar que nuestro código ahora no está sincronizado con el editor en línea. Para solucionarlo, extraigamos el código de nuestro proyecto en línea.

clasp pull

Ahora vuelve al código. Debes notar que hay una carpeta para nuestras utilidades. La claspCLI convierte automáticamente el carácter de barra diagonal /en carpetas en el sistema de archivos local.

En su editor de texto favorito, vaya a util/strings.gsy sustituir el nombre de la variable worlda mondo. Además, actualice Code.gs reemplazándolo worldpor mondo. Para actualizar el código actualizado script.google.com, presione su código editado.

clasp push

¡Y eso es! Su código ahora está actualizado script.google.com.

clasp pushreemplaza el código que está en script.google.com y clasp pullreemplaza todos los archivos localmente. Por esta razón, siga estas pautas:

• No edite simultáneamente código localmente y en script.google.com .
• Use un sistema de control de versiones, como git .

Versionado e implementación

clasple permite administrar versiones e implementaciones. Primero, un poco de vocabulario:

• Versión : Una “instantánea” de un proyecto de script. Una versión puede considerarse una rama de solo lectura utilizada para implementaciones.
• Implementación : una publicación publicada de un proyecto de script (a menudo como complemento o aplicación web). Requiere un número de versión.

Creemos una versión de nuestro script:

clasp version "First version"

Usando la cadena de versión registrada que creamos en lugar de [version], podemos implementar el script:

clasp deploy 1 "First deployment"

El clasp deploycomando mira su manifiesto y crea una nueva implementación versionada. Su código ahora se implementa como un ejecutable. Obtenga más información sobre esto en la guía de implementaciones .

Eso es todo!

Esperamos que Apps Script CLI sea una herramienta simple para ayudarlo a administrar proyectos de Apps Script.

Lo que hemos cubierto

• Cómo crear nuevos proyectos de Apps Script
• Cómo clonar, empujar y extraer proyectos existentes
• Cómo administrar las implementaciones de sus scripts

El cierre está disponible en GitHub y es bienvenido a nuevas características y parches.

¡Estamos ansiosos por ver lo que construyes!