クイックスタート
minimalテンプレートを使い、ワーカープラグインを登録して動作を確認するまでの手順を説明します。
1. テンプレートを複製する
git clone https://github.com/urth-inc/metatell-plugins.git
cp -R metatell-plugins/worker-plugins/templates/minimal /path/to/your/plugin
cd /path/to/your/plugin
git init
git add .
git commit -m "Initial commit"
package.jsonのname、version、descriptionと、wrangler.jsoncのnameを変更します。
2. ローカルで起動する
pnpm install
pnpm dev
pnpm devはwrangler devを実行し、Workerをローカルで起動します。
Durable Objectsもローカルで動作します。
Cloudflareの認証情報は必要ありません。
別のターミナルから動作を確認します。
curl http://localhost:8787/health
# {"ok":true}
型チェックは次のコマンドで実行します。
pnpm lint:tsc
3. ビルドしてZIPを作成する
pnpm build
dist/plugin.zipが作成されます。
ZIPにはバンドル済みのworker.jsとwrangler.jsoncが含まれます。
ZIPの構成とwrangler.jsoncの書き方は、ZIPと設定を参照してください。
備考
テンプレートはwranglerでバンドルしています。
pnpm devで動いたコードは、pnpm buildでも同じようにバンドルされます。
4. 管理画面から登録する
- metatell管理画面の左メニューで「開発者向け」の「ワーカープラグイン」を開きます。
- 「ワーカープラグインを登録」をクリックします。登録済みの場合は「新しいZIPを登録」をクリックします。
dist/plugin.zipを選択して登録します。
登録には組織管理者の権限が必要です。 1組織につき1つのワーカープラグインを登録でき、新しいZIPを登録すると既存のワーカープラグインを置き換えます。 詳しい操作はワーカープラグイン管理を参照してください。
5. 動作を確認する
登録が完了すると、組織のサブドメインからワーカープラグインを呼び出せます。
curl https://{組織ID}.metatell.app/ext/{組織ID}/health
# {"ok":true}
URLの/ext/{組織ID}はディスパッチャが取り除くため、Workerには/healthとして届きます。
警告
ワーカープラグインは組織のサブドメインまたはカスタムドメインでのみ配信されます。
metatell.appや他の組織のサブドメインからアクセスすると、404（not found）になります。