Création de modèles personnalisés

Wails est fourni avec un ensemble de modèles intégrés, mais vous pouvez créer les vôtres et les partager avec la communauté. Un modèle personnalisé est simplement un dépôt Git : une fois hébergé publiquement, il permet à quiconque de générer la structure initiale d’un projet à l’aide d’une seule commande.

Générer la structure initiale d’un modèle

La commande wails3 generate template génère un répertoire de modèle prêt à être personnalisé :

wails3 generate template -name MyTemplate

Toutes les options :

Exemple avec toutes les options :

wails3 generate template \
  -name "My Template" \
  -author "Your Name" \
  -description "React + custom setup" \
  -helpurl "https://github.com/yourname/my-template" \
  -version "v1.0.0" \
  -frontend ./my-existing-frontend

Le répertoire généré se présente comme suit :

MyTemplate/
├── template.yaml          # Template metadata — edit this
├── NEXTSTEPS.md           # Guidance for you as the template author — delete before publishing
├── README.md              # Shown to users after they create a project
├── main.go.tmpl           # Application entry point
├── greetservice.go        # Example Go service
├── go.mod.tmpl            # Go module file
├── go.sum.tmpl            # Go checksums
├── gitignore.tmpl         # Becomes .gitignore in generated projects
├── Taskfile.tmpl.yml      # Build task definitions
└── frontend/              # Your frontend code

Configurer les métadonnées du modèle

Ouvrez template.yaml pour définir les métadonnées de votre modèle :

# yaml-language-server: $schema=https://v3.wails.io/schemas/template.v3.json
name: "My Template"
shortname: my-template
author: Your Name
description: A template with my preferred setup
helpurl: https://github.com/yourname/my-template
version: v1.0.0
wailsVersion: 3

Le champ wailsVersion est obligatoire et doit avoir la valeur 3. Le commentaire # yaml-language-server situé en haut active l’autocomplétion et la validation à la volée dans VS Code (avec l’extension YAML) et les IDE JetBrains. Vous pouvez le conserver ou le supprimer ; il n’a aucun effet à l’exécution.

Personnaliser le modèle

Frontend

Le répertoire frontend/ est copié à l’identique dans chaque projet créé à partir de votre modèle. Remplacez le contenu temporaire par votre véritable frontend :

cd MyTemplate/frontend
npm create vite@latest .

npm install

wails3 generate template -name MyTemplate -frontend ./my-app/frontend

Tâches de compilation

Taskfile.tmpl.yml définit le processus de compilation. Adaptez les tâches install:frontend:deps et build:frontend à votre chaîne d’outils frontend :

tasks:
  install:frontend:deps:
    dir: frontend
    cmds:
      - npm install       # replace with pnpm install, yarn, etc.

  build:frontend:
    dir: frontend
    deps: [install:frontend:deps, generate:bindings]
    cmds:
      - npm run build     # replace with your build command

Application Go

Le fichier main.go.tmpl constitue le point d’entrée de l’application. Le moteur de modèles de Wails le traite lors de la création d’un projet : les variables de modèle telles que {{.ProductName}} sont remplacées par les valeurs fournies par l’utilisateur.

Pour le modifier comme un véritable fichier Go, avec la prise en charge de l’IDE, renommez-le temporairement en main.go, apportez vos modifications, puis rétablissez son nom main.go.tmpl avant d’effectuer le commit.

Variables de modèle

Ces variables sont disponibles dans tout fichier .tmpl :

Tester votre modèle localement

Avant de le publier, testez le modèle en créant un projet à partir d’un chemin local :

wails3 init -n testproject -t /path/to/MyTemplate

Vérifiez ensuite que le projet fonctionne :

cd testproject
wails3 dev    # development mode with hot reload
wails3 build  # production binary

Vérifiez les points suivants :

• Le rechargement à chaud du frontend fonctionne
• Les modifications du code Go entraînent la recompilation et le redémarrage de l’application
• Le binaire de production situé dans bin/ s’exécute correctement

Publier sur GitHub

git init
git add .
git commit -m "Initial template"
git remote add origin https://github.com/yourname/my-template.git
git push -u origin main

git tag v1.0.0
git push origin v1.0.0

Les utilisateurs peuvent désormais créer des projets à partir de votre modèle :

# Latest commit on the default branch
wails3 init -n myapp -t https://github.com/yourname/my-template

# Pinned to a specific release tag
wails3 init -n myapp -t https://github.com/yourname/my-template@v1.0.0

Bonnes pratiques

• Rédigez un README.md clair — il est présenté aux utilisateurs après la création d’un projet. Expliquez comment exécuter, compiler et personnaliser le projet.
• Renseignez helpurl — ajoutez un lien vers votre dépôt ou une documentation dédiée. Les utilisateurs le voient dans la liste des modèles de la CLI Wails.
• Figez les versions des dépendances du frontend dans package.json afin d’éviter que des mises à jour en amont ne rendent les installations impossibles.
• Testez avant de créer l’étiquette de version — créez un nouveau projet à partir de la version étiquetée avant de l’annoncer à la communauté.
• Conservez wailsVersion: 3 — ce champ indique à Wails la version majeure ciblée par le modèle. Ne le modifiez pas.
• Effectuez des mises à jour régulières — maintenez les dépendances à jour et effectuez des tests avec les nouvelles versions de Wails.