# バッチ設計書 34-lint

## 概要

本ドキュメントは、clojure-lspプロジェクトにおけるlintバッチの設計仕様を定義するものです。lintは、全てのリンターをドライモードで実行する統合タスクです。

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

lintバッチは、lint-clean、lint-format、lint-diagnosticsの3つのリンタータスクを順番に実行し、プロジェクト内のClojureソースコードの品質を包括的に検証する統合タスクです。

**業務上の目的・背景**：コード品質の一括検証を行うため、複数のリンターを統合して実行する仕組みが必要です。CI/CDパイプラインにおける品質ゲートとして機能し、名前空間の整理状況、コードフォーマット、診断情報（警告・エラー）を一度に検証することで、開発効率を向上させます。

**バッチの実行タイミング**：開発時に手動実行、またはCI/CDパイプライン（プルリクエスト作成時、コミット時）での自動実行が想定されます。コミット前の品質チェックとして日常的に使用されます。

**主要な処理内容**：
1. lint-clean: 名前空間整理の検証（未使用require/refer/import、ソート順）
2. lint-format: コードフォーマットの検証（cljfmt規約準拠）
3. lint-diagnostics: 診断情報の検証（警告・エラー検出）
4. 全てドライモードで実行（ファイル変更なし）

**前後の処理との関連**：個別のリンター（lint-clean、lint-format、lint-diagnostics）を統合したタスクです。問題が検出された場合は、bb lint-fixで自動修正可能なものを修正し、残りは手動で対応します。

**影響範囲**：ドライモードでの実行のため、ソースファイルへの変更は行いません。検証結果は標準出力に出力されます。

## バッチ種別

リント処理 / コード検証 / 統合タスク

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 手動 / CI/CDイベント |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Babashka | Babashka (bb) がインストールされていること |
| プロジェクト構造 | clojure-lspプロジェクトのルートディレクトリで実行すること |
| 依存関係 | cli/deps.ednに定義された依存関係が解決可能であること |

### 実行可否判定

特別な実行可否判定ロジックはありません。Babashkaが利用可能であれば実行可能です。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --ns-exclude-regex | String | No | `.*sample-test.*` | 除外する名前空間のパターン（各サブタスクに適用） |
| --project-root | String | No | `../` | プロジェクトルートディレクトリのパス（各サブタスクに適用） |
| --dry | Boolean | No | true | ドライモードで実行（各サブタスクに適用） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Clojureソースファイル | .clj/.cljs/.cljc | プロジェクト内の全Clojureソースファイル |
| cljfmt設定 | EDN | フォーマット設定（存在する場合） |
| clj-kondo設定 | EDN | .clj-kondo/config.edn（存在する場合） |
| clojure-lsp設定 | EDN | .lsp/config.edn（存在する場合） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 各リンターの実行結果 |
| 終了コード | 数値 | 0: 成功（全リンターパス）、非0: 失敗（いずれかのリンターで問題検出） |

### 出力ファイル仕様

ドライモードでの実行のため、ファイルへの出力はありません。

## 処理フロー

### 処理シーケンス

```
1. Babashkaタスク起動
   └─ bb lint コマンドを実行
2. lintタスク実行
   └─ bb.edn内のlintタスク定義に従い実行
3. lint-clean実行
   └─ ":running-task lint-clean"を出力し、run lint-cleanを実行
4. lint-clean結果確認
   └─ 名前空間整理の検証結果
5. lint-format実行
   └─ ":running-task lint-format"を出力し、run lint-formatを実行
6. lint-format結果確認
   └─ コードフォーマットの検証結果
7. lint-diagnostics実行
   └─ ":running-task lint-diagnostics"を出力し、run lint-diagnosticsを実行
8. lint-diagnostics結果確認
   └─ 診断情報の検証結果
9. 完了
   └─ 全リンターの実行完了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[bb lint 実行]
    B --> C[doseq でリンター順次実行]
    C --> D[println :running-task lint-clean]
    D --> E[run lint-clean]
    E --> F[println :running-task lint-format]
    F --> G[run lint-format]
    G --> H[println :running-task lint-diagnostics]
    H --> I[run lint-diagnostics]
    I --> J{全リンター成功?}
    J -->|成功| K[正常終了]
    J -->|失敗| L[エラー終了]
    K --> M[終了コード 0]
    L --> N[終了コード 非0]
    M --> O[バッチ終了]
    N --> O
```

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

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

本バッチはデータベース操作を行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 非0 | リンター違反 | いずれかのリンターで問題が検出された場合 | 出力された違反情報を確認し、bb lint-fixで自動修正またはコードを手動修正 |
| 非0 | 実行エラー | Babashkaまたは依存関係の問題 | Babashkaのインストール確認、依存関係の解決 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認し、どのリンターで問題が発生したかを特定
2. lint-cleanまたはlint-formatの問題の場合は、`bb lint-fix`で自動修正を試行
3. lint-diagnosticsの問題の場合は、手動でコードを修正
4. 依存関係の問題の場合は、`clojure -P`で依存関係を再取得

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | プロジェクト内の全Clojureファイル x 3（各リンター） |
| 目標処理時間 | プロジェクトサイズに依存（中規模で数分程度） |
| メモリ使用量上限 | JVMデフォルト設定に準拠 |

## 排他制御

同時実行は可能です。読み取り専用の処理のため、排他制御は不要です。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| タスク開始ログ | 各リンター開始時 | `:running-task <リンター名>` |
| 進捗ログ | 処理中 | 各リンターの検証対象ファイル情報 |
| 結果ログ | 処理完了時 | 各リンターの違反情報（違反がある場合） |
| エラーログ | エラー発生時 | エラー詳細情報 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 非0 | CI/CDシステム通知 |

## 備考

- lintタスクは3つのリンター（lint-clean、lint-format、lint-diagnostics）を順番に実行する
- 各リンターの実行前に`:running-task <リンター名>`が出力される
- bb.ednのタスク定義で実行順序が決定されている
- 個別のリンターを実行したい場合は、bb lint-clean、bb lint-format、bb lint-diagnosticsを直接実行する
- sample-testディレクトリは全てのリンターで除外対象として設定されている
