SuperAPI AI 工具集

phase-2-convention

通用与其它

查看项目

更新于 10-16 05:02

技能介绍

该技能用于在项目设计阶段定义编码规则、约定与标准,目的是在与 AI 协作时保持一致的代码风格,明确 AI 编写代码应遵循的规范。触发关键词为 convention、coding style、lint、rules。

主要内容包括:命名规则(组件 PascalCase、函数 camelCase、常量 UPPER_SNAKE_CASE、文件 kebab-case 或 PascalCase);代码风格(缩进、引号、分号等);目录结构(如 components、features、hooks、utils、types);常用代码模式定义。交付物为项目根目录的 CONVENTIONS.md,以及 docs/01-plan/ 下的 naming.md 与 structure.md。

环境变量约定:定义前缀规则,NEXT_PUBLIC_ 为客户端暴露,DB_、API_、AUTH_、SMTP_、STORAGE_ 仅服务端使用;只允许 NEXT_PUBLIC_* 暴露给客户端,密钥与密码必须为服务端变量,敏感信息不得提交到 .env 文件。提供 .env.example(模板,入 Git,值为空)、.env.local(本地开发,被 Git 忽略)等按环境区分的文件结构,并给出基于 zod 的启动时校验示例(envSchema.parse(process.env))。

整洁架构原则:推荐 presentation、application、domain、infrastructure 四层结构,规定各层职责与依赖方向,禁止 presentation 直接依赖 infrastructure,domain 不依赖外部层,并给出允许与禁止的导入规则。

可复用与可扩展原则:函数泛化、组件可组合、props 扩展 HTML 属性、提取函数与组件的判断标准;用配置对象、策略模式、插件结构替代条件与 switch 展开。

按级别应用:Starter 仅基础规则与简单结构,Dynamic 扩展至 API、状态管理及 3-4 层分离,Enterprise 按服务拆分规则并采用严格分层与 DI 容器。规范在第八阶段验证。下一阶段为 Phase 3 原型开发。模板见 templates/pipeline/phase-2-convention.template.md。