SuperAPI AI 工具集

code-quality-fix-all

编程与开发

查看项目

更新于 10-16 06:09

技能介绍

用途

code-quality-fix-all 是一个代码质量修复技能,用于系统性地修复代码质量审查中识别出的问题。它针对由 code-quality-review-all 技能发现的、存储在 agent_artefacts/code_quality/<topic>/ 目录下的代码质量问题,适用于任意代码质量主题,并在修复过程中进行验证与测试。

主要能力

  • 读取主题目录下的 README.md、results.json 和 SUMMARY.md,理解问题类型、检测方式与修复模式。
  • 根据 results.json 中的 issue_description 与 suggested_fix,以及 README.md 中的修复示例,将问题按修复复杂度分类为简单、中等、困难。
  • 通过 AskUserQuestion 工具交互式收集筛选条件:要针对的问题类型、修复复杂度级别、要修复的评估项、单次运行最多修复的问题数量。
  • 在修复前验证每个问题的上下文、建议修复方案与变更范围;当单个问题的变更超过 100 行时向用户告警并获取明确批准。
  • 创建新分支(命名类似 agent/<short_description_of_issue>),逐个评估项、按问题类型分组应用修复。
  • 运行仓库 linter(如 ruff、flake8、mypy 等)与单元测试(pytest)验证修改,处理测试失败,必要时回滚。
  • 更新 results.json 中的 fix_status 字段,重新运行代码质量审查,比较修复前后结果,处理新增或剩余问题。
  • 更新主题的 README.md 与 SUMMARY.md,记录新知识与最近修复历史。
  • 创建或更新累积性的 PR_DESCRIPTION.md,汇总所有修复会话的变更,并向用户展示结果。

使用方式

调用该技能时需传入代码质量主题路径作为参数,例如 agent_artefacts/code_quality/private_api_imports。若未提供,技能会向用户询问主题路径。主题路径内包含:README.md(问题描述与修复示例)、results.json(全部已识别问题列表)、SUMMARY.md(问题摘要)。筛选与选项在技能启动后通过 AskUserQuestion 工具交互式呈现,除非已在参数中指定。

工作流程分为六个阶段:

  1. 理解主题与规划:阅读主题文档,读取 results.json,分析并分类问题,询问用户筛选偏好,展示筛选后的计划并请求最终确认,验证对修复方式的理解。
  2. 修复前验证:阅读并理解问题所在文件的完整上下文,验证建议修复方案,估算变更范围,对超过 100 行的变更向用户告警并获取批准。
  3. 应用修复:创建新分支,逐个评估项、按问题类型分组处理,使用 Edit 工具应用修改,跟踪进度,验证文件语法有效。
  4. 测试与验证:运行 linter 与单元测试,处理测试失败,区分由修复引起的失败与既有失败。
  5. 重新审查并处理剩余问题:更新 results.json 的 fix_status 字段,使用 Task 工具启动子代理重新运行 code-quality-review-all,比较修复前后结果,处理新增或剩余问题,更新 README.md 与 SUMMARY.md,运行 markdown linter。
  6. 创建 PR 描述并展示结果:创建或更新累积性的 PR_DESCRIPTION.md,向用户展示本次运行与累积进度,不自动提交,提供后续步骤建议。

测试命令示例(来自资料):

# Install relevant packages in the event of import failure
uv sync --group test

# Run tests for a specific evaluation
uv run pytest tests/<evaluation_name>/

# Run a specific test file
uv run pytest tests/test_file.py

# Run a specific test
uv run pytest tests/test_file.py::TestClass::test_method

# Run slow tests (excluded by default)
uv run pytest --runslow tests/

# Skip dataset download tests
uv run pytest -m 'not dataset_download' tests/

# Run only slow tests
uv run pytest -m slow tests/

测试标记包括:@pytest.mark.slow(超过 10 秒的测试)、@pytest.mark.dataset_download(下载数据集的测试)、@pytest.mark.docker(使用 Docker 的测试)、@pytest.mark.huggingface(HuggingFace 相关测试)。

适用场景

  • 在代码质量审查完成后,需要批量修复已识别的问题。
  • 需要按复杂度分级、分批次迭代修复代码质量问题(先简单、再中等、后困难)。
  • 需要在修复过程中同步进行 lint 与单元测试验证,确保不引入回归。
  • 需要生成累积性的 PR 描述,跟踪多次修复会话的总体进展。

限制

  • 不运行完整评估(除非用户明确要求),仅运行单元测试。
  • 不自动提交更改,需用户先审查。
  • 不提交 PR_DESCRIPTION.md,该文件仅用于创建 PR 描述。
  • 不删除 results.json 中的任何条目,仅添加或更新 fix_status 字段;results.json 由 code-quality-review-all 技能负责移除条目。
  • 不修复无法验证的问题,宁可跳过也不冒险破坏代码。
  • 不进行无关更改,仅修复特定的质量问题。
  • 不假设同一类型的所有问题完全相同,需考虑上下文差异。
  • 对于修复方式不明确的问题类型,需研究正确方法并更新 README.md,若仍不确定则向用户寻求指导。
  • 关于该技能的具体收费、价格、支持平台等信息,资料中暂未提供。