# バッチ設計書 31-lint-format

## 概要

本ドキュメントは、clojure-lspプロジェクトにおけるlint-formatバッチの設計仕様を定義するものです。lint-formatは、コードフォーマットの検証を行うリンタータスクです。

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

lint-formatバッチは、clojure-lspのformatコマンドをドライモードで実行し、プロジェクト内のClojureソースコードがcljfmtの規約に準拠しているかを検証するリンタータスクです。

**業務上の目的・背景**：開発チームのコードスタイルを統一し、コードレビューの効率化とコード品質の向上を図るため、フォーマット違反を自動検出する仕組みが必要です。CI/CDパイプラインにおける品質ゲートとして機能し、フォーマット違反のあるコードがマージされることを防止します。

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

**主要な処理内容**：
1. clojure-lspのformatコマンドをドライモード（--dry）で実行
2. プロジェクト内の全Clojureソースファイルを解析
3. cljfmtフォーマット規約との差分を検出
4. フォーマット違反がある場合は差分を出力

**前後の処理との関連**：lint-cleanやlint-diagnosticsと並列に実行可能です。lintタスクから呼び出される場合は、lint-clean、lint-format、lint-diagnosticsの順序で実行されます。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 | フォーマット設定（存在する場合） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | フォーマット差分情報 |
| 終了コード | 数値 | 0: 成功（違反なし）、非0: 失敗（違反あり） |

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. Babashkaタスク起動
   └─ bb lint-format コマンドを実行
2. make/lint-format関数呼び出し
   └─ make.clj内のlint-format関数を実行
3. lint関数呼び出し（ドライモード）
   └─ lint関数に"format"と{:dry? true}を渡して実行
4. clojure-lspのformatコマンド実行
   └─ cli/ディレクトリで clojure -M:run format --dry を実行
5. フォーマット検証
   └─ cljfmtによるフォーマット規約との差分を検出
6. 結果出力
   └─ 差分がある場合は標準出力に出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[bb lint-format 実行]
    B --> C[make/lint-format 関数呼び出し]
    C --> D[lint 関数呼び出し]
    D --> E[clojure -M:run format --dry 実行]
    E --> F{フォーマット違反あり?}
    F -->|あり| G[差分を標準出力に出力]
    F -->|なし| H[正常終了]
    G --> I[終了コード 非0]
    H --> J[終了コード 0]
    I --> K[バッチ終了]
    J --> K
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 非0 | フォーマット違反 | ソースコードにフォーマット違反がある場合 | 出力された差分を確認し、bb lint-fixで修正またはエディタで手動修正 |
| 非0 | 実行エラー | Babashkaまたは依存関係の問題 | Babashkaのインストール確認、依存関係の解決 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認し、問題の原因を特定
2. 依存関係の問題の場合は、`clojure -P`で依存関係を再取得
3. フォーマット違反の場合は、`bb lint-fix`で自動修正を試行

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

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

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | 処理中 | 検証対象ファイル情報 |
| 結果ログ | 処理完了時 | フォーマット差分（違反がある場合） |
| エラーログ | エラー発生時 | エラー詳細情報 |

## 監視・アラート

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

## 備考

- lint-formatはlintタスクの一部として実行されることが多い
- sample-testディレクトリは除外対象として設定されている
- 実際の修正を適用する場合はbb lint-fixを使用する
