b2c-scaffold

B2C Scaffold 技能

使用 b2c scaffold 命令从模板生成 B2C Commerce 组件。

**提示：**如果未全局安装 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

生成 Cartridge

# 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

生成 Controller

# 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

生成 Hook

# 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 cartridge
controller	cartridge	包含路由和中间件的 SFRA controller
hook	cartridge	带有 hooks.json 注册信息的 Hook
custom-api	custom-api	带有 OAS 3.0 架构的自定义 SCAPI
job-step	job	带有 steptypes.json 注册信息的作业步骤
page-designer-component	page-designer	Page Designer 组件

相关技能

• b2c-cli:b2c-code - 将生成的 cartridges 部署到 B2C 实例
• b2c:b2c-controllers - SFRA controller 模式和最佳实践
• b2c:b2c-hooks - B2C Hook 扩展点
• b2c:b2c-custom-api-development - 自定义 API 开发指南
• b2c:b2c-custom-job-steps - 作业步骤实现模式
• b2c:b2c-page-designer - Page Designer 组件开发