SuperAPI AI 工具集

busirocket-typescript-standards

编程与开发

查看项目

更新于 10-16 08:05

技能介绍

用途:在编写或重构 TypeScript/React 代码(.ts/.tsx)时执行统一的代码规范,让代码库更易维护。适用于将内联类型迁移到 types/ 目录、统一类型命名与结果形状,以及在 Next.js 中处理特殊文件的额外导出。

主要规则(MUST):自有模块每个文件只导出一个符号;组件、hooks、utils、services、路由处理函数中不得内联 interface/type;共享类型放在 types/<area>/... 下,每个文件一个类型;避免用 barrel 文件(index.ts)隐藏依赖;有意义的改动后运行项目标准检查(如 yarn check:all)。

Next.js 特殊文件例外:app//page.tsx、app//layout.tsx 允许 default export 加 metadata/generateMetadata/viewport 等;app/api/**/route.ts 允许多个 HTTP 方法导出和路由配置导出。

规则文件:ts-language-style(interface 与 type、const 与 let、仅英文)、ts-one-thing-per-file(严格)、ts-nextjs-exceptions、ts-types-strict(禁止内联类型)、ts-helpers-strict(组件/hooks 内不放 helper)、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/ 下的单个规则文件获取说明和代码示例,例如 rules/ts-one-thing-per-file.md、rules/ts-types-strict.md、rules/types-one-type-per-file.md。每个规则文件包含原因说明、正确与错误代码示例以及最佳实践。

相关技能:busirocket-core-conventions(文件结构与边界)、busirocket-react(组件与 hook 结构)、busirocket-refactor-workflow(重构流程)。

限制:资料未提供具体实现细节、配置方式、安装命令、适用版本、收费情况或效果数据。