TypeScript est un sur-ensemble typé de JavaScript pouvant être compilé dans Apps Script. Lorsque vous utilisez TypeScript pour développer un projet Apps Script, vous bénéficiez des avantages suivants:
- Saisie semi-automatique de l'IDE local
- Saisie structurelle facultative
- Inférence de type, interfaces
- Fonctionnalités ES6 telles que les classes et les fonctions fléchées.
Ce guide couvre certaines tâches courantes du développement d'un projet Apps Script avec TypeScript.
Conditions requises
Si vous ne connaissez pas TypeScript, consultez la documentation de TypeScript et le guide de démarrage rapide de TypeScript pour vous familiariser avec les concepts de base avant d'effectuer l'une des procédures décrites dans ce guide.
Les outils suivants sont nécessaires pour utiliser TypeScript dans des projets Apps Script avec clasp. Bien que l'utilisation de clasp ne soit pas strictement nécessaire pour permettre l'utilisation de TypeScript dans Apps Script, elle est vivement recommandée, car elle simplifie considérablement les procédures.
Avant d'exécuter l'un des processus décrits ci-dessous, assurez-vous d'avoir installé les éléments suivants pour activer votre environnement de développement local:
- Nœud et npm
clasp:npm install -g @google/clasp- Définitions des types pour Apps Script:
npm i -S @types/google-apps-script - Visual Studio Code (pour la saisie semi-automatique dans l'IDE TypeScript)
Veillez à vous familiariser avec la documentation clasp
si vous n'avez jamais utilisé clasp auparavant.
Utiliser TypeScript dans un projet Clasp
Vous pouvez utiliser clasp pour créer rapidement un projet Apps Script local.
Cette commande crée un appsscript.json et un Code.gs, qui sont la base d'un projet Apps Script.
Pour utiliser TypeScript dans un fichier Apps Script, renommez simplement l'extension gs en ts.
Modifier les fichiers TypeScript locaux
À l'aide de l'éditeur de votre choix, vous pouvez écrire des fichiers TypeScript locaux en tant que fichiers .ts dans le dossier du projet.
Par exemple, un fichier nommé index.ts peut avoir le code TypeScript suivant:
const greeter = (person: string) => {
return `Hello, ${person}!`;
}
let user = 'Grant';
Logger.log(greeter(user));
Vous pouvez écrire TypeScript avec des fonctionnalités ES6+, telles que les fonctions fléchées et l'interpolation de chaîne (${var}). Ces fichiers sont transpilés dans des constructions Apps Script lorsque vous transférez le projet vers le serveur Apps Script.
Importer un projet Apps Script local qui utilise TypeScript
Une fois que vous avez terminé de modifier les fichiers TypeScript et Apps Script locaux, vous pouvez les importer dans Google Drive à l'aide de la commande clasp suivante:
clasp push --watch
Cette commande surveille les modifications apportées au fichier TypeScript et utilise typescript pour compiler le code et clasp pour importer le projet dans Google Drive.
Signaler des problèmes ou envoyer une demande de fonctionnalité
Si vous rencontrez un problème avec l'outil clasp, vous pouvez le signaler sur GitHub.
Si vous rencontrez un problème ou un bug avec TypeScript, vous pouvez le signaler dans le dépôt GitHub de TypeScript.