SuperAPI AI 工具集

angular-best-practices-rules-reviewer

编程与开发

查看项目

更新于 10-15 14:16

技能介绍

用途

该技能是一个规则审查智能体(Rules Reviewer Agent),专门用于审查 Angular 最佳实践规则文件,判断每条规则是否真实、准确、有价值。它面向 angular-best-practices 项目的贡献者,而非 Angular 应用开发者。

主要能力

审查流程包含四个环节:

  1. 有效性检查(Validity Check)——判断“这是真实规则吗?”:搜索 Angular 官方文档(angular.dev)中的指导,查找社区共识(博客、会议演讲、GitHub 讨论),确认该模式是被推荐还是被劝阻,标记看似编造或与最佳实践相矛盾的规则。

  2. 准确性检查(Accuracy Check)——判断“代码正确吗?”:验证代码示例能在 Angular 17+ 下编译和运行,检查是否使用已弃用 API 或过时语法,确保示例真正演示了问题与解决方案。

  3. 实用性检查(Usefulness Check)——判断“AI 真的需要这条规则吗?”:按四项标准评估,每项给出 Keep/Improve/Remove 评级,并统计 Keep 数量(0-4 分)。4/4 为高价值规则,保持原样;2-3/4 为有用但可能需改进;0-1/4 考虑移除或合并。

  4. 格式检查(Format Check)——判断“是否符合标准?”:读取 config/criteria.json 获取确切的格式阈值。

使用方式

该技能提供多种审查命令:

  • 单条规则审查:Review rules/typescript/ts-readonly.md,执行完整的有效性、准确性、价值与格式检查并附带研究。
  • 批量审计:Audit all rules in rules/core/,审查多条规则,批量审计输出模板见 prompts/audit-batch.md。
  • 快速有效性检查:Is rules/angular/signal-computed.md a real best practice?,聚焦有效性并附证据。
  • 重写规则:Rewrite rules/core/pattern-facade.md to be more actionable,根据审查发现改进规则。
  • 技能质量审查:审查 SKILL.md 文件(非规则文件)时,读取 references/skill-best-practices.md 获取质量标准,评估 frontmatter、目录结构、指令语气和负面触发条件。

可用工具包括 WebSearch(查找 Angular 文档与社区共识)、WebFetch(读取 angular.dev 文档、GitHub 讨论、博客文章)、Read(检查规则文件内容)、Grep/Glob(查找代码库中的相关规则或模式)。

输出格式为每条规则生成结构化审查,包含实用性评估表格、有效性(VALID/QUESTIONABLE/INVALID)、准确性(ACCURATE/OUTDATED/INCORRECT)、格式(PASS/MINOR ISSUES/MAJOR ISSUES)以及最终裁决(KEEP/IMPROVE/REMOVE)和具体建议。

适用场景

适用于 angular-best-practices 项目的规则维护与质量把控,包括单条规则审查、批量规则审计、快速有效性验证、规则重写以及 SKILL.md 技能质量审查。

限制

该技能不适用于 Angular 应用开发。审查时需遵循若干准则:代码块质量优先于数量,规则不必同时提供错误与正确示例,单个正确示例即可;1-2 个代码块为上限,更少更清晰时优先。某些规则更适合纯文本格式(如单一语法差异、命名约定、信息性指导)。需要同时展示错误与正确示例的情况包括:区别微妙但关键(如 RxJS 中 catchError 的位置)、反模式常见且 AI 频繁生成、性能或缺陷影响不对比不明显、操作符选择重要(如 mergeMap 与 switchMap)。代码示例最佳实践为每块 2-3 行、包含解释原因的内联注释、展示最少必要代码、使用真实但简单的变量名;臃肿迹象包括代码块超过 5 行、同一模式多个变体、掩盖核心模式的样板代码、展示 3 种以上相同做法。应标记移除的规则包括:基础计算机科学知识(提前退出、Set 与 Array 查找)、基础 JS 模式(闭包机制、函数引用稳定性)、TypeScript 默认行为(AI 已使用的类型推断)、Angular 文档已充分覆盖的内容。决策标准必须具体,例如“当组件编排 3 个以上服务且存在相互依赖的异步操作时使用”,而非“有复杂状态时使用”。批准规则前需对照真实 Angular 文档验证:搜索 angular.dev 相关主题、检查 Angular 是否有官方指导、若官方文档已充分覆盖则规则应提供独特价值、若规则与官方文档矛盾则标记。