跳到主要内容

Checkout 扩展

构建、开发和管理 Shoplazza Checkout 扩展。别名:checkout。

build、dev 和 push 通过 Node.js 运行内置的 Vite 工具链,需要 Node.js 14.18.0 或更高版本且在 PATH 中。如果项目还没有 node_modules,首次运行会自动安装其 npm 依赖(npm install)。

在终端中,缺少必填参数时命令会提示你输入,而不是直接报错;deploy、preview、undeploy 和 versions 可以从店铺拉取的列表中选择扩展(及其版本)。使用 --no-input、在 CI 中运行,或 stdin / stderr 不是终端时,不会提示,缺少参数会立即报错。

init​

创建新的 Checkout 扩展项目脚手架(本地操作,无需网络)。

shell
shoplazza checkout-extension init --name <项目名> --extension <首个扩展名>

Flags​

Flag类型说明
--namestring项目名称(在当前目录下创建同名目录)
--extensionstring首个扩展名称

示例​

shell
shoplazza checkout init --name my-project --extension my-ext

create​

在已有项目中创建新扩展(本地操作,无需网络)。需在 init 创建的项目目录内执行。

shell
shoplazza checkout-extension create --name <扩展名>

Flags​

Flag类型说明
--namestring扩展名称

示例​

shell
shoplazza checkout create --name another-ext

dev​

启动 Checkout 扩展开发服务器(自动重新构建 + 端口 8888 上的 HMR 热更新)。

shell
shoplazza checkout-extension dev [flags]

Flags​

Flag类型说明
--extension-namestringSlice要开发的扩展名称(可重复使用,支持逗号分隔)
--allbool开发 ./extensions 下的所有扩展

示例​

shell
# 开发单个扩展
shoplazza checkout dev --extension-name my-ext

# 开发多个扩展
shoplazza checkout dev --extension-name ext1,ext2

# 开发所有扩展
shoplazza checkout dev --all

build​

使用内置 Vite 工具链构建 Checkout 扩展。

shell
shoplazza checkout-extension build [flags]

Flags​

Flag类型说明
--namestring扩展名称(./extensions 下的目录名);在扩展目录内运行时可省略
--debugbool将详细构建日志输出到 stderr

示例​

shell
# 从项目根目录构建
shoplazza checkout build --name my-ext

# 在扩展目录内构建
cd extensions/my-ext && shoplazza checkout build

push​

构建并上传新的扩展版本(不会自动激活)。上传后需使用 deploy 命令激活。

shell
shoplazza checkout-extension push --name <扩展名> [flags]

Flags​

Flag类型说明
--namestring扩展名称(./extensions 下的目录名)——必填
--versionstring可选。推送前将此版本号写入 extension.json(必须大于上次推送的版本号)
--debugbool将详细构建日志输出到 stderr

示例​

shell
shoplazza checkout push --name my-ext
shoplazza checkout push --name my-ext --version 1.1

deploy​

在当前店铺激活一个已推送的扩展版本。在终端中,该版本替换线上 Checkout 扩展前会请你确认;非交互运行和 --dry-run 跳过确认。

shell
shoplazza checkout-extension deploy --extension-id <id> --version <版本号>

Flags​

Flag类型说明
--extension-idstring服务端扩展 ID
--versionstring要激活的版本号,如 1.0(通过 checkout versions 解析为服务端 ID)
--dry-runbool仅打印将要发送的请求,不实际执行

示例​

shell
shoplazza checkout deploy --extension-id abc123 --version 1.0

undeploy​

在当前店铺取消部署扩展(扩展级别操作,立即停止生效)。在终端中会先请你确认;非交互运行和 --dry-run 跳过确认。

shell
shoplazza checkout-extension undeploy --extension-id <id>

Flags​

Flag类型说明
--extension-idstring服务端扩展 ID——必填
--dry-runbool仅打印将要发送的请求,不实际执行

示例​

shell
shoplazza checkout undeploy --extension-id abc123

list​

列出当前店铺的 Checkout 扩展。默认仅显示已发布的扩展。

shell
shoplazza checkout-extension list [flags]

Flags​

Flag类型说明
--all, -abool列出所有扩展(不仅限于已发布的)
--dry-runbool仅打印将要发送的请求,不实际执行

示例​

shell
shoplazza checkout list
shoplazza checkout list --all

versions​

列出 Checkout 扩展的版本。

shell
shoplazza checkout-extension versions --extension-id <id>

Flags​

Flag类型说明
--extension-idstring服务端扩展 ID(可通过 checkout list 获取)——必填
--dry-runbool仅打印将要发送的请求,不实际执行

示例​

shell
shoplazza checkout versions --extension-id abc123

preview​

在当前店铺为扩展版本生成店面预览 URL。

shell
shoplazza checkout-extension preview --extension-id <id> --version <版本号>

Flags​

Flag类型说明
--extension-idstring服务端扩展 ID
--versionstring要预览的版本号,如 1.0(通过 checkout versions 解析为服务端 ID)
--dry-runbool仅打印将要发送的请求,不实际执行

示例​

shell
shoplazza checkout preview --extension-id abc123 --version 1.0