# @commerce-klaus/typescript-sfcc 中文文档

规范地址：https://npmcn.com/package/%40commerce-klaus/typescript-sfcc/

版本：1\.8\.1
npm 元数据更新时间：2026-11-06T21:09:21.583Z
中文译文更新时间：2026-11-10T14:13:11.538Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40commerce-klaus/typescript-sfcc
原文对照：https://npmcn.com/package/%40commerce-klaus/typescript-sfcc/?lang=original
项目主页：https://commerce-klaus.github.io/commerce-klaus/packages/typescript-sfcc/
源码仓库：https://github.com/commerce-klaus/commerce-klaus

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：275 kB，45 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：typescript \>=5\.5\.0 \<7 \|\| \>=7\.1\.0-beta \<8，@salesforce/b2c-cli \>=1\.18\.0
- 首次发布：2026-06-29T11:01:20.250Z
- 最新版本发布：2026-11-06T21:09:21.036Z
- 近 30 天下载量：2124（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：26（近 12 个月 26 个）

## 中文简介

销售部队商业云盒项目的脚本工具

## 安装

```sh
npm install @commerce-klaus/typescript-sfcc
```

也可以使用：`pnpm add @commerce-klaus/typescript-sfcc`、`yarn add @commerce-klaus/typescript-sfcc`、`bun add @commerce-klaus/typescript-sfcc`

## README

[![NPM version](https://badgen.net/npm/v/@commerce-klaus/typescript-sfcc)](https://www.npmjs.com/package/@commerce-klaus/typescript-sfcc) [![Downloads](https://badgen.net/npm/dw/@commerce-klaus/typescript-sfcc)](https://www.npmjs.com/package/@commerce-klaus/typescript-sfcc)

# @ commerce-klaus/ typescript- sfcc (中文(简体) )

TypeScript工具用于销售力量商业云盒项目. 它提供弹匣感知编辑器分辨率,命令行类型检查,以及项目特定生成类型,而SFCC运行时代码仍为JavaScript并带有JSDoc.

## 要点

-   决定: `dw/*`, (中文(简体) ), `*/`, (中文(简体) ), `~/`,弹匣别名,以及 `module.superModule`
-   使用类型Script 5.5–6或类型Script 7.1+本地 API 检查墨盒
-   生成自定义属性、 钩子、 自定义 API 和自定义工作步骤的类型, 并带有可覆盖的块项类型
-   验证钩登记和静态可探测出口

## 商业克劳斯说

[官方销售力量B2C商业IDE扩展](https://salesforcecommercecloud.github.io/b2c-developer-tooling/vscode-extension/) 是脚本 API IntelliSense 和标准墨盒的首选基础 vS代码中的模块分辨率。 范围更广 [销售力 B2C 开发者工具](https://salesforcecommercecloud.github.io/b2c-developer-tooling/) 也将XSD schemas捆绑并通过其CLI提供XML验证. 商业 Klaus用这些工具作曲,并增加了生成的项目保证,可以 还运行在编辑器外 :

| 区域 | 商务克劳斯加盟 | 实际福利 |
| --- | --- | --- |
| 项目合同 | 项目元数据, `hooks.json`自定义 API 计划,以及 `steptypes.json` 输入类型脚本声明 | 配置和 JavaScript 执行同时检查 |
| 超级模块 | 决定和类型 `module.superModule` 链条 | 墨水匣的重置仍可导航和类型安全 |
| 类型检查 | 从命令行运行具有墨盒意识的文字编译器 | 同一类的诊断器可以在没有VS代码扩展的情况下屏蔽 CI |
| 登记验证 | 检查 hook 描述符, 引用脚本, 并需要 CommonJS 导出 | 在部署前,损坏的登记失败 |
| 共享工具 | 重复使用相同的墨盒语义, 跨类型Script, ESLint, Vite, Babel, 和 Vitest 套件 | 本地工具商定哪个墨盒执行获胜 |

## 安装

销售力量脚本 API 声明通过 [销售力量 B2C 开发者工具化 CLI](https://salesforcecommercecloud.github.io/b2c-developer-tooling/)。 。 。 .

```bash
pnpm add -D @commerce-klaus/typescript-sfcc typescript @salesforce/b2c-cli
```

```bash
npm install -D @commerce-klaus/typescript-sfcc typescript @salesforce/b2c-cli
```

```bash
yarn add -D @commerce-klaus/typescript-sfcc typescript @salesforce/b2c-cli
```

```bash
vp install -D @commerce-klaus/typescript-sfcc typescript @salesforce/b2c-cli
```

TypeScript 7.1 在β频道时, 替换 `typescript` 与 `typescript@beta` 在您的软件包管理器的命令中.

使用 TypeScript 5.5–6, 可以在墨盒中启用编辑器插件 `jsconfig.json` 或者说 `tsconfig.json`数字 :

```json
{
  "compilerOptions": {
    "plugins": [{ "name": "@commerce-klaus/typescript-sfcc" }]
  }
}
```

该插件与 [官方销售力量 B2C 商务 VS 代码扩展](https://salesforcecommercecloud.github.io/b2c-developer-tooling/vscode-extension/)。 。 。 . 销售力量的现有语文服务决议优先 Klaus 填补未解决的模块并添加生成的项目申报和 `module.superModule` 支助.

TypeScript 7.1 使用本地语言服务器,不再装入 tsserver 插件 。 CLI 和类型生成器支持 TypeScript 7.1+, 但编辑器 插件目前需要 TypeScript 5.5–6. 仅使用CLI和 发电机可以采用 TypeScript 7.1 不安装更旧的项目 编译器.

同步类型并运行墨盒类型检查 :

```bash
pnpm exec sfcc-ts-sync-types
pnpm exec sfcc-ts-typecheck
```

```bash
npm exec -- sfcc-ts-sync-types
npm exec -- sfcc-ts-typecheck
```

```bash
yarn exec sfcc-ts-sync-types
yarn exec sfcc-ts-typecheck
```

```bash
vp exec sfcc-ts-sync-types
vp exec sfcc-ts-typecheck
```

两个独立命令都使用与 B2C 相同的 OClif 命令执行 CLI 插件, 包括 `--help`, (中文(简体) ), `--json`、 始终存在的错误, 以及认识到颜色 终端输出. 类型检查使用项目安装的 TypeScript 编译器, 包括通过 B2C CLI 插件引用时.

销售力扩展提供了编辑器 IntelliSense 但不运行 a 全项目类型脚本检查 。 保留 `sfcc-ts-typecheck` 本地和CI工作流程 用于编辑器外的可复制诊断.

软件包 API 也曝光 `cleanGeneratedTypes()` 只删除四个 具体项目 `sfcc-*.generated.d.ts` 由Commerce Klaus管理的产出。 这个 保持同步的销售力脚本 API 类型和不相关的声明, 并接受 `dryRun: true` 用于只读预览.

## 文档

见 [完整设置、 CLI 和生成类型参考](https://commerce-klaus.github.io/commerce-klaus/packages/typescript-sfcc/)。 。 。 .

## 许可证

麻省理工学院

## 常见问题

### @commerce-klaus/typescript-sfcc 是什么？

销售部队商业云盒项目的脚本工具

### 如何安装 @commerce-klaus/typescript-sfcc？

在项目目录运行 npm install @commerce-klaus/typescript-sfcc，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typescript（\>=5\.5\.0 \<7 \|\| \>=7\.1\.0-beta \<8）、@salesforce/b2c-cli（\>=1\.18\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 sfcc-ts-typecheck、sfcc-ts-sync-types，可以用 npx sfcc-ts-typecheck 直接运行。

### @commerce-klaus/typescript-sfcc 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @commerce-klaus/typescript-sfcc 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @commerce-klaus/typescript-sfcc 可以商用吗？

@commerce-klaus/typescript-sfcc 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @commerce-klaus/typescript-sfcc 的下载量有多少？

根据 npm 官方下载统计，@commerce-klaus/typescript-sfcc 在 2026/10/11 – 2026/11/09 这 30 天内被下载 2,124 次，日均约 71 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @commerce-klaus/typescript-sfcc 还在维护吗？

最新版本 1\.8\.1 发布于 2026/11/07（3 天前）；至今共发布 26 个版本，其中过去 12 个月发布了 26 个；首次发布于 2026/06/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。