# バッチ設計書 7-dump

## 概要

本ドキュメントは、clojure-lspのdumpコマンド（プロジェクトデータダンプ機能）のバッチ設計を記載する。

### 本バッチの処理概要

Clojure/ClojureScriptプロジェクトの全データ（classpath、source-paths、dep-graph、clj-kondo解析データ、設定等）をEDNまたはJSON形式でダンプする実験的機能を提供する。デバッグやプロジェクト構造の調査に使用される。

**業務上の目的・背景**：clojure-lspの内部状態や解析結果を調査する必要がある場合、本コマンドにより全てのデータを取得できる。問題のトラブルシューティング、設定の検証、解析結果の確認などに使用される。また、他のツールとの連携や、カスタムツールの開発にも活用可能。

**バッチの実行タイミング**：開発者が手動で実行。デバッグや調査時に使用される。

**主要な処理内容**：
1. プロジェクトの解析（指定されたタイプで）
2. 内部データベースからのデータ抽出
3. 指定されたフィルタによるデータ選択
4. EDNまたはJSON形式での出力

**前後の処理との関連**：他のコマンドの前提条件ではない。独立したデバッグ/調査ツール。

**影響範囲**：プロジェクトを読み取り専用で解析。ファイルの変更は行わない。

## バッチ種別

デバッグ / データ出力処理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動） |
| 実行時刻 | 該当なし |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| プロジェクト存在 | deps.edn/project.clj等のプロジェクトファイルが存在すること |

### 実行可否判定

プロジェクトが解析可能な状態であること。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --project-root | Path | No | カレントディレクトリ | プロジェクトルートパス |
| --output / -o | EDN | No | {:format :edn} | 出力設定（:format、:filter-keys指定可） |
| --settings / -s | EDN | No | {} | 追加設定をEDN形式で指定 |
| --analysis | EDN | No | {} | 解析オプション（:type指定可） |
| --raw | Boolean | No | false | 出力を最小限にする |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Clojureソースファイル | .clj/.cljs/.cljc | 解析対象のソースコード |
| プロジェクトファイル | deps.edn等 | classpathとsource-paths取得用 |
| .clj-kondo/config.edn | EDN | clj-kondoの解析設定 |
| .lsp/config.edn | EDN | clojure-lsp設定ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | EDN/JSON | プロジェクトデータのダンプ |
| 標準エラー出力 | テキスト | 進捗情報、ログ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 該当なし（標準出力のみ） |
| 出力先 | 標準出力 |
| 文字コード | UTF-8 |
| 区切り文字 | データ構造（EDN/JSON） |

### ダンプデータの構造

| キー | 説明 |
|-----|------|
| :classpath | プロジェクトのクラスパス |
| :analysis | clj-kondo解析データ |
| :dep-graph | 依存関係グラフ |
| :settings | clojure-lsp設定 |
| :findings | clj-kondoの検出結果 |
| :project-root | プロジェクトルートパス |
| :source-paths | ソースパス一覧 |
| :clj-kondo-settings | clj-kondo設定 |
| :diagnostics | 診断情報 |

## 処理フロー

### 処理シーケンス

```
1. CLI引数パース
   └─ オプションの解析と検証
2. コンポーネント構築
   └─ CLILogger、APIProducerの初期化
3. プロジェクト解析
   └─ dynamic-setup-project-analysis!（デフォルト:project-only）
4. データ抽出
   └─ db->dump-dataで内部データベースからデータ選択
5. フォーマット変換
   └─ EDNまたはJSON形式に変換
6. 結果出力
   └─ 標準出力に出力
7. 終了
   └─ 結果コードの返却
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[CLI引数パース]
    B --> C[コンポーネント構築]
    C --> D[プロジェクト解析]
    D --> E[データ抽出]
    E --> F{filter-keys指定?}
    F -->|Yes| G[指定キーのみ選択]
    F -->|No| H[全キー選択]
    G --> I{format判定}
    H --> I
    I -->|:edn| J[EDN形式で出力]
    I -->|:json| K[JSON形式で出力]
    I -->|その他| L[エラー: Format not supported]
    J --> M[終了コード0]
    K --> M
    L --> N[終了コード1]
    M --> O[バッチ終了]
    N --> O
```

## データベース操作仕様

### 操作別データベース影響一覧

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 該当なし | - | - | 外部DBは使用しない |

### テーブル別操作詳細

本バッチは外部データベースを使用しない。内部的にAtom（db*）を使用してプロジェクト解析結果を管理し、そのデータをダンプする。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | フォーマットエラー | 未対応の出力フォーマット指定 | :ednまたは:jsonを指定 |
| 1 | 解析エラー | プロジェクト解析失敗 | プロジェクト設定を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

読み取り専用の処理のため、重大な障害は発生しにくい。解析エラーの場合はプロジェクト設定を確認する。

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし（読み取り専用） |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | プロジェクト規模に依存 |
| 目標処理時間 | 初回解析含め数秒〜数分 |
| メモリ使用量上限 | JVMヒープに依存 |

## 排他制御

読み取り専用のため、複数の同時実行が可能。ただし、同時実行するとCPU/メモリ負荷が増加する。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | 解析中 | 解析進捗率 |
| エラーログ | エラー発生時 | "Output format X not supported" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | 該当なし（インタラクティブ実行） |

## 備考

- 実験的機能（experimental）としてマークされている
- デフォルトでは:project-only解析タイプを使用
- --analysis '{:type :project-and-full-dependencies}'で依存関係も含めて解析可能
- --output '{:format :json}'でJSON形式出力
- --output '{:filter-keys [:classpath :source-paths]}'で特定キーのみ抽出可能
- cheshire.coreを使用してJSON生成
- 大規模プロジェクトでは出力が非常に大きくなる可能性がある
