O TypeScript é um superconjunto de JavaScript com tipagem que pode ser compilado em Apps Script simples. Ao usar o TypeScript no desenvolvimento de um projeto do Apps Script, você tem os seguintes benefícios:
- Preenchimento automático do ambiente de desenvolvimento integrado local
- Tipagem estrutural opcional
- Inferência de tipo, interfaces
- Recursos do ES6, como classes e funções de seta.
Este guia aborda algumas tarefas comuns para desenvolver um projeto do Apps Script com TypeScript.
Requisitos
Se você não conhece o TypeScript, consulte a documentação do TypeScript e o guia de início rápido do TypeScript para se familiarizar com os conceitos básicos antes de tentar qualquer um dos procedimentos descritos neste guia.
As seguintes ferramentas são necessárias para usar o TypeScript em projetos do Apps Script com clasp
. Embora o uso de clasp
não seja
estritamente necessário para ativar o uso do TypeScript no Apps Script, é altamente
recomendado, já que simplifica muito os procedimentos.
Antes de tentar qualquer um dos processos descritos abaixo, verifique se você instalou o seguinte para ativar seu ambiente de desenvolvimento local:
- Node e npm
clasp
:npm install -g @google/clasp
- Definições de tipo para o Apps Script:
npm i -S @types/google-apps-script
- Visual Studio Code (para preenchimento automático do IDE do TypeScript)
Familiarize-se com a documentação do clasp
se você nunca usou esse recurso antes.clasp
Como usar o TypeScript em um projeto do Clasp
Use clasp
para criar rapidamente um novo projeto local do Apps Script.
Esse comando cria um appsscript.json
e um Code.gs
, a base de um projeto do Apps
Script.
Para usar o TypeScript em um arquivo do Apps Script, basta renomear a extensão do arquivo de
gs
para ts
.
Editar arquivos TypeScript locais
Usando seu editor preferido, é possível gravar arquivos TypeScript locais como arquivos .ts
na pasta do projeto.
Por exemplo, um arquivo chamado index.ts
pode ter o seguinte código
TypeScript:
const greeter = (person: string) => {
return `Hello, ${person}!`;
}
let user = 'Grant';
Logger.log(greeter(user));
É possível escrever TypeScript com recursos ES6+, como
funções de seta
e interpolação de strings (${var}
). Esses arquivos são transpilados em construções do Apps Script
quando você envia o projeto para o servidor do Apps Script.
Fazer upload de um projeto local do Apps Script que usa TypeScript
Quando terminar de editar os arquivos locais do TypeScript e do Apps Script, você
poderá fazer upload dos arquivos locais para o Google Drive usando o seguinte comando clasp
:
clasp push --watch
Esse comando monitora as mudanças nos arquivos TypeScript e usa typescript
para compilar
o código e clasp
para fazer upload do projeto no Google Drive.
Informar problemas ou enviar solicitações de recursos
Se você encontrar um problema com a ferramenta clasp
, informe no
GitHub.
Se você encontrar um problema ou bug no TypeScript, informe no repositório do GitHub do TypeScript.
Leitura relacionada
- Aprenda TypeScript em 5 minutos
- Manual do TypeScript (link em inglês)
- TSLint