# バッチ設計書 32-lint-diagnostics

## 概要

本ドキュメントは、clojure-lspプロジェクトにおけるlint-diagnosticsバッチの設計仕様を定義するものです。lint-diagnosticsは、プロジェクト内のコード品質問題を検出する診断リンタータスクです。

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

lint-diagnosticsバッチは、clojure-lspのdiagnosticsコマンドをドライモードで実行し、プロジェクト内のClojureソースコードに存在する警告やエラーなどの診断情報を検出するリンタータスクです。

**業務上の目的・背景**：コードの品質問題を早期に発見し、バグの混入を防止するため、静的解析による診断情報の検出が必要です。CI/CDパイプラインにおける品質ゲートとして機能し、問題のあるコードがマージされることを防止します。clj-kondoやclojure-lsp独自のリンターによる包括的な診断を提供します。

**バッチの実行タイミング**：開発時に手動実行、またはCI/CDパイプライン（プルリクエスト作成時、コミット時）での自動実行が想定されます。lintタスクの一部として他のリンターと組み合わせて実行されることもあります。

**主要な処理内容**：
1. clojure-lspのdiagnosticsコマンドをドライモード（--dry）で実行
2. プロジェクト内の全Clojureソースファイルを解析
3. clj-kondoおよびclojure-lsp固有のリンターによる診断を実行
4. 検出された警告・エラーを出力

**前後の処理との関連**：lint-cleanやlint-formatと並列に実行可能です。lintタスクから呼び出される場合は、lint-clean、lint-format、lint-diagnosticsの順序で実行されます。

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

## バッチ種別

リント処理 / コード検証 / 静的解析

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 手動 / 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ソースファイル |
| clj-kondo設定 | EDN | .clj-kondo/config.edn（存在する場合） |
| clojure-lsp設定 | EDN | .lsp/config.edn（存在する場合） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 診断情報（警告・エラー） |
| 終了コード | 数値 | 0: 成功（問題なし）、非0: 失敗（問題あり） |

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. Babashkaタスク起動
   └─ bb lint-diagnostics コマンドを実行
2. make/lint-diagnostics関数呼び出し
   └─ make.clj内のlint-diagnostics関数を実行
3. lint関数呼び出し（ドライモード）
   └─ lint関数に"diagnostics"と{:dry? true}を渡して実行
4. clojure-lspのdiagnosticsコマンド実行
   └─ cli/ディレクトリで clojure -M:run diagnostics --dry を実行
5. 診断処理
   └─ clj-kondoおよびclojure-lsp固有リンターによる解析
6. 結果出力
   └─ 診断情報を標準出力に出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[bb lint-diagnostics 実行]
    B --> C[make/lint-diagnostics 関数呼び出し]
    C --> D[lint 関数呼び出し]
    D --> E[clojure -M:run diagnostics --dry 実行]
    E --> F[clj-kondo 解析]
    F --> G[clojure-lsp 固有リンター解析]
    G --> H{診断問題あり?}
    H -->|あり| I[診断情報を標準出力に出力]
    H -->|なし| J[正常終了]
    I --> K[終了コード 非0]
    J --> L[終了コード 0]
    K --> M[バッチ終了]
    L --> M
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 非0 | 診断問題検出 | ソースコードに警告・エラーがある場合 | 出力された診断情報を確認し、コードを修正 |
| 非0 | 実行エラー | Babashkaまたは依存関係の問題 | Babashkaのインストール確認、依存関係の解決 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認し、問題の原因を特定
2. 依存関係の問題の場合は、`clojure -P`で依存関係を再取得
3. 診断問題の場合は、検出された問題をコードで修正

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

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

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | 処理中 | 解析対象ファイル情報 |
| 結果ログ | 処理完了時 | 診断情報（警告・エラー） |
| エラーログ | エラー発生時 | エラー詳細情報 |

## 監視・アラート

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

## 備考

- lint-diagnosticsはlintタスクの一部として実行されることが多い
- sample-testディレクトリは除外対象として設定されている
- clj-kondoとclojure-lsp固有のリンター両方の診断結果が含まれる
- --outputオプションで出力形式を指定可能（CLIコマンド直接実行時）
