SuperAPI AI 工具集

ha-quality-scale-verify

编程与开发

查看项目

更新于 10-16 06:03

技能介绍

用途

ha-quality-scale-verify 用于验证某个 Home Assistant 集成是否遵循特定的质量量表(Quality Scale)规则,检查其是否实现了规则所要求的模式、配置或代码。它一次验证一条规则;若要检查完整的一个质量层级,则需对该层级的每条规则分别验证,在可能时可使用并行子代理运行。

主要能力

  1. 获取规则文档:从 https://raw.githubusercontent.com/home-assistant/developers.home-assistant/refs/heads/master/docs/core/integration-quality-scale/rules/{rule_name}.md 获取官方规则文档,其中 {rule_name} 为规则标识符(例如 config-flow、entity-unique-id、parallel-updates)。
  2. 理解规则要求:解析规则文档,识别核心要求与强制实现、所需的特定代码模式或配置、常见违规与反模式、豁免条件(规则可能不适用的情况),以及该规则所属的质量层级(Bronze、Silver、Gold、Platinum)。
  3. 分析集成代码:检查位于 homeassistant/components/<integration domain> 的集成代码库,重点关注 manifest.json 中的质量量表声明与配置、quality_scale.yaml 中的规则状态(done、todo、exempt)、依据规则要求相关的 Python 模块,以及所需的配置文件和 service 定义。
  4. 其他信息来源:集成文档取自 https://raw.githubusercontent.com/home-assistant/home-assistant.io/refs/heads/current/source/_integrations/<integration domain>.markdown;PyPI 包信息取自 https://pypi.org/pypi/<package>/json。

使用方式

验证过程如下:

  • 检查规则在 quality_scale.yaml 中被标记为 done、todo 还是 exempt。
  • 若标记为 exempt,验证豁免理由是否有效。
  • 若标记为 done,验证实际实现是否符合要求。
  • 找出能够证明合规或违规的具体文件和代码段。
  • 应用规则时考虑集成声明的质量层级。
  • 查找规则中指定的确切实现模式。
  • 检查常见错误、反模式、边界情况和错误处理要求。
  • 验证实现是否遵循 Home Assistant 惯例。

质量量表规则是累积的:Bronze 规则适用于所有具有质量量表的集成,Silver 规则适用于 Silver 及以上级别的集成,依此类推。判断应强制执行哪些规则时,始终要考虑集成的目标质量级别。

报告方式

只报告存在问题的规则,不要列出通过或有效豁免的规则。对每条存在问题的规则,提供:

  • Rule:规则标识符及问题(不合规,或无效/不合理的豁免)。
  • Evidence:显示违规的具体文件位置和代码。
  • Recommendation:实现合规的可操作步骤。

如果没有任何规则存在问题,用一行说明即可。要做到全面但聚焦:只检查与被验证规则相关的方面。如果无法访问规则文档或找不到集成代码,需明确说明缺失了哪些信息以及完成验证还需要什么。

适用场景

  • Home Assistant 集成开发者或维护者在提交或评审集成时自检质量量表合规性。
  • 需要逐层核验质量量表时,对同一层级的各条规则并行验证。

限制

  • 该技能一次只验证一条规则,完整质量层级需逐条验证。
  • 若无法访问规则文档或集成代码,验证无法完成,需要补充相应信息。
  • 其他具体限制暂未提供。