SuperAPI AI 工具集

code-standards

智能体与模型

查看项目

更新于 10-16 09:54

技能介绍

用途:生成或更新 docs/code-standards.md,产出项目专属的代码规范文件,供 LLM 在写代码时参考,避免其输出仅符合训练数据平均水平的通用代码。

主要能力:技能按流程工作。首先检测是否已有规范文件(docs/code-standards.md 或旧路径 docs/code-patterns.md,旧文件会迁移重命名)。再依据 <!-- base-commit: ... --> 头部与 git rev-list <base-commit>..HEAD --count 判断新鲜度:0 个提交则跳过并原样返回;1–20 个提交则只更新有变动的部分;21+ 则整体重新扫描生成。无头部、sha 未知或非 git 仓库时按全量生成处理。随后按多个分区扫描代码库,包括禁用模式、错误处理、导入与依赖方向、测试模式、命名、文件组织、技术决策、范例文件等。最后写入文件,写入后自检。

使用方式:由智能体按上述步骤执行,必要时读取 ${CLAUDE_PLUGIN_ROOT}/skills/code-standards/references/section-templates.md 中的分区模板。文件格式含 base-commit 与生成日期头部,核心规则要求每个分区至少含一个代码片段或文件指针,规则与示例分离,示例说明为何有效,只记录偏离主流约定的内容,从真实代码提取而非虚构理想示例,篇幅控制在 300 行以内。写好后不提交该文件。

适用场景:需要为项目建立 LLM 可读的代码规范,或在既有规范基础上按提交差异增量维护。

限制:并非所有分区都适用于每个项目,无有意义约定时可跳过。文件不提交。关于收费、价格、平台支持等未在资料中提供。