O TypeScript é um superconjunto digitado de JavaScript que pode ser compilado em um Apps Script simples. Você tem os seguintes benefícios ao usar o TypeScript no desenvolvimento de um projeto do Apps Script:
- Preenchimento automático do ambiente de desenvolvimento integrado local
- Digitação estrutural opcional
- Inferência de tipo e 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 o TypeScript.
Requisitos
Se você não conhece o TypeScript, consulte a documentação e o guia de início rápido do TypeScript para conhecer os conceitos básicos antes de tentar qualquer um dos procedimentos descritos neste guia.
As ferramentas a seguir são necessárias para usar o TypeScript em projetos do Apps Script com o clasp. Embora o uso de clasp não seja
necessário para ativar o TypeScript no Apps Script, ele é altamente
recomendado, porque simplifica bastante os procedimentos.
Antes de tentar qualquer um dos processos descritos abaixo, verifique se você instalou o seguinte para ativar seu ambiente de desenvolvimento local:
- Nó e npm
clasp:npm install -g @google/clasp- Definições de tipo para o Apps Script:
npm i -S @types/google-apps-script - Código do Visual Studio (para preenchimento automático do ambiente de desenvolvimento integrado do TypeScript)
Consulte a documentação do clasp
se você ainda não tiver usado o clasp.
Como usar o TypeScript em um projeto Clasp
Você pode usar o 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 App Script, basta renomear a extensão do arquivo de
gs para ts.
Editar arquivos TypeScript locais
Com seu editor preferido, é possível gravar arquivos TypeScript locais como .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));
Você pode escrever em TypeScript com recursos do ES6+, como
funções de seta
e interpolação de strings (${var}). Esses arquivos são transcompilados 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 o TypeScript
Quando terminar de editar os arquivos locais do TypeScript e do Apps Script, você poderá fazer upload deles para o Google Drive usando o seguinte comando clasp:
clasp push --watch
Esse comando detecta mudanças no arquivo TypeScript e usa typescript para compilar o código e clasp para fazer upload do projeto para o Google Drive.
Informar problemas ou enviar uma solicitação de recurso
Se você encontrar um problema com a ferramenta clasp, denuncie no
GitHub.
Se você encontrar um problema ou bug com o próprio TypeScript, informe-o no repositório do GitHub do TypeScript (link em inglês).