CLI
tsumugiパッケージは、セットアップ用のCLIを含みます。
別途インストールする必要はありません。
パッケージを追加したプロジェクトで、npx tsumugiを実行します。
引数なしで実行すると、対話モードで起動します。
パイプやCIなどTTYでない環境では、対話モードにならず、使用方法を出力して終了します。
npx tsumugi
tsumugi init
プロジェクトにTsumugiをセットアップします。
npx tsumugi init [--name <name>] [--format jsonc|toml]
initは、wrangler queues create <name>とwrangler d1 create <name>でリソースを作成します。
wranglerの設定ファイルが存在しない場合、新たに生成し、wrangler d1 createが出力したdatabase_idを書き込みます。
次に、src/index.ts, src/performers/, .dev.varsを生成します。
最後に、wrangler d1 migrations apply(--localと--remote)とwrangler typesを実行します。
オプション
| オプション | 内容 |
|---|---|
--name <name> | Workerの名前。省略した場合は、既存の設定ファイルのname, package.jsonのname, ディレクトリ名の順に使用 |
--format <jsonc|toml> | 生成する設定ファイルの形式。既定はjsonc |
既存ファイルの扱い
initは、既存のファイルを変更しません。
wranglerの設定ファイル(wrangler.json, wrangler.jsonc, wrangler.toml)が既に存在する場合は、追記する内容をそのファイルの形式で出力します。src/index.tsなどの雛形のうち、既存のファイルは再生成しません。
tsumugi add-performer
performerを追加します。
npx tsumugi add-performer <NAME>
add-performerは、src/performers/<name>.tsにperformerのクラスを生成します。src/performers/index.tsには、export行を1行追記します。
名前は、kebab-case, camelCase, PascalCase, SNAKE_CASEのいずれの形式も受け付けます。
クラス名はPascalCaseに、ファイル名はkebab-caseに変換します。
たとえばsend-mailは、クラスSendMailとファイルsend-mail.tsとして生成されます。
Service Bindingの設定
別のWorkerからこのperformerを呼び出す場合は、呼び出し側の設定ファイルにservicesの値を追加してください。add-performerは、追加すべき値を出力します。
同じWorker内でperformerを実行する場合は、追加は不要です。
公開日: 最終更新: