@commerce-klaus/sfcc-module-resolver

中文文档
2.2.0发布于 2026/10/30MITTypeScriptESM + CJS构建来源已验证近 30 天下载 2607

共享 SFCC 墨盒路径和模块解析工具

中文使用文档
文档目录4 节
  1. 要点
  2. 安装
  3. 文档
  4. 许可证

NPM version Downloads

@ commerce-klaus/ sfcc-module-resolver (商业-克劳斯语)

用于SFCC弹匣订单、模块分辨率、超级模块和钩子注册的共享节点.js公用事业。 大多数项目通过Commerce Klaus ESLint,TypeScript,Vite,或Babel包间接使用.

要点

  • 从配置、环境、, jsconfig,或 site.xml
  • 解释哪些弹匣命令源获胜, 包括缺少条目和无效倒置
  • 决定: */, (中文(简体) ), ~/,弹匣别名,以及 module.superModule
  • 用每一个尝试的文件路径和选中的匹配来解释解析
  • 为 SFCC 认知工具提供决定性文件系统帮助
  • 将网站元数据中的自定义属性和首选定义规范化
  • 读取并解决弹匣钩注册
  • 以墨盒路径顺序发现有效的钩脚本
  • 读取工作步骤定义、参数、状态代码、执行能力和任务超时 steptypes.json
  • 验证带有结构化诊断的钩子、工作步骤和定制API合同
  • 构建弹匣优先级、超级模块、 SRA 控制器的决定性项目图表 路线、有效的中间软件管道和元数据合同

ModuleResolutionOptions 是 Vite 使用的共享配置类型 还有维特适配器. ResolveCartridgeRootsOptions 以 仅解析器 containingFile 选项.

项目可在 commerce-klaus.config.ts 或者说 commerce-klaus.config.js。软件包选项继续得到支持并覆盖 核心价值观。 公共配置合同居住在 @commerce-klaus/config; 见 项目配置指南。 。 。 .

安装

pnpm add @commerce-klaus/sfcc-module-resolver
npm install @commerce-klaus/sfcc-module-resolver
yarn add @commerce-klaus/sfcc-module-resolver
vp install @commerce-klaus/sfcc-module-resolver
import {
  createModuleResolver,
  explainCartridgeOrder,
  inferCartridgeOrder,
} from "@commerce-klaus/sfcc-module-resolver/resolution"

const cartridgeRoots = inferCartridgeOrder({ cartridgesDir: "cartridges" })
const resolveSfccModule = createModuleResolver(cartridgeRoots)
const orderTrace = explainCartridgeOrder({ cartridgesDir: "cartridges" })

这套软件包为 resolution, (中文(简体) ), object-metadata, (中文(简体) ), hooks, (中文(简体) ), job-steps, (中文(简体) ), custom-apis,以及全项目验证和图表 project。软件包根仅包含分辨率 API.

文档

见 完整 API 和分辨率参考。 。 。 .

许可证

麻省理工学院

版本与发布记录

@commerce-klaus/sfcc-module-resolver 共发布 17 个版本,首次发布于 2026/07/10;过去 12 个月发布了 17 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.2.0latest2026/10/3011 天前
2.1.12026/10/2813 天前
2.1.02026/10/2417 天前
2.0.02026/10/051 个月前
1.9.12026/10/011 个月前
1.9.02026/09/281 个月前

关于 @commerce-klaus/sfcc-module-resolver 的常见问题

@commerce-klaus/sfcc-module-resolver 是什么?

共享 SFCC 墨盒路径和模块解析工具

如何安装 @commerce-klaus/sfcc-module-resolver?

在项目目录运行 npm install @commerce-klaus/sfcc-module-resolver,或使用 pnpm add / yarn add / bun add。

@commerce-klaus/sfcc-module-resolver 支持 TypeScript 吗?

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

@commerce-klaus/sfcc-module-resolver 支持 ESM 还是 CommonJS?

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

@commerce-klaus/sfcc-module-resolver 可以商用吗?

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

@commerce-klaus/sfcc-module-resolver 的下载量有多少?

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

@commerce-klaus/sfcc-module-resolver 还在维护吗?

最新版本 2.2.0 发布于 2026/10/30(11 天前);至今共发布 17 个版本,其中过去 12 个月发布了 17 个;首次发布于 2026/07/10。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。