iSkills 原始文档
🔧

code-reviewer

Top Agent Skill


code-reviewer

Skill 简介

在现代软件开发中,代码审查是确保代码质量、安全性和可维护性的关键环节。然而,随着项目规模的扩大和代码库的复杂度增加,手动审查变得越来越耗时且容易出错。code-reviewer(也称为 Lens)是一款基于 OpenClaw 平台的 AI 代码审查工具,旨在帮助开发者高效地发现代码中的缺陷、安全漏洞和逻辑错误。它通过模拟经验丰富的工程师的审查过程,为开发者提供详细的反馈和改进建议。

Lens 的核心目标是提升代码质量,减少潜在风险,并帮助团队在开发过程中持续改进。通过自动化代码审查,Lens 不仅能节省宝贵的时间,还能提供一致且可靠的审查结果,使得团队能够专注于更具创造性的开发任务。

主要功能

1. 缺陷与漏洞检测

Lens 能够扫描代码库,识别潜在的 bug、安全漏洞和逻辑错误。无论是常见的编码错误还是复杂的安全隐患,Lens 都能提供详细的检测报告。例如,它会标记出可能导致缓冲区溢出的代码段,或指出可能引发 SQL 注入的漏洞。

2. 严重程度分级

Lens 对检测到的每个问题进行严重程度分级,包括以下几种:
- 严重(Critical):需要立即修复的高风险问题,例如安全漏洞或关键功能缺陷。
- 警告(Warning):可能影响代码稳定性的问题,例如性能瓶颈或潜在的运行时错误。
- 建议(Suggestion):改进代码质量和可读性的建议,例如代码重构或命名优化。
- 细节( Nitpick):代码风格或格式上的小问题,例如多余的空格或未使用的变量。

3. 修复示例与解释

Lens 不仅指出问题,还会提供具体的修复示例和详细的解释。这有助于开发者快速理解问题的根源,并采取有效的修正措施。例如,对于一个性能瓶颈问题,Lens 可能会建议使用更高效的数据结构,并附上相应的代码示例。

4. 优秀实践高亮

除了指出问题,Lens 还会高亮显示代码中做得好的部分,例如良好的错误处理、清晰的注释或有效的测试用例。这有助于开发者了解哪些做法值得保持,并促进团队内部的最佳实践分享。

5. 集成与扩展

Lens 支持与多种开发工具和平台集成,包括 GitHub、GitLab 等。通过与版本控制系统集成,Lens 可以在代码合并前进行自动审查,确保只有高质量的代码进入主分支。此外,Lens 还支持自定义规则和扩展,允许团队根据自身需求调整审查标准。

使用场景

1. 代码合并前审查

在代码合并前,使用 Lens 对拉取请求(PR)进行审查,确保代码质量和安全性。例如:

openclaw chat code-reviewer "Review this PR: [paste diff]"

Lens 会生成详细的审查报告,指出潜在的问题和改进建议。

2. 安全性审计

针对关键模块或敏感功能,使用 Lens 进行专门的安全性审查。例如:

openclaw chat code-reviewer "Is this authentication code secure?"

Lens 会扫描代码,识别潜在的安全漏洞,如密码计时攻击、硬编码的密钥或缺少速率限制等问题。

3. 代码质量评估

定期对代码库进行质量评估,识别复杂性问题、重复代码和测试覆盖不足的地方。例如:

openclaw chat code-reviewer "Rate this code quality A-F"

Lens 会生成整体质量评分,并提供详细的改进建议。

4. 持续集成(CI)集成

将 Lens 集成到持续集成流程中,实现自动化代码审查。例如,在每次提交或合并前,Lens 都会自动运行审查,确保代码符合质量标准。

5. 团队协作与知识共享

通过 Lens 的审查报告,团队成员可以分享最佳实践,讨论复杂问题,并共同改进代码质量。Lens 的高亮功能还可以帮助新成员快速了解团队的编码规范和最佳实践。

如何使用

安装与配置

首先,确保已安装 OpenClaw 平台。然后,按照以下步骤安装 Lens:

mkdir -p ~/.openclaw/agents/code-reviewer/agent
cp SOUL.md ~/.openclaw/agents/code-reviewer/agent/

openclaw agents add code-reviewer --workspace ~/.openclaw/agents/code-reviewer

首次使用

使用以下命令启动首次对话,并粘贴代码差异进行审查:

openclaw chat code-reviewer "Review this PR: [paste diff]"

前置条件

示例

示例 1:拉取请求审查

假设你有一个拉取请求的代码差异,可以按照以下步骤进行审查:

openclaw chat code-reviewer "Review this PR: [paste diff]"

Lens 可能会生成如下报告:

Code Review - checkout/route.ts
Overall: B+

CRITICAL (1):
Line 28: Metadata overflow risk with large configs
→ Fix: metadata: { type }

WARNING (1):
Line 24: Timeout too low (10s)
→ Fix: Increase to 15s with retry

GOOD: Clean error handling, proper status codes

示例 2:安全性审查

对于一段认证代码,可以进行如下安全性审查:

openclaw chat code-reviewer "Is this authentication code secure?"

Lens 可能会生成如下报告:

Security - auth/login.ts

CRITICAL: Password timing attack (line 45)
CRITICAL: Hardcoded JWT secret (line 72)
WARNING: No rate limiting on login
WARNING: Error reveals email existence

CLEAN: Input validation, parameterized SQL, CORS

总结

code-reviewer 是一款功能强大的 AI 代码审查工具,能够帮助开发者快速识别代码中的缺陷、安全漏洞和逻辑错误。通过提供详细的审查报告和修复建议,Lens 显著提升了代码质量和开发效率。无论是在代码合并前进行审查,还是进行专门的安全性审计,Lens 都能为团队提供可靠的支持。对于希望提升代码质量和安全性的开发者来说,code-reviewer 是一个不可或缺的工具。

GitHub 参考 iSkills 专业中文解析 · 2026-03-22 更新

探索更多 Top Agent Skills