# バッチ設計書 2-clean-ns

## 概要

本ドキュメントは、clojure-lspのclean-nsコマンド（名前空間整理機能）のバッチ設計を記載する。

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

Clojure/ClojureScriptプロジェクト内のns（namespace）フォームを自動的に整理する機能を提供する。未使用のrequire、refer、importを検出して削除し、残りの宣言をアルファベット順にソートすることで、コードの可読性と保守性を向上させる。

**業務上の目的・背景**：Clojureプロジェクトの開発中、不要になったライブラリのrequireが残ったり、importの順序が乱雑になることが多い。これを手動で整理するのは手間がかかり、人為的ミスも発生しやすい。本コマンドにより、ns宣言を自動的に最適化し、コードベース全体の一貫性を保つことができる。CIパイプラインでの品質チェックにも利用される。

**バッチの実行タイミング**：開発者が手動で実行、またはCIパイプラインで自動実行（--dryモード）。保存時の自動フォーマットフックとしても使用可能。

**主要な処理内容**：
1. プロジェクトの解析とns情報の収集
2. 各ファイルのns宣言から未使用のrequire/refer/importを検出
3. 使用されているシンボルのみを保持したns宣言を再構築
4. アルファベット順でソート
5. 変更がある場合はファイルに書き込み（--dryの場合はdiff表示のみ）

**前後の処理との関連**：formatコマンドと組み合わせて使用されることが多い。lint-fixタスクはclean-nsとformatを順次実行する。

**影響範囲**：指定されたClojure/ClojureScriptソースファイルのns宣言部分。ファイルの内容を直接変更する（--dryオプションなしの場合）。

## バッチ種別

コード整形 / リファクタリング処理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動）/ CI実行時 |
| 実行時刻 | 該当なし |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動実行 / CIパイプライン |

## 実行条件

### 前提条件

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

### 実行可否判定

対象ファイルが存在し、解析可能な状態であること。名前空間やファイル名による除外パターン（--ns-exclude-regex）に一致するファイルはスキップされる。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --dry | Boolean | No | false | 変更を適用せず差分のみ表示 |
| --project-root | Path | No | カレントディレクトリ | プロジェクトルートパス |
| --namespace / -n | Symbol | No | 全ns | 対象とする名前空間（複数指定可） |
| --filenames | String | No | 全ファイル | 対象ファイル（カンマまたはコロン区切り） |
| --ns-exclude-regex | Regex | No | なし | 除外する名前空間の正規表現パターン |
| --settings / -s | EDN | No | {} | 追加設定をEDN形式で指定 |
| --raw | Boolean | No | false | 出力を最小限にする |

### 入力データソース

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

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| ソースファイル | .clj/.cljs/.cljc | 更新されたns宣言（--dryなしの場合） |
| 標準出力 | テキスト | 処理結果メッセージ/diff |
| 標準エラー出力 | テキスト | 進捗情報、ログ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 元のファイル名を維持 |
| 出力先 | 元のファイルを上書き |
| 文字コード | 元のファイルのエンコーディングを維持 |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. CLI引数パース
   └─ オプションの解析と検証
2. コンポーネント構築
   └─ CLILogger、APIProducerの初期化
3. プロジェクト解析
   └─ classpathとsource-pathsの取得、clj-kondo解析
4. 対象ファイル特定
   └─ namespace/filenames/除外パターンによるフィルタリング
5. 各ファイルのns整理
   └─ clean-nsコマンド実行、変更内容収集
6. 結果出力
   └─ --dryの場合はdiff表示、そうでなければファイル書き込み
7. 終了
   └─ 結果コードとメッセージの返却
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[CLI引数パース]
    B --> C[コンポーネント構築]
    C --> D[プロジェクト解析]
    D --> E[対象ファイル特定]
    E --> F{対象ファイルあり?}
    F -->|なし| G[Nothing to clear!]
    F -->|あり| H[各ファイルのns整理]
    H --> I{edits存在?}
    I -->|なし| G
    I -->|あり| J{--dry?}
    J -->|Yes| K[diff表示]
    K --> L[終了コード1]
    J -->|No| M[ファイル書き込み]
    M --> N[Cleaned X namespaces]
    N --> O[終了コード0]
    G --> O
    L --> P[バッチ終了]
    O --> P
```

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

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

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | 差分あり（--dry） | clean-nsで変更が必要なファイルがある | 本番実行（--dryなし）で修正 |
| 1 | 解析エラー | ファイルの構文エラー | ソースコード修正 |
| 1 | 設定エラー | 不正な--ns-exclude-regex | 正規表現パターン修正 |

### リトライ仕様

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

### 障害時対応

ファイル書き込みエラーが発生した場合、処理を中断する。--dryモードで事前確認することを推奨。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | ファイル単位 |
| コミットタイミング | 各ファイル処理完了時 |
| ロールバック条件 | 該当なし（ファイル単位で書き込み） |

## パフォーマンス要件

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

## 排他制御

同時に複数のclean-ns実行は推奨しない。ファイル単位での書き込みを行うため、同一ファイルへの並列書き込みは予期しない結果を招く可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | 処理開始時 | "Checking namespaces..." |
| 進捗ログ | 解析中 | 解析進捗率 |
| 結果ログ | 各ファイル処理後 | "Cleaned {namespace}" |
| 終了ログ | 処理完了時 | "Cleaned X namespaces" / "Nothing to clear!" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | CI/CDパイプライン |

## 備考

- lint-cleanタスク（bb lint-clean）はこのコマンドを--dryモードで実行する
- lint-fixタスク（bb lint-fix）はclean-nsとformatを順次実行し、変更を適用する
- pmapによる並列処理でパフォーマンス最適化されている
- 変更検出にはdiff.unified-diffを使用し、色付きdiffを生成する
