Создание собственных шаблонов

Wails поставляется с набором встроенных шаблонов, но вы можете создавать собственные шаблоны и делиться ими с сообществом. Пользовательский шаблон — это обычный репозиторий Git: после его публикации любой пользователь сможет создать на его основе каркас проекта одной командой.

Создание каркаса шаблона

Команда wails3 generate template создаёт каталог шаблона, готовый к настройке:

wails3 generate template -name MyTemplate

Все флаги:

Пример со всеми флагами:

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

Созданный каталог выглядит следующим образом:

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

Настройка метаданных шаблона

Откройте template.yaml и задайте метаданные шаблона:

# 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

Поле wailsVersion является обязательным и должно иметь значение 3. Комментарий # yaml-language-server в начале файла включает автодополнение и встроенную проверку в VS Code (с расширением YAML) и IDE JetBrains. Его можно оставить или удалить: на работу приложения он не влияет.

Настройка шаблона

Фронтенд

Каталог frontend/ без изменений копируется в каждый проект, созданный из вашего шаблона. Замените содержимое-заполнитель фактическим фронтендом:

cd MyTemplate/frontend
npm create vite@latest .

npm install

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

Задачи сборки

Taskfile.tmpl.yml определяет процесс сборки. Измените задачи install:frontend:deps и build: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

Приложение Go

Файл main.go.tmpl служит точкой входа в приложение. При создании проекта его обрабатывает шаблонизатор Wails: переменные шаблона, такие как {{.ProductName}}, заменяются значениями, указанными пользователем.

Чтобы редактировать его как обычный файл Go (с поддержкой IDE), временно переименуйте его в main.go, внесите изменения, а перед фиксацией изменений снова переименуйте в main.go.tmpl.

Переменные шаблона

В любом файле .tmpl доступны следующие переменные:

Локальное тестирование шаблона

Перед публикацией протестируйте шаблон, создав проект из локального пути:

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

Затем убедитесь, что проект работает:

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

Проверьте следующее:

• Горячая перезагрузка фронтенда работает
• После изменений в коде Go приложение пересобирается и перезапускается
• Исполняемый файл production-сборки в bin/ работает корректно

Публикация на 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

Теперь пользователи могут создавать проекты из вашего шаблона:

# 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

Рекомендации

• Составьте понятный README.md — он показывается пользователям после создания проекта. Объясните, как запускать, собирать и настраивать проект.
• Заполните поле helpurl — укажите ссылку на свой репозиторий или отдельную документацию. Пользователи увидят её в списке шаблонов Wails CLI.
• Зафиксируйте версии зависимостей фронтенда в package.json, чтобы обновления исходных пакетов не приводили к ошибкам установки.
• Проведите тестирование перед созданием тега — прежде чем объявлять о выпуске сообществу, создайте новый проект из выпуска с этим тегом.
• Сохраните wailsVersion: 3 — это поле указывает Wails, для какой основной версии предназначен шаблон. Не изменяйте его.
• Регулярно обновляйте шаблон — поддерживайте зависимости в актуальном состоянии и тестируйте шаблон с новыми выпусками Wails.