最初の Fabled モジュールを構築する

の前提条件

• Node.js 20.20 以降。 Fabled Web リポジトリ自体には、現在 ^20.20.0 または >=22.22.0 が必要です。
• フェイブルドアカウント。パブリッシュには、利用可能なモジュール CLI ペアリング サービスとアクティブなパブリッシャー ネームスペースも必要です。
• パブリック ブートストラップ: @fabledgg/module-cli は、npm からブートストラップ dist-tag の下で利用可能ですが、0.1.0 はマージ後のリリース用に予約されたままです。

パブリック ブートストラップを実行する

現在のパブリック CLI をグローバルにインストールせずに、npm から直接試してみます。

npx @fabledgg/module-cli@bootstrap module --help

このガイドの残りの部分では、インストール済みバイナリの表記 fabled module を使用します。 Fabled Web リポジトリ自体に貢献している場合は、代わりに npm run modules:cli -- module を使用できます。

npx @fabledgg/module-cli@bootstrap module init my-dice \
  --publisher-id my-studio \
  --publisher-name \"My Studio\"

インストール スタイルを選択してください

推奨される 1 回限りのフォームはグローバル インストールを必要としません。

npx @fabledgg/module-cli@bootstrap module --help

チーム プロジェクトの場合、開発依存関係としてブートストラップをインストールします。これにより、package-lock.json は解決されたバージョンを記録し、ローカルおよび CI 検証で同じコントラクト ビルドが使用されます。

npm install --save-dev @fabledgg/module-cli@bootstrap
npx fabled module --help

グローバル インストールはオプションです。これは同じ伝説のバイナリを公開しますが、プロジェクトローカルに固定されたバージョンの方が再現と監査が簡単です。

npm install --global @fabledgg/module-cli@bootstrap
fabled module --help

プロジェクトの足場を築く

fabled module init my-dice \
  --publisher-id my-studio \
  --publisher-name "My Studio"

ディレクトリはまだ存在していてはなりません。スキャフォールドは、正規の fabled.module.json、レビュー済みのサイコロ アクション、ホスト所有の Dice Tray フレーム、および英語のロケール ファイルを使用して Dice & Chat サンプルを作成します。 --module-id でローカル モジュールのスラッグを変更し、--name で表示名を変更します。

my-dice/
├── fabled.module.json
├── actions/roll.json
├── frames/dice-tray.json
└── locales/en.json

最初のチェックを行う

fabled module validate my-dice
fabled module pack my-dice --output my-dice.zip
fabled module inspect my-dice.zip

クリーンな検証により、パッケージがローカル v1 コントラクトと一致することが証明されます。モジュールの承認、インストール、アクティブ化、または実行は行いません。