mcpField
C
code-auditor

code-auditor

github.com/mhattingpete测试与质量689334 次安装14 周前更新
代码仓库

关于 code-auditor

面向开发者的代码库审计技能,检查架构、质量、安全、性能、测试和可维护性,并将发现整理为含文件行号、优先级和建议的报告。

主要功能

  1. 01架构与设计审查
  2. 02代码质量与重复检查
  3. 03安全与性能分析
  4. 04测试与可维护性评估
  5. 05快速、标准和深入审计
  6. 06提供优先级和行动建议

适用场景

  1. 01重大改动前审查代码库
  2. 02评估安全或性能风险
  3. 03发现技术债务和测试缺口

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/mhattingpete/claude-skills-marketplace --skill code-auditor

安装后在 Claude Code 中输入/code-auditor确认已加载。

详细介绍

代码审计

全面分析代码库,涵盖架构、代码质量、安全性、性能、测试和可维护性。

适用场景

  • “审计代码”
  • “分析代码质量”
  • “检查问题”
  • “审查代码库”
  • “查找技术债务”
  • “安全审计”
  • “性能审查”

分析内容

1. 架构与设计
  • 整体结构与组织方式
  • 使用的设计模式
  • 模块边界与关注点分离
  • 依赖管理
  • 架构决策与权衡
2. 代码质量
  • 复杂度热点(圈复杂度)
  • 代码重复(违反 DRY 原则)
  • 命名规范与一致性
  • 文档覆盖率
  • 代码异味与反模式
3. 安全性
  • 常见漏洞(OWASP Top 10)
  • 输入验证与清理
  • 身份验证与授权
  • 密钥管理
  • 依赖项漏洞
4. 性能
  • 算法复杂度问题
  • 数据库查询优化
  • 内存使用模式
  • 缓存机会
  • 资源泄漏
5. 测试
  • 测试覆盖率评估
  • 测试质量与有效性
  • 缺失的测试场景
  • 测试模式与实践
  • 集成测试与单元测试的平衡
6. 可维护性
  • 技术债务评估
  • 耦合与内聚
  • 后续修改的难易程度
  • 上手友好度
  • 文档质量

方法

  1. 使用 Explore Agent(全面模式)进行探索
  2. 使用 Grep 和 Glob 识别模式
  3. 阅读关键文件,进行详细分析
  4. 如有可用工具,则运行静态分析工具
  5. 汇总发现,形成可执行的报告

详尽程度

  • 快速(15-30 分钟):高层审查,仅关注关键问题
  • 标准(30-60 分钟):全面覆盖所有维度
  • 深入(60 分钟以上):彻底审查,并提供详细示例

输出格式

# Code Audit Report

## Executive Summary
- Overall health score
- Critical issues count
- Top 3 priorities

## Findings by Category

### Architecture & Design
#### 🔴 High Priority
- [Finding with file:line reference]
  - Impact: [description]
  - Recommendation: [action]

#### 🟡 Medium Priority
...

### [Other categories]

## Prioritized Action Plan
1. Quick wins (< 1 day)
2. Medium-term improvements (1-5 days)
3. Long-term initiatives (> 5 days)

## Metrics
- Files analyzed: X
- Lines of code: Y
- Test coverage: Z%
- Complexity hotspots: N

使用的工具

  • Task(Explore Agent):全面探索代码库
  • Grep:匹配问题模式
  • Glob:按类型/模式查找文件
  • Read:详细分析文件
  • Bash:运行代码检查工具、覆盖率工具

成功标准

  • 全面覆盖全部六个维度
  • 所有发现均提供具体的文件:行号引用
  • 标注严重程度/优先级(严重/高/中/低)
  • 提供可执行的建议(而不只是观察结果)
  • 估算修复工作量
  • 兼顾快速见效的改进与长期改进

集成

  • feature-planning:规划技术债务削减工作
  • test-fixing:解决已发现的测试缺口
  • project-bootstrapper:配置质量工具

配置

可重点关注特定领域:

  • 仅审计安全性
  • 仅审计性能
  • 仅评估测试
  • 快速审查架构

评论

支持 Markdown