SuperAPI AI 工具集

busirocket-core-conventions

编程与开发

查看项目

更新于 10-15 17:30

技能介绍

用途:提供与项目无关、可复用的工程约定,让代码库更易扩展,也更方便 AI 代理阅读与导航。适合在开发新功能、决定代码位置、重构以提升可维护性、强制“一文件一事”纪律,以及建立命名与布局约定和边界规则时使用。

主要能力:强制要求保持多个小而聚焦、边界明确的文件;自有模块每个文件只导出一个符号(组件、hook、函数或类型);禁止用 barrel/index 文件隐藏依赖;禁止在 types/ 之外写内联类型;禁止在组件或 hook 内放辅助函数,应抽取到 utils/;不为琐碎辅助函数新增依赖,除非明确批准。还提供边界与放置规则:路由/页面放 app/**,可复用 UI 放 components/<area>/...,编排(状态/副作用)放 hooks/<area>/useXxx.ts,纯逻辑放 utils/<area>/xxx.ts,外部边界(网络/数据库/认证/存储)放 services/<area>/xxx.ts,共享形状放 types/<area>/Xxx.ts。

规则结构:包含核心原则(代理默认行为、代码风格、仓库卫生)、边界与放置(决策树、硬性规则)、命名与布局(文件夹、文件命名、导出、导入)、services 与 utils 的区分(契约、API、路由处理器)、以及反模式(文件结构、类型、React、App Router、依赖、Vite/浏览器运行时)。相关技能包括 TypeScript 标准、React 模式与重构工作流。

使用方式:阅读各规则文件以获取详细说明与代码示例,例如 rules/core-agent-defaults.md、rules/core-boundaries-decision-tree.md、rules/core-naming-folder-layout.md。每个规则文件包含重要性说明、正确与错误代码示例以及最佳实践。

限制:资料未提供安装命令、平台要求、价格或具体配置方式,暂未提供。