TypeScript est un sur-ensemble typé de JavaScript qui peut être compilé en Apps Script simple. Lorsque vous utilisez TypeScript pour développer un projet Apps Script, vous bénéficiez des avantages suivants :
- Saisie semi-automatique dans l'IDE local
- Typage structurel facultatif
- Inférence de type, interfaces
- Fonctionnalités ES6 telles que les classes et les fonctions fléchées.
Ce guide aborde certaines tâches courantes pour développer un projet Apps Script avec TypeScript.
Conditions requises
Si vous ne connaissez pas TypeScript, consultez la documentation TypeScript et le guide de démarrage rapide TypeScript pour vous familiariser avec les concepts de base avant d'essayer l'une des procédures décrites dans ce guide.
Les outils suivants sont nécessaires pour utiliser TypeScript dans les projets Apps Script avec clasp
. Bien que l'utilisation de clasp
ne soit pas strictement nécessaire pour activer TypeScript dans Apps Script, elle est fortement recommandée, car elle simplifie considérablement les procédures.
Avant d'essayer l'une des procédures décrites ci-dessous, assurez-vous d'avoir installé les éléments suivants pour activer votre environnement de développement local :
- Node et npm
clasp
:npm install -g @google/clasp
- Définitions de types pour Apps Script :
npm i -S @types/google-apps-script
- Visual Studio Code (pour l'autocomplétion de l'IDE TypeScript)
Si vous n'avez jamais utilisé clasp
, veillez à vous familiariser avec la documentation clasp
.
Utiliser TypeScript dans un projet Clasp
Vous pouvez utiliser clasp
pour créer rapidement un projet Apps Script local.
Cette commande crée un fichier appsscript.json
et un fichier Code.gs
, qui constituent la base d'un projet Apps Script.
Pour utiliser TypeScript dans un fichier Apps Script, il vous suffit de remplacer l'extension de fichier gs
par ts
.
Modifier des 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 contenir le code TypeScript suivant :
const greeter = (person: string) => {
return `Hello, ${person}!`;
}
let user = 'Grant';
Logger.log(greeter(user));
Vous pouvez écrire du code TypeScript avec des fonctionnalités ES6+, telles que les fonctions fléchées et l'interpolation de chaînes (${var}
). Ces fichiers sont transpilés en constructions Apps Script lorsque vous transférez le projet sur 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 aux fichiers TypeScript et utilise typescript
pour compiler le code et clasp
pour importer le projet dans Google Drive.
Signaler des problèmes ou demander des fonctionnalités
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 lui-même, vous pouvez le signaler dans le dépôt GitHub de TypeScript.