用途:在编写或重构 TypeScript/React(.ts/.tsx)代码时提供一套严格、可复用的规范,适用于将内联类型迁移到 types/ 目录、统一类型命名与结果结构,以及在 Next.js 项目中处理特殊文件的额外导出。
主要能力:强制每个自有模块只导出一个符号;禁止在组件、hooks、utils、services、路由处理器中内联 interface/type;共享类型放在 types/<area>/... 下且每个文件一个类型;避免用 barrel 文件(index.ts)隐藏依赖;有意义的改动后运行项目标准检查(如 yarn check:all)。
Next.js 特殊文件例外:app//page.tsx、app//layout.tsx 允许默认导出加 metadata/generateMetadata/viewport 等;app/api/**/route.ts 允许多个 HTTP 方法导出和路由配置导出。
规则分组:TypeScript 标准包括 ts-language-style(语言与风格,interface 与 type、const 与 let、仅英文)、ts-one-thing-per-file(严格一文件一事)、ts-nextjs-exceptions、ts-types-strict(严格类型,禁止内联类型)、ts-helpers-strict(组件/hooks 中禁止辅助函数)、ts-nextjs-hygiene、ts-validation(改动后运行检查)。类型约定包括 types-one-type-per-file、types-naming-patterns(Params、Result、Error、Props)、types-result-shape(可能失败的边界使用 Result 结构)、types-where-allowed。
使用方式:阅读各规则文件获取详细说明与代码示例,如 rules/ts-one-thing-per-file.md、rules/ts-types-strict.md、rules/types-one-type-per-file.md,每个规则文件包含原因说明、正误代码示例与最佳实践。相关技能有 busirocket-core-conventions、busirocket-react-components-and-hooks、busirocket-refactor-workflow。
限制:资料未提供具体安装命令、收费方式、支持平台或效果数据,暂未提供。