SuperAPI AI 工具集

code-reuse-enforcement

通用与其它

查看项目

更新于 10-16 00:04

技能介绍

用途:这是 AIDB 代码库的关键护栏技能,核心目标是防止代码重复与魔法字符串、魔法数字散落各处。它要求在编写任何含字面量或工具函数的代码之前,先发现并复用已有实现。

主要能力:提供“发现优先”工作流,依次检查常量(URL、路径、超时、限制、环境变量名)、枚举(状态、类型、动作)和工具函数(路径操作、环境读取、文件操作、校验)。文档给出常见违规示例与正确写法对照,涵盖魔法字符串、魔法数字、重复实现工具函数、用字符串表示状态四类问题。

使用方式:先查阅 discovery-catalog.md 快速参考;按表格定位常量文件(如 aidb_common/constants.py、aidb/dap/client/constants.py、aidb/common/constants.py、aidb_mcp/core/constants.py、aidb_cli/core/constants.py)和工具包(aidb_common.io、aidb_common.path、aidb_common.env、aidb_common.validation 等)。可用搜索命令查找已有定义:grep -r "value_to_find" src --include="*.py"、find src -name "constants.py"、grep -r "class.Enum" src --include=".py" -l。

适用场景:AIDB 代码库内的开发与提交环节。仅在概念全新、会被复用两次以上、位置正确且符合命名规范时才创建新常量。提交前需通过检查清单:无硬编码 URL、无硬编码路径、超时不用魔法数字、状态不用字符串字面量、不重复实现工具函数、不手动解析环境变量。

限制:该技能针对特定 AIDB 代码库,其他项目需自行调整;资料未提供安装命令、收费或平台信息。