SuperAPI AI 工具集

setup-ts-deep-modules

编程与开发

查看项目

更新于 10-16 09:29

技能介绍

用途:把仓库中的每个 package 变成 deep module——用小接口隐藏大量实现。package 的公开面是其根目录中的入口文件,所有子文件夹对外隐藏。该技能会安装 dependency-cruiser、加入强制边界规则,并验证规则确实能拦截违规。

主要能力:安装 dependency-cruiser 为开发依赖;复制 .dependency-cruiser.cjs 配置到仓库根目录并设置 PACKAGES_ROOT;加入四条 error 级规则:入口边界(package 外的代码只能导入入口文件)、包内自由(package 自己的文件可互相导入)、测试只能经入口(tests/ 下文件可导入任意 package 的入口和自己的 fixtures,不能深度导入内部)、禁止循环依赖。还会添加 lint:boundaries 脚本并纳入已有的 typecheck 总检查命令;scaffold 一个 example package 作为可复制的模板;写 README 文档说明约定,并在 CLAUDE.md/AGENTS.md 中指向它。

使用方式:由用户手动调用。技能先探测包管理器(pnpm/yarn/bun/npm)与 packages 根目录(有 src/ 用 src/packages,否则用 packages),检查是否已有配置。随后用检测到的包管理器安装 dependency-cruiser,写入 .dependency-cruiser.cjs,接入 lint:boundaries,创建示例包,最后通过临时制造一次深度导入来证明规则生效。

适用场景:需要为 TypeScript 仓库建立可强制执行的模块边界、鼓励多个小入口文件而非 barrel 文件的团队。

限制:packages 为扁平结构,根下只有一层直接子包,包内可任意深但不能嵌套包;公开与私有的划分由路径深度决定,与扩展名无关;分层(哪些包可依赖哪些)不在该技能内,配置中仅保留注释占位。未提供具体命令示例,上文命令均按资料原文保留。