# バッチ設計書 11-doom doctor

## 概要

本ドキュメントは、Doom Emacsの診断コマンド「doom doctor」のバッチ設計書です。システムの一般的な問題を診断し、Doom Emacsが正常に動作するための前提条件をチェックするCLIコマンドの仕様を定義します。

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

doom doctorは、Doom Emacsの動作環境を診断し、潜在的な問題を検出・報告するためのヘルスチェックコマンドです。

**業務上の目的・背景**：Doom Emacsは複雑な依存関係と設定を持つEmacsディストリビューションであり、環境の不整合やミスコンフィギュレーションが発生しやすい。本コマンドは、ユーザーが問題を自己診断し、適切な対処を行えるようにするために不可欠なツールです。GitやRipgrep等の外部依存関係、Emacsのビルドオプション、設定ファイルの競合など、多岐にわたるチェックを自動実行します。

**バッチの実行タイミング**：手動実行（随時）。Doom Emacsの初回インストール後、アップグレード後、または問題発生時にユーザーが明示的に実行します。

**主要な処理内容**：
1. Emacsバージョンの確認（開発版の検出、EOLバージョンの警告）
2. Git/Ripgrepなどの必須外部依存関係の存在確認
3. Emacs設定ファイルの競合検出（.emacs, .emacs.d等）
4. Emacsのネイティブコンパイル・JSON対応の確認
5. フォント（Symbola、Nerd Icons）の存在確認
6. プライベート設定ディレクトリの競合検出
7. 環境変数・シェル設定の問題検出
8. 古い.elcファイルの検出
9. Gitグローバル設定の問題検出
10. 各モジュール固有のdoctor.elによる診断

**前後の処理との関連**：doom install/doom upgradeの後に実行することが推奨されます。問題検出後はdoom syncやdoom envの実行が必要になる場合があります。

**影響範囲**：診断のみを行い、システムに変更を加えません。診断結果は標準出力に表示されます。

## バッチ種別

診断・ヘルスチェック

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動実行（コマンドライン） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Emacsインストール済み | Emacs 27.1以上がインストールされていること |
| Doomインストール済み | Doom Emacsのコアファイルが存在すること |
| シェル環境 | POSIX互換シェルから実行可能であること |

### 実行可否判定

特別な実行可否判定は行わず、常に診断を実行します。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| N/A | - | - | - | 入力パラメータなし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| システム環境 | 環境変数 | PATH, HOME, DOOMDIR, XDG_CONFIG_HOME等 |
| ファイルシステム | ディレクトリ/ファイル | Emacs設定ディレクトリ、フォントディレクトリ |
| Git設定 | gitconfig | グローバルGit設定 |
| Emacsモジュール | doctor.el | 各モジュールの診断スクリプト |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 診断結果メッセージ（色付き） |

### 出力ファイル仕様

ファイル出力はありません。全ての診断結果は標準出力に表示されます。

## 処理フロー

### 処理シーケンス

```
1. Emacsバージョンチェック
   └─ 開発版・EOLバージョンの検出と警告
2. 必須依存関係チェック
   └─ git（バージョン2.23以上）、rg（ripgrep）の存在確認
3. Emacs設定競合チェック
   └─ ~/.emacs, ~/.emacs.d等の競合ファイル検出
4. Emacs機能チェック
   └─ native-compile、json-serializeの対応確認
5. フォントチェック
   └─ Symbola、Nerd Iconsフォントの存在確認
6. プライベート設定チェック
   └─ DOOMDIRとdoom-emacs-dirの競合検出
7. 環境チェック
   └─ 一時ディレクトリの書き込み権限、シェル互換性、シンボリックリンク対応
8. 古い.elcファイルチェック
   └─ core/modules/straightディレクトリのstale elc検出
9. Git設定チェック
   └─ insteadOf等の問題のあるグローバル設定検出
10. Doom初期化・モジュールチェック
    └─ Doom初期化、各モジュールのdoctor.el実行
11. 最終レポート出力
    └─ エラー数・警告数のサマリー表示
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[Emacsバージョンチェック]
    B --> C[必須依存関係チェック]
    C --> D[Emacs設定競合チェック]
    D --> E[Emacs機能チェック]
    E --> F[フォントチェック]
    F --> G[プライベート設定チェック]
    G --> H[環境チェック]
    H --> I[古い.elcファイルチェック]
    I --> J[Git設定チェック]
    J --> K[Doom初期化]
    K --> L{初期化成功?}
    L -->|Yes| M[モジュールdoctor.el実行]
    L -->|No| N[初期化エラー報告]
    M --> O[最終レポート出力]
    N --> O
    O --> P[バッチ終了]
```

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

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

データベース操作は行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | error! | Git未インストール | Gitをインストールする |
| - | error! | Gitバージョン不足 | Git 2.23以上にアップグレード |
| - | error! | rg未インストール | Ripgrepをインストールする |
| - | warn! | 開発版Emacs検出 | 安定版Emacsの使用を推奨 |
| - | warn! | Emacs 27使用 | Emacs 30.2へのアップグレードを推奨 |

### リトライ仕様

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

### 障害時対応

診断コマンドのため、障害時の特別なリカバリは不要です。エラーメッセージに従って環境を修正してください。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回の診断実行 |
| 目標処理時間 | 数秒〜数十秒（モジュール数に依存） |
| メモリ使用量上限 | Emacsプロセスの標準メモリ使用量 |

## 排他制御

同時実行の制限はありませんが、他のdoomコマンド（sync、upgrade等）と同時実行は推奨されません。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バッチ開始時 | "The doctor will see you now..." |
| 進捗ログ | 各チェック開始時 | "Checking your Emacs version...", "Checking for Doom's prerequisites..."等 |
| 終了ログ | バッチ終了時 | エラー数・警告数のサマリー、または"Everything seems fine, happy Emacs'ing!" |
| エラーログ | エラー発生時 | 各チェック項目の詳細なエラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| N/A | N/A | N/A（手動実行のため監視なし） |

## 備考

- `doom doc`というエイリアスでも実行可能です
- ベンチマーク出力は無効化されています（`:benchmark nil`）
- 最終結果は`+G`オプション付きでページャーに出力されます
