# バッチ設計書 30-lint-clean

## 概要

本ドキュメントは、clojure-lspプロジェクトにおけるclean-nsリンター実行バッチ（lint-clean）の設計を記載したものである。

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

本バッチは、clojure-lspのclean-ns機能をドライモードで実行し、プロジェクト全体の名前空間（ns宣言）の整理が必要な箇所を検出するリンター処理である。実際のファイル変更は行わず、変更が必要な箇所のみを報告する。

**業務上の目的・背景**：Clojureプロジェクトでは、開発の過程で未使用のrequire/refer/importが蓄積したり、require文の順序が乱れたりすることがある。clean-nsリンターは、これらの問題を自動検出し、コードの品質と一貫性を維持するために使用される。ドライモードで実行することで、CIパイプラインでのリント検査として機能し、コードレビュー前に問題を発見できる。

**バッチの実行タイミング**：開発中のコード品質チェック時、CI/CDパイプラインでプルリクエストやコミット時に自動実行される。lintバッチの一部としても実行される。

**主要な処理内容**：
1. cliディレクトリで clojure -M:run clean-ns コマンドを実行
2. --project-root オプションで親ディレクトリをプロジェクトルートとして指定
3. --ns-exclude-regex オプションでテストサンプルを除外
4. --dry オプションでドライモード（変更なし）で実行
5. 整理が必要な箇所を検出して報告

**前後の処理との関連**：lintバッチから呼び出される。lint-formatおよびlint-diagnosticsと並んでリントタスクの一部を構成する。lint-fixバッチでは、--dryオプションなしで実行され、実際に修正が適用される。

**影響範囲**：ドライモードのため、ファイルシステムへの永続的な変更は行わない。検出結果が標準出力に出力される。

## バッチ種別

リント処理 / 静的解析

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（開発時）/ コミット毎（CI/CD） |
| 実行時刻 | 指定なし |
| 実行曜日 | 指定なし |
| 実行日 | 指定なし |
| トリガー | 手動（bb lint-clean）またはCI/CD |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| JDK | Java Development Kit がインストールされていること |
| Babashka | bb コマンドが利用可能であること |
| Clojure CLI | clojure コマンドが利用可能であること |
| 依存関係 | cli/deps.edn に定義された依存関係が解決可能であること |

### 実行可否判定

特別な実行可否判定は行わない。前提条件が満たされていれば実行可能である。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | コマンドラインパラメータは不要 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| lib/src/**/*.clj | Clojureソースコード | libモジュールのソースコード |
| cli/src/**/*.clj | Clojureソースコード | cliモジュールのソースコード |
| test-helper/src/**/*.clj | Clojureソースコード | test-helperモジュールのソースコード |
| deps.edn | EDN | プロジェクトルートの依存関係定義 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 検出された問題の一覧 |
| 終了コード | 整数 | 0=問題なし、1=問題あり |

### 出力ファイル仕様

ドライモードのため、ファイル出力は行わない。

## 処理フロー

### 処理シーケンス

```
1. Clojure CLI起動
   └─ cliディレクトリで clojure -M:run clean-ns を実行

2. オプション設定
   └─ --ns-exclude-regex ".*sample-test.*": テストサンプルを除外
   └─ --project-root "../": 親ディレクトリをプロジェクトルートに設定
   └─ --dry: ドライモードで実行

3. プロジェクト解析
   └─ clojure-lsp がプロジェクトを解析
   └─ source-paths からソースファイルを収集

4. clean-ns処理
   └─ 各名前空間のns宣言を解析
   └─ 未使用のrequire/refer/importを検出
   └─ requireの順序を検証

5. 結果出力
   └─ 問題が検出された場合、変更が必要な内容を出力
   └─ 問題がない場合、正常終了

6. 終了
   └─ 問題があれば非ゼロ終了コード
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[clojure -M:run clean-ns 実行]
    B --> C[オプション設定]
    C --> D[プロジェクト解析]
    D --> E[各名前空間のns宣言を解析]
    E --> F{問題を検出?}
    F -->|Yes| G[変更が必要な内容を出力]
    F -->|No| H[正常終了メッセージ]
    G --> I[非ゼロ終了コードで終了]
    H --> J[終了コード0で終了]
```

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

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

本バッチはデータベースを使用しない。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | N/A |

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

該当なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | リント問題検出 | ns宣言に問題がある | bb lint-fix で自動修正またはを手動で修正 |
| - | 依存関係エラー | 必要なライブラリが見つからない | deps.edn を確認し依存関係を解決 |
| - | 解析エラー | ソースコードに構文エラー | ソースコードを修正 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（自動リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

1. 問題が検出された場合：
   - `bb lint-fix` で自動修正を適用
   - または手動で該当箇所を修正
2. 解析エラーの場合：
   - 該当ファイルの構文エラーを修正

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | プロジェクト内の全Clojureファイル |
| 目標処理時間 | 3分以内 |
| メモリ使用量上限 | JVMデフォルト |

## 排他制御

同一プロジェクトディレクトリでの同時実行は可能。読み取り専用の処理であるため、競合は発生しない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | なし | - |
| 進捗ログ | なし | - |
| 終了ログ | なし | - |
| 結果ログ | 処理完了時 | 検出された問題の一覧 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | CI/CDシステム |
| 処理時間 | 5分 | CI/CDシステム |

## 備考

- clean-ns機能が検出する問題：
  - 未使用のrequire文
  - 未使用のrefer
  - 未使用のimport
  - requireの順序の乱れ（アルファベット順でない）
  - 重複したrequire
- 除外パターン `.*sample-test.*` の理由：
  - integration-test/sample-testディレクトリには意図的に問題のあるコードが含まれる
  - テスト用のサンプルコードはリント対象外とする
- lint-fixとの関係：
  - lint-clean: --dry オプションで検出のみ
  - lint-fix: --dry なしで実際に修正を適用
- lintバッチからの呼び出し：
  - lintバッチはlint-clean、lint-format、lint-diagnosticsを順次実行
- clojure-lspの設定：
  - プロジェクトの .lsp/config.edn で clean-ns の動作をカスタマイズ可能
  - keep や sort-ns-references などの設定が影響する
