code-to-diagram

コードから図を生成

AST 解析を通じてコードベースからインポートと依存関係を抽出し、次の 3 種類の図を自動生成します。

1. アーキテクチャ図 — モジュール／ディレクトリレベルの依存関係
2. フローチャート — ファイルレベルのインポート呼び出しチェーン
3. 組織図 — ディレクトリ／ファイルの階層構造

対応言語：Python、JavaScript、TypeScript、Go、Java

出力形式：Mermaid テキスト（.mmd）または SVG 画像（システムへの mmdc のインストールが必要）

使い方

基本：プロジェクト全体を解析

python3 scripts/analyze_codebase.py /path/to/project

3 つの Mermaid 図を標準出力に出力し、.mmd ファイルを現在のディレクトリに書き込みます。

図の種類を指定

# Architecture diagram only
python3 scripts/analyze_codebase.py /path/to/project --type architecture

# Flowchart only
python3 scripts/analyze_codebase.py /path/to/project --type flowchart

# Org chart only
python3 scripts/analyze_codebase.py /path/to/project --type org

出力ディレクトリと形式を指定

# Output to a specific directory
python3 scripts/analyze_codebase.py /path/to/project --output /tmp/diagrams

# Output as SVG (requires mmdc)
python3 scripts/analyze_codebase.py /path/to/project --format svg

# Output both Mermaid and SVG
python3 scripts/analyze_codebase.py /path/to/project --format both

解析結果を JSON で出力

python3 scripts/analyze_codebase.py /path/to/project --json

パラメーター

パラメーター	説明
directory	解析するコードディレクトリ（必須）
--type, -t	図の種類：architecture、flowchart、org、all（デフォルト：all）
--output, -o	出力ディレクトリ（デフォルト：現在のディレクトリ）
--format, -f	出力形式：mermaid、svg、both（デフォルト：mermaid）
--max-files	スキャンするファイルの最大数（デフォルト：500）
--max-depth	組織図の最大階層（デフォルト：4）
--json	解析結果を JSON 形式で出力

仕組み

1. スキャンフェーズ：ディレクトリを再帰的にたどり、node_modules、.git、__pycache__ などをスキップします。
2. 解析フェーズ：
   • Python ファイル：ast モジュールを使って import 文と from ... import 文を解析します
   • JS/TS ファイル：正規表現を使って import、require、export from に一致させます
   • Go ファイル：正規表現を使って import 文に一致させます
   • Java ファイル：正規表現を使って import 文に一致させます
3. 内部依存関係の解決：インポートパスをプロジェクト内の実際のファイルに対応付けます
4. 図の生成：依存関係を Mermaid の図構文に変換します
5. レンダリング（任意）：mmdc（Mermaid CLI）を呼び出して、.mmd ファイルを SVG としてレンダリングします

ユースケース

• 不慣れなプロジェクトのモジュール構造をすばやく把握する
• コードレビュー中に依存関係を可視化する
• 技術ドキュメント用のアーキテクチャ図を作成する
• 循環依存や過度な結合を検出する
• リファクタリング前にプロジェクト構造を解析する

依存関係

• Python 3.7+（標準ライブラリのみ。追加パッケージは不要）
• SVG 出力には @mermaid-js/mermaid-cli が必要（任意）

注意事項

• 静的なインポート関係のみを解析します。動的インポートは追跡されません
• 大規模なプロジェクトでは、--max-files を使ってスキャン範囲を制限してください
• ノードが多すぎる Mermaid 図はレンダリングが難しくなる場合があります。--type を使って図を個別に生成してください