Vibe-coding une extension VS Code pour des projets Terraform
Cette traduction a été générée par une IA générative à l'aide de la traduction continue Action. →
Aujourd’hui, je veux parler d’une petite extension VS Code que j’ai codée intuitivement en une seule journée pour rendre le travail avec Terraform plus facile. Je vais d’abord expliquer ce qu’est Terraform, puis plonger directement dans les fonctionnalités et les raisons derrière cette extension. N’hésitez pas à passer à la section suivante si vous êtes déjà familier avec Terraform.
Terraform est un outil d’infrastructure en tant que code (IaC) qui vous permet de définir l’intégralité de votre infrastructure cloud ou sur site sous forme de code. Son langage de configuration, inventé par 
HashiCorp, s’appelle HCL (HashiCorp Configuration Language) et présente une syntaxe intuitive et lisible par les humains. La syntaxe native a l’avantage de présenter une courbe d’apprentissage faible, d’être cohérente pour tous les fournisseurs, et agréable à lire et écrire pour les humains, tandis que la variante basée sur JSON est plus facile à générer et à analyser pour les machines.
Ce qui rend Terraform très puissant, ce sont deux fonctionnalités de base : les variables et les modules. Les variables vous permettent de créer des ressources dont les valeurs réelles peuvent être insérées depuis un autre endroit, et les modules regroupent un certain nombre de ressources, ce qui offre l’avantage de la réutilisabilité et de l’imbrication. Bien que ces deux fonctionnalités paraissent très basiques, leur combinaison en fait une équipe de rêve. Cela parce que l’ouverture de Terraform vous permet de définir des variables d’entrée pour chaque module et également d’exporter des variables via des sorties.
Un module simple est structuré comme ceci :
Répertoiregroupe-de-ressources-azure/
- principal.tf
- variables.tf
- sorties.tf
- README.md
Tous les fichiers sauf principal.tf sont optionnels (le README.md n’est pas spécifique à Terraform), mais je préfère suivre les bonnes pratiques, donc l’exemple les inclut.
Examinons un exemple simple. Imaginez que nous voulons gérer un groupe de ressources dans Azure avec Terraform. Dans le fichier variables.tf, nous définissons quelles entrées nous attendons dans le module. Chacun des deux blocs représente la variable et les propriétés de la variable, comme la description ou le type :
variable "name" { description = "Name of the resource group" type = string}
variable "location" { description = "Azure region" type = string default = "westeurope"}Vous avez peut-être remarqué que la variable location a également une propriété default, ce qui rend la variable optionnelle et fournit une valeur de secours si aucune n’est spécifiée. Ces variables peuvent ensuite être utilisées dans le fichier principal.tf, où nous définissons les ressources réelles que nous voulons générer :
provider "azurerm" { features {}}
resource "azurerm_resource_group" "this" { name = var.name location = var.location}Dans ce cas, nous définissons simplement notre groupe de ressources, que vous pouvez imaginer comme un dossier dans Azure - explication très simpliste. Maintenant, la dernière partie que nous pouvons implémenter est le fichier sorties.tf :
output "resource_group_id" { description = "The ID of the resource group" value = azurerm_resource_group.this.id}Cela est très utile si nous voulons utiliser des informations comme l’ID du groupe de ressources plus tard dans d’autres parties de notre projet Terraform.
Comme je l’ai déjà mentionné, le README.md ne fait pas vraiment partie des définitions Terraform, mais aide à comprendre l’objectif du module :
# Azure Resource Group Module
A minimal Terraform module that creates an Azure Resource Group.
## Usage
```hclmodule "rg" { source = "./azure-resource-group" name = "my-resource-group"}```Comme le README.md le suggère déjà, nous pouvons maintenant utiliser ce module pour créer un groupe de ressources Azure n’importe où dans notre projet. Nous devons juste nous assurer que le chemin vers le dossier du module est correct et que Terraform sait comment interpréter les fichiers main.tf, variables.tf et outputs.tf. Dans ce cas, étant donné que nous ne spécifions pas la variable location, elle sera définie sur "westeurope".
module "rg" { source = "./azure-resource-group" name = "my-resource-group"}J’espère que cette section vous a donné une meilleure compréhension de base de ce qu’est Terraform et de ce que vous pouvez faire avec.
Vous avez peut-être remarqué que le champ source d’un module crée une flexibilité incroyable pour l’ensemble du projet puisque vous pouvez définir des modules n’importe où et les utiliser n’importe où dans le projet.
Cependant, cette fonctionnalité a aussi un énorme inconvénient en termes de maintenabilité : résoudre les valeurs réelles derrière les variables peut être très fastidieux. Bien que dans cet exemple simple, cela puisse sembler facile à gérer, plus le projet grandit, plus il devient imbriqué, et plus il est difficile et chronophage de comprendre et d’adapter le code Terraform. C’est pourquoi j’ai créé une extension.
Que doit faire l’extension ? Le principal objectif de l’extension est de fournir les valeurs réelles des variables partout où elles sont utilisées. Si un module est appelé à partir de plusieurs endroits ou simplement plusieurs fois, les informations doivent indiquer quel cas d’utilisation définit la variable avec quelle valeur. Si les modules sont profondément imbriqués, les valeurs doivent être résolues jusqu’à ce que nous atteignions les fichiers .tfvars. Ce sont les fichiers où vous pouvez définir des valeurs codées en dur pour les variables.
Créer le projet modèle de base pour une extension VS Code est aussi simple que d’exécuter cette commande lorsque vous avez 
Node installé :
npx --package yo --package generator-code -- yo codeCette commande installe temporairement Yeoman (un logiciel générateur), et entre dans un mode interactif où certaines questions doivent être répondues, comme le nom du projet, le type et la description. Dans le bloc suivant, vous pouvez voir toutes les questions et les réponses par défaut :
# ? What type of extension do you want to create? New Extension (TypeScript)# ? What's the name of your extension? HelloWorld### Press <Enter> to choose default for all options below ###
# ? What's the identifier of your extension? helloworld# ? What's the description of your extension? LEAVE BLANK# ? Initialize a git repository? Y# ? Which bundler to use? unbundled# ? Which package manager to use? npm
# ? Do you want to open the new folder with Visual Studio Code? Open with `code`Pour plus d’informations sur les extensions VS Code, je tiens à renvoyer à la documentation officielle, car elle est toujours à jour contrairement à mes explications ici.
J’aime commencer de nouveaux projets en posant des questions techniques générales à 
ChatGPT comme :
- Comment suggéreriez-vous de réaliser un tel projet ?
- Combien de temps estimez-vous que cela me prendra ?
- À quel point cela sera-t-il difficile ?
Brainstormer avec des bots d’IA semble être un moyen très sensé d’avoir une meilleure vue d’ensemble des nouveaux projets, surtout lorsqu’on s’aventure dans des terrains complètement inconnus.
Créer une extension VS Code était exactement un tel cas d’utilisation, car je n’avais jamais créé quelque chose pour VS Code ou tout autre IDE auparavant.
Après cette phase initiale de brainstorming, je préfère utiliser 
Claude pour programmer tous les fichiers nécessaires à une telle extension, car, selon mon expérience, ce bot IA a vraiment la capacité de produire des codes impeccables. J’ai rarement rencontré des bugs ou problèmes d’exécution avec le code de Claude, alors je l’utilise exactement pour ces cas d’utilisation - les premiers pas. L’inconvénient de Claude est sa version d’essai gratuite très limitée, ce qui fait que je suis toujours prudent dans le choix de mes mots et que j’essaie de prévoir autant d’erreurs potentielles que l’IA pourrait faire.
C’est ainsi que tout a commencé : j’ai pris le temps de formuler mon scénario et mon souhait exact dans les fenêtres de contexte limitées d’une machine à mots aléatoires appelée Claude et j’ai immédiatement reçu une implémentation massive du fichier extension.ts. Bien sûr, il y avait des différences évidentes entre ma vision et la communication avec ce LLM, alors j’ai dû lui dire une autre fois quelles sont les considérations importantes, et pour pouvoir recevoir davantage de code, j’ai également utilisé mon astuce magique : “Si cela est trop grand pour un fichier, donne-moi simplement l’ensemble de extension.ts en plusieurs fichiers, ce qui devrait bien sûr fonctionner.”
Claude s’est alors lancé dans un long périple.
Après quelques difficultés à le maintenir opérationnel, tous mes jetons étaient utilisés et j’ai dû terminer le reste du code moi-même. Néanmoins, j’ai réussi à obtenir une version fonctionnelle, car il ne manquait pas grand-chose, et j’ai immédiatement identifié quelques améliorations qui étaient passées inaperçues jusqu’à maintenant. Étant donné que je devais attendre le rechargement de mes jetons, c’est exactement ce que j’ai fait.
Le lendemain matin, la session d’amélioration a commencé, et après deux longues conversations, la fenêtre de contexte était complètement remplie et je ne pouvais même plus envoyer de messages dans le même chat, bien que mes jetons ne soient pas encore expirés. Cependant, tout ce que je voulais accomplir et obtenir de Claude était désormais disponible et je pouvais effectuer des tests dans l’un de mes projets plus importants. Après avoir confirmé et ajusté manuellement quelques morceaux de code, j’étais satisfait pour le moment et j’ai décidé que la première version publique était prête.
Après quelques essais et erreurs avec 
GitHub Actions, j’ai réussi à configurer le publisher pour une extension VS Code. Et après deux versions correctives, j’étais assez satisfait des résultats.
Essayez l’extension vous-même en cliquant sur le bouton ci-dessous. Il reste encore de nombreuses améliorations à apporter, donc si vous êtes intéressé pour aider, n’hésitez pas à contribuer sur GitHub.
Installer Terraform Variables ResolutionVoici un exemple tiré de l’explication de Terraform, montrant comment cette extension ajoute visuellement les valeurs des variables dans VS Code :
