Configuration de l’environnement de développement

Configuration de l’environnement de développement

Ce guide vous accompagne dans la configuration d’un environnement de développement complet pour travailler sur Wails v3.

Outils requis

Développement avec Go

1. Installez Go 1.25 ou une version ultérieure :

# Download from https://go.dev/dl/
go version  # Verify installation

2. Configurez l’environnement Go :

# Add to your shell profile (.bashrc, .zshrc, etc.)
export GOPATH=$HOME/go
export PATH=$PATH:$GOPATH/bin

3. Installez les outils Go utiles :

go install golang.org/x/tools/cmd/goimports@latest
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest

Node.js et npm

Requis uniquement pour les exemples d’intégration avec le frontend.

# Install Node.js 20+ and npm
node --version  # Should be 20+
npm --version

Dépendances propres à chaque plateforme

macOS :

# Install Xcode Command Line Tools
xcode-select --install

# Verify installation
xcode-select -p  # Should output a path

Windows :

1. Installez MSYS2 pour disposer d’un environnement de type Unix
2. WebView2 Runtime (préinstallé sur Windows 11, à télécharger pour Windows 10)
3. Facultatif : installez Git for Windows

Linux (Debian/Ubuntu) :

sudo apt update
# Default GTK4 + WebKitGTK 6.0 stack (Ubuntu 24.04+ / Debian 13+)
sudo apt install build-essential pkg-config libgtk-4-dev libwebkitgtk-6.0-dev
# For the legacy -tags gtk3 path:
sudo apt install libgtk-3-dev libwebkit2gtk-4.1-dev

Linux (Fedora/RHEL) :

# Default GTK4 stack
sudo dnf install gcc pkg-config gtk4-devel webkitgtk6.0-devel
# Legacy GTK3 path:
sudo dnf install gtk3-devel webkit2gtk4.1-devel

Linux (Arch) :

# Default GTK4 stack
sudo pacman -S base-devel gtk4 webkitgtk-6.0
# Legacy GTK3 path:
sudo pacman -S gtk3 webkit2gtk-4.1

Configuration du dépôt

Clonage et configuration

# Clone your fork
git clone https://github.com/YOUR_USERNAME/wails.git
cd wails

# Add upstream remote
git remote add upstream https://github.com/wailsapp/wails.git

# Verify remotes
git remote -v

Génération de la CLI Wails

# Navigate to v3 directory
cd v3

# Build the CLI
go build -o ../wails3 ./cmd/wails3

# Test the build
cd ..
./wails3 version

Ajout au PATH (facultatif)

Linux/macOS :

# Add to ~/.bashrc or ~/.zshrc
export PATH=$PATH:/path/to/wails

Windows :

Ajoutez le répertoire Wails à votre variable d’environnement PATH dans les propriétés système.

Configuration de l’IDE

VS Code (recommandé)

1. Installez VS Code : Télécharger

2. Installez les extensions :

• Go (par l’équipe Go de Google)
• ESLint
• Prettier
• MDX (pour la documentation)

3. Configurez les paramètres de l’espace de travail (.vscode/settings.json) :

{
  "go.useLanguageServer": true,
  "go.lintTool": "golangci-lint",
  "go.lintOnSave": "workspace",
  "editor.formatOnSave": true,
  "go.formatTool": "goimports"
}

GoLand

1. Installez GoLand : Télécharger

2. Configurez GoLand :

• Activez la prise en charge des modules Go
• Configurez des observateurs de fichiers pour goimports
• Configurez le style du code conformément aux conventions du projet

Vérification de la configuration

Exécutez ces commandes pour vérifier que tout fonctionne :

# Go version check
go version

# Build Wails
cd v3
go build ./cmd/wails3

# Run tests
go test ./pkg/...

# Create a test app
cd ..
./wails3 init -n mytest -t vanilla
cd mytest
../wails3 dev

Si l’application de test est générée et s’exécute correctement, votre environnement est prêt !

Exécution des tests

Tests unitaires

cd v3
go test ./...
cd ..

Tests d’un paquet spécifique

cd v3
go test ./pkg/application
go test ./pkg/events -v  # Verbose output

Exécution avec mesure de la couverture

cd v3
go test ./... -coverprofile=coverage.out
go tool cover -html=coverage.out

Exécution avec le détecteur de situations de concurrence

cd v3
go test ./... -race

Utilisation de la documentation

La documentation de Wails v3 est rédigée avec M-Press. Les fichiers sources en anglais se trouvent dans
docs/mpress/content/ ; les traductions se trouvent dans des répertoires de langue tels que
fr/ et id/.

Prévisualisez et validez les modifications apportées à la documentation depuis la racine du dépôt :

go install github.com/leaanthony/mpress/cmd/mpress@v1.0.17
mpress dev
mpress build --strict --no-purge-css
mpress check
# Use `python` on Windows if `python3` is unavailable.
python3 docs/mpress/scripts/check_site.py docs/mpress/site

Le site de production est statique. Node.js, un fournisseur de traduction et des identifiants
Cloudflare ne sont pas requis pour travailler localement sur la documentation.

Débogage

Débogage du code Go

VS Code :

Créez .vscode/launch.json :

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Debug Wails CLI",
      "type": "go",
      "request": "launch",
      "mode": "debug",
      "program": "${workspaceFolder}/v3/cmd/wails3",
      "args": ["dev"]
    }
  ]
}

Ligne de commande :

# Use Delve debugger
go install github.com/go-delve/delve/cmd/dlv@latest
dlv debug ./cmd/wails3 -- dev

Débogage du code propre à chaque plateforme

Le débogage propre à chaque plateforme nécessite les outils correspondants :

• macOS : Xcode Instruments
• Windows : Débogueur de Visual Studio
• Linux : GDB

Problèmes courants

“command not found: wails3”

Ajoutez le répertoire Wails à votre PATH ou utilisez ./wails3 depuis la racine du projet.

« webkitgtk-6.0 not found » ou « webkit2gtk not found » (Linux)

Installez les paquets de développement correspondant à la pile avec laquelle vous effectuez la compilation :

# Default GTK4 stack (Debian/Ubuntu):
sudo apt install libwebkitgtk-6.0-dev

# Legacy GTK3 path:
sudo apt install libwebkit2gtk-4.1-dev

Échec de la compilation en raison d’erreurs de modules Go

cd v3
go mod tidy
go mod download

Erreurs « CGO_ENABLED » sous Windows

Vérifiez qu’un compilateur C (MinGW-w64 via MSYS2) est présent dans votre PATH.

Étapes suivantes

• Consultez les normes de codage
• Explorez la documentation technique
• Trouvez un problème sur lequel travailler : problèmes adaptés aux premières contributions