# バッチ設計書 6-references

## 概要

本ドキュメントは、clojure-lspのreferencesコマンド（シンボル参照検索機能）のバッチ設計を記載する。

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

Clojure/ClojureScriptプロジェクト全体（および依存関係）から、指定した完全修飾シンボルの全参照箇所を検索して一覧表示する機能を提供する。コードナビゲーションやリファクタリングの影響範囲調査に使用される。

**業務上の目的・背景**：大規模なコードベースで特定のシンボル（関数、変数、名前空間等）がどこで使用されているかを把握することは、リファクタリングや影響範囲調査において重要。本コマンドにより、プロジェクト全体と依存関係を含めた包括的な参照検索が可能になり、安全なコード変更を支援する。

**バッチの実行タイミング**：開発者が手動で実行。コードレビューや影響調査時に使用される。

**主要な処理内容**：
1. プロジェクトと依存関係の解析
2. 対象シンボルの検索（--fromで指定）
3. シンボルの全参照箇所の検索
4. 参照一覧の出力（URI:行:列形式）

**前後の処理との関連**：他のコマンドの前提条件ではない。renameコマンドの事前調査として使用されることがある。

**影響範囲**：プロジェクト内の全ファイルと依存関係を読み取り専用でスキャン。ファイルの変更は行わない。

## バッチ種別

検索 / コード解析処理

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| プロジェクト存在 | deps.edn/project.clj等のプロジェクトファイルが存在すること |
| 対象シンボル存在 | --fromで指定したシンボルがプロジェクト内に存在すること |

### 実行可否判定

指定されたシンボルがプロジェクト内で見つかること。見つからない場合はエラーを返す。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --from | Symbol | Yes | - | 検索対象の完全修飾シンボル（例: my-ns/my-var） |
| --project-root | Path | No | カレントディレクトリ | プロジェクトルートパス |
| --settings / -s | EDN | No | {} | 追加設定をEDN形式で指定 |
| --analysis | EDN | No | {} | 解析オプション（:type指定可） |
| --raw | Boolean | No | false | 出力を最小限にする |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Clojureソースファイル | .clj/.cljs/.cljc | 解析対象のソースコード |
| 依存ライブラリ | JAR | classpathから取得した依存関係 |
| プロジェクトファイル | deps.edn等 | classpathとsource-paths取得用 |
| .lsp/config.edn | EDN | clojure-lsp設定ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 参照一覧（URI:行:列形式） |
| 標準エラー出力 | テキスト | 進捗情報、ログ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 該当なし（標準出力のみ） |
| 出力先 | 標準出力 |
| 文字コード | UTF-8 |
| 区切り文字 | 改行（各参照箇所ごと） |

## 処理フロー

### 処理シーケンス

```
1. CLI引数パース
   └─ --fromオプションの検証（必須チェック）
2. コンポーネント構築
   └─ CLILogger、APIProducerの初期化
3. プロジェクト解析
   └─ dynamic-setup-project-analysis!（デフォルト:project-and-full-dependencies）
4. シンボル検索
   └─ q/find-element-from-symで対象シンボルを検索
5. 参照検索
   └─ q/find-referencesで全参照箇所を検索
6. 結果出力
   └─ 各参照箇所をURI:行:列形式で出力
7. 終了
   └─ 結果コードとメッセージの返却
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[CLI引数パース]
    B --> C{--from必須チェック}
    C -->|不足| D[エラー: Missing required option]
    C -->|OK| E[コンポーネント構築]
    E --> F[プロジェクト解析]
    F --> G[シンボル検索]
    G --> H{シンボル発見?}
    H -->|No| I[Symbol not found in project]
    H -->|Yes| J[参照検索]
    J --> K[結果出力]
    K --> L[終了コード0]
    D --> M[終了コード1]
    I --> M
    L --> N[バッチ終了]
    M --> N
```

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

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

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | 必須オプション不足 | --fromが未指定 | オプションを指定して再実行 |
| 1 | シンボル未発見 | --fromで指定したシンボルが見つからない | シンボル名を確認 |

### リトライ仕様

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

### 障害時対応

読み取り専用の検索処理のため、重大な障害は発生しにくい。シンボルが見つからない場合は、完全修飾名が正しいか確認する。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 参照箇所の数に依存 |
| 目標処理時間 | 初回解析含め数秒〜数分 |
| メモリ使用量上限 | JVMヒープに依存（依存関係解析含む） |

## 排他制御

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

## ログ出力

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

## 監視・アラート

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

## 備考

- --fromには完全修飾シンボル（namespace/name）または名前空間のみ（namespace）を指定可能
- 名前空間のみの場合（simple-symbol?がtrue）、名前空間自体への参照を検索
- デフォルトでは依存関係も含めて検索（:project-and-full-dependencies）
- --analysis '{:type :project-only}'で依存関係を除外可能
- 出力形式はURI:行:列（例：file:///path/to/file.clj:10:5）
- q/find-referencesはinclude-declaration=trueで呼び出され、定義箇所も含む
