mcpField
A
analyze-codebase

analyze-codebase

github.com/shipshitdev开发3893 次安装2 天前更新
代码仓库

关于 analyze-codebase

面向开发者的代码库分析技能,适用于新人熟悉项目、架构文档编写和项目健康评估。它从结构发现延伸到改进建议,并将报告写入 `.agents/memory/codebase-analysis.md`。

主要功能

  1. 01项目结构与文件计数
  2. 02模块、入口和 API 梳理
  3. 03模式、安全与依赖审查
  4. 04结构化分析报告
  5. 05快速分析模式

适用场景

  1. 01帮助开发者熟悉代码库
  2. 02编写项目架构文档
  3. 03重构前评估项目健康状况

安装

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

$npx skills add https://github.com/shipshitdev/skills --skill analyze-codebase

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

附带文件plugin.json

详细介绍

代码库分析

适用场景

  • 新开发者入职
  • 架构文档编写
  • 项目健康状况评估
  • 重大重构前
  • 了解系统复杂度

分析流程

第 1 步:发现
# Project structure
tree -L 3 -I 'node_modules|.next|dist|build|coverage'

# File counts
find . -type f -name "*.ts" | wc -l
find . -type f -name "*.tsx" | wc -l
第 2 步:架构分析
  • 识别模块、入口点和 API 结构
  • 梳理前端组件和路由
  • 记录服务模式和约定
第 3 步:模式和规范
  • 检查文档/示例中已有的模式
  • 分析类型系统的组织方式
  • 审查安全模式(身份验证、多租户、软删除)
第 4 步:依赖项
  • 列出外部服务和库
  • 检查版本是否为最新
  • 识别关键依赖项
第 5 步:生成报告

将报告写入 .agents/memory/codebase-analysis.md,并包含以下部分:

  1. 执行摘要 — 3-5 句概述
  2. 项目概览 — 技术栈、用途、架构风格
  3. 目录结构 — 模块布局和组织方式
  4. 架构模式 — 后端和前端模式
  5. 安全分析 — 身份验证、数据隔离、校验
  6. 性能洞察 — 数据库、缓存、后台任务
  7. 代码质量 — 优势、改进空间、技术债务
  8. 依赖项 — 关键包和版本矩阵
  9. 测试策略 — 覆盖率、模式、缺口
  10. 建议 — 立即、短期和长期建议

快速模式

若要加快分析(跳过详细指标):

tree -L 3 -I 'node_modules|.next|dist'
echo "TypeScript: $(find . -name '*.ts' -o -name '*.tsx' | wc -l)"
echo "Controllers: $(find . -name '*.controller.ts' | wc -l)"
echo "Services: $(find . -name '*.service.ts' | wc -l)"

评论

支持 Markdown