前言¶
在智能编码助手(如 Codex、Cursor、Copilot)普及的背景下,如何让 AI 给出的审查意见具备可追溯性和可落地性,是很多开发者关心的问题。brooks-lint 是一个面向编码 Agent 的代码质量审查插件,它将十二本经典工程书籍中的设计原则与常见问题,转化为六个 Agent Skills,用于架构审查、技术债务分析、测试覆盖和修复建议。
下面介绍它的核心能力、安装方式与典型用法。
是什么¶
brooks-lint(作者:hyhmrright)是 DeepSeek Harness 的一个工作流插件,版本 1.9.1,许可证 MIT。它通过十二本经典工程书籍,提炼出六类生产代码衰减风险和六类测试套件衰减风险,对代码进行结构化审查,返回“症状 → 来源 → 后果 → 修复建议”的发现,并附书名引用。
它不依赖静态分析工具的默认指标(如圈复杂度、行数),而是从认知负荷、变更传播、领域模型忠实度等维度诊断代码质量,为智能编码助手提供可引用、可验证的审查意见。
核心功能¶
brooks-lint 提供 six Agent Skills,对应六条斜杠命令:
/brooks-review:对 PR 或代码片段做整体健康度评估,返回健康评分(0–100)与多维度问题列表。/brooks-audit:聚焦架构与技术债务,检查模块边界、依赖方向、领域模型是否合理。/brooks-debt:识别代码中的技术债务点,给出优先级与修复路径。/brooks-test:评估测试覆盖与测试质量,识别缺少测试或测试逻辑薄弱的区域。/brooks-health:快速获取当前代码的健康分数与关键风险摘要。/brooks-sweep:尝试生成修复建议或重构方案。
每个发现都包含:
- 症状:具体代码问题描述。
- 来源:引用的书籍与章节。
- 后果:问题可能带来的影响。
- 修复建议:可执行的改写方案。
它基于以下十二本经典书籍提炼风险维度:
- The Mythical Man-Month(Frederick P. Brooks Jr.)
- Code Complete(Steve McConnell)
- Refactoring(Martin Fowler)
- Clean Architecture(Robert C. Martin)
- The Pragmatic Programmer(Andrew Hunt & David Thomas)
- Domain-Driven Design(Eric Evans)
- A Philosophy of Software Design(John Ousterhout)
- Software Engineering at Google(Winters et al.)
- The Art of Unit Testing(Roy Osherove)
- How Google Tests Software(Whittaker et al.)
- Working Effectively with Legacy Code(Michael Feathers)
- xUnit Test Patterns(Gerard Meszaros)
安装与启用¶
根据使用平台不同,官方提供两种安装方式:
- 通过 Marketplace 安装(Claude Code 等)
/plugin marketplace add hyhmrright/brooks-lint
/plugin install brooks-lint@brooks-lint-marketplace
- 通过脚本安装(Cursor、Codex、Gemini、Copilot、Windsurf、OpenCode、Kiro、Bob 等)
curl -fsSL https://raw.githubusercontent.com/hyhmrright/brooks-lint/main/scripts/install.sh | bash -s -- <platform>
将 <platform> 替换为具体平台名称(如 cursor、codex 等)。
安装完成后,Agent 会识别以下斜杠命令:
/brooks-review/brooks-audit/brooks-debt/brooks-test/brooks-health/brooks-sweep
典型用法¶
安装完成后,可以在对话中直接调用命令,或让 Agent 主动执行。
- 整体健康度审查
/brooks-review
Agent 会返回健康分数(0–100)与多条结构化发现,例如:
- Health Score: 28/100
- Change Propagation — Single Method Changes for Four Unrelated Business Reasons
- Symptom:
update_profile执行了资料中示例代码的更新、通知、积分计算与缓存失效等四个职责。 - Source: Fowler — Refactoring — Divergent Change
- Consequence: 对积分公式的修改可能破坏通知逻辑,每个编辑都伴随跨域回归风险。
- Remedy: 提取
NotificationService、LoyaltyService与UserCacheInvalidator,UserService.update_profile仅做编排。
- 架构与技术债务审计
/brooks-audit
Agent 会从依赖方向、模块边界、领域模型忠实度等角度评估,并给出引用与修复建议。
- 测试覆盖评估
/brooks-test
Agent 会检查测试覆盖与测试质量,指出缺少测试或测试逻辑薄弱的区域,并引用 xUnit Test Patterns 与 The Art of Unit Testing 等书籍中的模式。
- 快速健康摘要
/brooks-health
返回当前代码的健康分数与关键风险摘要,便于快速定位问题。
- 自动修复建议
/brooks-sweep
Agent 会尝试生成修复建议或重构方案,结合书籍中的最佳实践。
适用场景与注意¶
brooks-lint 适合需要让 AI 代码审查具备“可引用、可落地”的工作流场景,例如:
- 对 PR 进行结构化审查,并附带书籍引用。
- 在 CI/CD 中集成健康度检查,为代码质量打分。
- 在团队内部推广工程实践,用经典书籍作为共识基础。
使用时需注意:
- 插件以当前 DSH 进程权限运行,审查结果会依赖 Agent 获取的代码上下文。
- 建议在安装前查看 GitHub 源码与许可证(MIT),确认符合团队规范。
- 评分与发现是示例与启发式判断,需要人工复核后落地。
小结¶
brooks-lint 将经典工程书籍中的经验提炼为可执行的 Agent Skills,为 Codex、Cursor、Copilot 等编码助手提供结构化、可追溯的代码质量审查能力。它不依赖默认指标,而是从认知负荷、变更传播、领域模型等维度诊断代码,帮助团队建立更可靠的代码审查流程。
了解更多:
- GitHub:https://github.com/hyhmrright/brooks-lint
- 目录页:https://www.skillhub.cn/plugins/hyhmrright/brooks-lint