SuperAPI AI 工具集

consistent-architecture

编程与开发

查看项目

更新于 10-23 02:48

技能介绍

这是一个用于保持项目架构一致性的技能,核心目标是保留并强化现有架构,避免在没有必要时另建一套并行的结构。

用途 适合在已有代码库中新增模块、移动文件、统一命名或调整分层边界时使用,帮助新代码融入当前结构,而不是形成第二套组织方式。

主要能力

  • 单一职责:每个模块或文件夹只承担一项职责。
  • 单向导入:依赖只能向“内层”指向,例如 UI → 领域 → 基础设施;反向依赖必须通过显式端口。
  • 稳定命名:命名需可预测,同一层不要混用不同约定。
  • 结构延续:新文件遵循现有结构;若结构不合适,应先提出变更,而不是直接分散创建文件。
  • 边界记录:边界变化需写一份简短 ADR,说明背景、决定和影响,放在 docs/adr/ 或仓库中类似目录下。

使用方式

  1. 检查:查看现有文件夹、入口文件、导入方式与命名模式。
  2. 映射:用少量文字画出层、模块和允许的依赖关系。
  3. 对齐:给出新代码在结构中的位置;若与现有结构冲突,说明冲突并请求确认。
  4. 执行:确认后再创建或移动文件。
  5. 记录:若边界发生变化,补充简短 ADR。

检查清单包括:文件夹和名称符合仓库既有模式;没有循环依赖或未经端口“向上”的依赖;新代码没有引入第二套组织风格。

适用场景 适用于有既有架构约定、需要持续维护模块边界和目录规范的工程团队与个人项目。

限制 具体实现语言、工具链、支持平台和收费方式暂未提供;该技能本身不提供自动化代码检查工具,需要结合项目实际约定执行。