Como desarrollar en Apps Script usando TypeScript
TypeScript es un de los mejores transpilers de JavaScript que puede compilarse en un Script de Apps simple. Cuando usamos TypeScript en el desarrollo de un proyecto de Apps Script, obtenemos los siguientes beneficios:
- IDE local con autocompletado
- Tipificación estructural opcional
- Inferencia de tipos , interfaces
- Características de ES6 como clases y funciones de flecha .
Esta guía cubre algunas tareas comunes para desarrollar un proyecto de Script de aplicaciones con TypeScript.
Nota: Consulte la guía de GitHub TypeScript de clasp para obtener la última guía de TypeScript.
Requisitos
Si no está familiarizado con TypeScript, revise la documentación de TypeScript y el inicio rápido de TypeScript para familiarizarse con los conceptos básicos antes de intentar cualquiera de los procedimientos descritos en esta guía.
Las siguientes herramientas son necesarias para usar TypeScript en proyectos de Apps Script con clasp
. Si bien el uso clasp
no es estrictamente necesario para habilitar el uso de TypeScript en Apps Script, se recomienda encarecidamente, ya que simplifica enormemente los procedimientos.
Antes de intentar cualquiera de los procesos que se describen a continuación, asegúrese de haber instalado lo siguiente para habilitar su entorno de desarrollo local:
- Nodo y npm
clasp
:npm install -g @google/clasp
- Definiciones de tipo para Apps Script :
npm i -S @types/google-apps-script
- Código de Visual Studio (para el autocompletado IDE de TypeScript)
Asegúrese de familiarizarse con la clasp
documentación si no la ha utilizado clasp
anteriormente.
Usar TypeScript en un proyecto de cierre
Puede usar clasp
para crear rápidamente un nuevo proyecto local de Script de aplicaciones . Este comando crea una appsscript.json
y Code.gs
, la base de un proyecto de Script de Apps.
Para usar TypeScript en un archivo de App Script, simplemente cambie el nombre de la extensión del archivo de gs
a ts
.
Editar archivos locales de TypeScript
Usando su editor preferido, puede escribir archivos TypeScript locales como .ts
archivos en la carpeta del proyecto.
Nota: Los archivos .gs
/ existentes .js
pueden actualizarse a .ts
archivos cambiando el nombre de la extensión del archivo. Las características de TypeScript y ES6 se pueden agregar de forma incremental a los archivos existentes.
Por ejemplo, un archivo llamado index.ts
podría tener el siguiente código TypeScript:
const greeter = (person: string) => {
return `Hello, ${person}!`;
}let user = 'Grant';
Logger.log(greeter(user));
Puede escribir TypeScript con características de ES6 + como funciones de flecha e interpolación de cadenas ( ${var}
). Estos archivos se transpiran en construcciones de Script de Apps cuando empuja el proyecto al servidor de Script de Apps.
Cargue un proyecto local de Apps Script que use TypeScript
Cuando termine de editar los archivos locales de TypeScript y Apps Script, puede cargar los archivos locales en Google Drive con el siguiente clasp
comando:
clasp push --watch
Este comando vigila los cambios de archivos TypeScript y los utiliza typescript
para compilar el código y clasp
cargar el proyecto en Google Drive.
Informar problemas o solicitar una función de archivo
Si encuentra un problema con la clasp
herramienta, puede informarlo en GitHub .
Si encuentra un problema o error con TypeScript, puede informarlo en el repositorio GitHub de TypeScript .