code-to-chart(亦称 Diagram Maker)用于将代码仓库中的 import/依赖关系自动转换为图表,帮助开发者直观理解项目结构。
用途 从代码静态解析结果生成三类图:架构图(模块/目录级依赖关系)、流程图(文件级 import 调用链路)、组织架构图(目录/文件层级结构)。
主要能力
- 支持语言:Python、JavaScript、TypeScript、Go、Java。
- 解析方式:Python 使用 ast 模块解析 import 与 from ... import;JS/TS、Go、Java 使用正则匹配 import、require、export from 等语句,并将 import 路径映射到项目内实际文件。
- 输出格式:Mermaid 文本(.mmd)或 SVG 图片(需系统安装 mmdc),也可同时输出两者。
- 支持以 JSON 输出分析结果。
- 扫描时递归遍历目录,跳过 node_modules、.git、pycache 等目录。
使用方式 基础用法:python3 scripts/analyze_codebase.py /path/to/project,输出三张 Mermaid 图到 stdout,并写入当前目录下的 .mmd 文件。 可用 --type/-t 指定图表类型(architecture、flowchart、org、all,默认 all)。 可用 --output/-o 指定输出目录,--format/-f 指定格式(mermaid、svg、both,默认 mermaid)。 可用 --max-files 限制最大扫描文件数(默认 500),--max-depth 限制组织架构图最大深度(默认 4)。 可用 --json 以 JSON 格式输出分析结果。
适用场景 快速了解陌生项目的模块结构、代码审查时可视化依赖关系、编写技术文档中的架构图、发现循环依赖或过度耦合、项目重构前的结构分析。
依赖与限制 需要 Python 3.7+,仅用标准库;SVG 输出需可选安装 @mermaid-js/mermaid-cli(mmdc)。仅分析静态 import 关系,不追踪动态导入;大型项目建议用 --max-files 限制扫描范围;Mermaid 图节点过多时可能渲染困难,建议配合 --type 分开查看。