Membuat Templat Kustom

Wails menyediakan serangkaian templat bawaan, tetapi Anda dapat membuat templat sendiri dan membagikannya kepada komunitas. Templat kustom hanyalah repositori Git — setelah di-host secara publik, siapa pun dapat membuat kerangka proyek darinya dengan satu perintah.

Membuat kerangka templat

Perintah wails3 generate template menghasilkan direktori templat yang siap disesuaikan:

wails3 generate template -name MyTemplate

Semua flag:

Contoh dengan semua flag:

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

Direktori yang dihasilkan terlihat seperti ini:

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

Mengonfigurasi metadata templat

Buka template.yaml untuk mengatur metadata templat Anda:

# 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

Kolom wailsVersion wajib diisi dan harus berupa 3. Komentar # yaml-language-server di bagian atas mengaktifkan pelengkapan otomatis dan validasi sebaris di VS Code (dengan ekstensi YAML) serta IDE JetBrains — Anda dapat membiarkannya atau menghapusnya; komentar tersebut tidak berpengaruh saat runtime.

Menyesuaikan templat

Frontend

Direktori frontend/ disalin apa adanya ke setiap proyek yang dibuat dari templat Anda. Ganti konten placeholder dengan frontend Anda yang sebenarnya:

cd MyTemplate/frontend
npm create vite@latest .

npm install

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

Tugas build

Taskfile.tmpl.yml mendefinisikan alur kerja build. Perbarui tugas install:frontend:deps dan build:frontend agar sesuai dengan toolchain frontend Anda:

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

Aplikasi Go

File main.go.tmpl adalah titik masuk aplikasi. File ini diproses oleh mesin templat Wails saat proyek dibuat — variabel templat seperti {{.ProductName}} diganti dengan nilai yang diberikan pengguna.

Untuk mengeditnya sebagai file Go sungguhan (dengan dukungan IDE), ganti namanya sementara menjadi main.go, buat perubahan Anda, lalu kembalikan namanya menjadi main.go.tmpl sebelum melakukan commit.

Variabel templat

Variabel berikut tersedia di semua file .tmpl:

Uji templat Anda secara lokal

Sebelum memublikasikannya, uji templat dengan membuat proyek dari jalur lokal:

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

Kemudian, pastikan proyek berfungsi:

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

Pastikan bahwa:

• Hot reload frontend berfungsi
• Perubahan kode Go membangun ulang dan menjalankan kembali aplikasi
• Biner produksi di bin/ berjalan dengan benar

Publikasikan di 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

Pengguna kini dapat membuat proyek dari templat Anda:

# 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

Praktik terbaik

• Tulis README.md yang jelas — ini ditampilkan kepada pengguna setelah mereka membuat proyek. Jelaskan cara menjalankan, membangun, dan menyesuaikan proyek.
• Isi helpurl — tautkan ke repositori atau dokumentasi khusus Anda. Pengguna melihatnya dalam daftar templat Wails CLI.
• Kunci versi dependensi frontend dalam package.json untuk mencegah kegagalan instalasi akibat pembaruan upstream.
• Uji sebelum memberi tag — buat proyek baru dari rilis yang telah diberi tag sebelum mengumumkannya kepada komunitas.
• Pertahankan wailsVersion: 3 — kolom ini memberi tahu Wails versi mayor yang ditargetkan templat. Jangan mengubahnya.
• Perbarui secara berkala — selalu mutakhirkan dependensi dan uji dengan rilis Wails baru.