@ commerce-klaus/ typescript- sfcc (中文(简体) )
TypeScript工具用于销售力量商业云盒项目. 它提供弹匣感知编辑器分辨率,命令行类型检查,以及项目特定生成类型,而SFCC运行时代码仍为JavaScript并带有JSDoc.
要点
- 决定:
dw/*, (中文(简体) ),*/, (中文(简体) ),~/,弹匣别名,以及module.superModule - 使用类型Script 5.5–6或类型Script 7.1+本地 API 检查墨盒
- 生成自定义属性、 钩子、 自定义 API 和自定义工作步骤的类型, 并带有可覆盖的块项类型
- 验证钩登记和静态可探测出口
商业克劳斯说
官方销售力量B2C商业IDE扩展 是脚本 API IntelliSense 和标准墨盒的首选基础 vS代码中的模块分辨率。 范围更广 销售力 B2C 开发者工具 也将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。 。 。 .
pnpm add -D @commerce-klaus/typescript-sfcc typescript @salesforce/b2c-cli
npm install -D @commerce-klaus/typescript-sfcc typescript @salesforce/b2c-cli
yarn add -D @commerce-klaus/typescript-sfcc typescript @salesforce/b2c-cli
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数字 :
{
"compilerOptions": {
"plugins": [{ "name": "@commerce-klaus/typescript-sfcc" }]
}
}
该插件与
官方销售力量 B2C 商务 VS 代码扩展。 。 。 .
销售力量的现有语文服务决议优先
Klaus 填补未解决的模块并添加生成的项目申报和
module.superModule 支助.
TypeScript 7.1 使用本地语言服务器,不再装入 tsserver 插件 。 CLI 和类型生成器支持 TypeScript 7.1+, 但编辑器 插件目前需要 TypeScript 5.5–6. 仅使用CLI和 发电机可以采用 TypeScript 7.1 不安装更旧的项目 编译器.
同步类型并运行墨盒类型检查 :
pnpm exec sfcc-ts-sync-types
pnpm exec sfcc-ts-typecheck
npm exec -- sfcc-ts-sync-types
npm exec -- sfcc-ts-typecheck
yarn exec sfcc-ts-sync-types
yarn exec sfcc-ts-typecheck
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 和生成类型参考。 。 。 .
许可证
麻省理工学院