b2c-scaffold

B2C スキャフォールドスキル

b2c scaffold コマンドを使用して、テンプレートから B2C Commerce コンポーネントを生成します。

Tip: b2c がグローバルにインストールされていない場合は、代わりに npx @salesforce/b2c-cli を使用してください。

例

利用可能なスキャフォールドを一覧表示する

# list all scaffolds
b2c scaffold list

# list only cartridge scaffolds
b2c scaffold list --category cartridge

# show extended info (description, tags)
b2c scaffold list -x

カートリッジを生成する

# generate interactively
b2c scaffold cartridge

# generate with name
b2c scaffold cartridge --name app_custom

# generate to specific directory
b2c scaffold cartridge --name app_custom --output ./src/cartridges

# skip prompts, use defaults
b2c scaffold cartridge --name app_custom --force

# preview without creating files
b2c scaffold cartridge --name app_custom --dry-run

コントローラーを生成する

# generate interactively (prompts for cartridge selection)
b2c scaffold controller

# generate with all options
b2c scaffold controller \
  --option controllerName=Account \
  --option cartridgeName=app_custom \
  --option routes=Show,Submit

フックを生成する

# generate a system hook
b2c scaffold hook \
  --option hookName=validateBasket \
  --option hookType=system \
  --option hookPoint=dw.order.calculate \
  --option cartridgeName=app_custom

# generate an OCAPI hook
b2c scaffold hook \
  --option hookName=modifyBasket \
  --option hookType=ocapi \
  --option hookPoint=dw.ocapi.shop.basket.beforePOST \
  --option cartridgeName=app_custom

カスタム API を生成する

# generate a shopper API
b2c scaffold custom-api \
  --option apiName=loyalty-points \
  --option apiType=shopper \
  --option cartridgeName=app_custom

# generate an admin API
b2c scaffold custom-api \
  --option apiName=inventory-sync \
  --option apiType=admin \
  --option cartridgeName=app_custom

ジョブステップを生成する

# generate a task-based job step
b2c scaffold job-step \
  --option stepId=custom.CleanupOrders \
  --option stepType=task \
  --option cartridgeName=app_custom

# generate a chunk-based job step
b2c scaffold job-step \
  --option stepId=custom.ImportProducts \
  --option stepType=chunk \
  --option cartridgeName=app_custom

Page Designer コンポーネントを生成する

b2c scaffold page-designer-component \
  --option componentId=heroCarousel \
  --option componentName="Hero Carousel" \
  --option componentGroup=content \
  --option cartridgeName=app_custom

スキャフォールドの情報を取得する

# see parameters and usage for a scaffold
b2c scaffold info cartridge
b2c scaffold info controller

スキャフォールドを検索する

# search by keyword
b2c scaffold search api

# search within a category
b2c scaffold search template --category page-designer

カスタムスキャフォールドを作成する

# create a project-local scaffold
b2c scaffold init my-component --project

# create a user scaffold
b2c scaffold init my-component --user

# validate a custom scaffold
b2c scaffold validate ./.b2c/scaffolds/my-component

組み込みスキャフォールド

スキャフォールド	カテゴリー	説明
cartridge	cartridge	標準構造の B2C カートリッジ
controller	cartridge	ルートとミドルウェアを備えた SFRA コントローラー
hook	cartridge	hooks.json 登録を含むフック
custom-api	custom-api	OAS 3.0 スキーマを含むカスタム SCAPI
job-step	job	steptypes.json 登録を含むジョブステップ
page-designer-component	page-designer	Page Designer コンポーネント

関連スキル

• b2c-cli:b2c-code - 生成されたカートリッジを B2C インスタンスにデプロイします
• b2c:b2c-controllers - SFRA コントローラーのパターンとベストプラクティス
• b2c:b2c-hooks - B2C フックの拡張ポイント
• b2c:b2c-custom-api-development - カスタム API 開発ガイド
• b2c:b2c-custom-job-steps - ジョブステップの実装パターン
• b2c:b2c-page-designer - Page Designer コンポーネントの開発