カスタムテンプレートの作成

Wails には組み込みテンプレート一式が付属していますが、独自のテンプレートを作成してコミュニティと共有することもできます。カスタムテンプレートは単なる Git リポジトリです。公開すれば、誰でも 1 つのコマンドでそのテンプレートからプロジェクトのひな形を生成できます。

テンプレートのひな形を生成する

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 拡張機能を使用）および JetBrains IDE で自動補完とインライン検証が有効になります。このコメントは残しても削除しても構いません。実行時の動作には影響しません。

テンプレートをカスタマイズする

フロントエンド

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}} などのテンプレート変数がユーザーの指定値に置き換えられます。

IDE のサポートを利用して通常の Go ファイルとして編集するには、一時的にファイル名を 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コードを変更すると、アプリが再ビルドされて再起動すること
• 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に示します。変更しないでください。
• 定期的に更新します — 依存関係を最新の状態に保ち、Wailsの新しいリリースに対してテストしてください。