# 通知設計書 16-ALE構文エラー通知

## 概要

本ドキュメントは、space-vimにおけるALE（Asynchronous Lint Engine）プラグインの構文エラー表示フォーマット設定の設計を記載する。

### 本通知の処理概要

ALE構文エラー通知は、ALEプラグインがソースコードの構文チェック（リント）を行った際に検出されたエラーを、ユーザーに視覚的にわかりやすく表示するための通知機能である。

**業務上の目的・背景**：プログラミング中のコード品質を維持するため、構文エラーを即座に検出しユーザーにフィードバックすることは重要である。この通知により、開発者はリアルタイムでコードの問題を把握でき、品質の高いコードを効率的に書くことができる。

**通知の送信タイミング**：ALEがバッファの内容を解析し、構文エラーを検出した時点でエコーエリアにメッセージが表示される。具体的には、テキスト変更時（normalモード）またはインサートモード離脱時に500msの遅延後にリントが実行される。

**通知の受信者**：Vim/NeoVimを使用しているspace-vimユーザー。エコーエリア（コマンドライン領域）にメッセージが表示される。

**通知内容の概要**：エラーメッセージは「[#リンター名#] エラー内容 [Error]」または「[#リンター名#] エラー内容 [✹ Error]」（GUI以外）の形式で表示される。視覚的な識別のため、GUI環境以外では「✹」記号が使用される。

**期待されるアクション**：開発者はエラーメッセージを確認し、該当箇所のコードを修正する。`<Leader>en`でエラー間を移動できる。

## 通知種別

Vimエコーエリア通知（エディタ内通知）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（ALEによる自動検出） |
| 優先度 | 高 |
| リトライ | 無し（自動再検出） |

### 送信先決定ロジック

現在アクティブなVim/NeoVimのエコーエリアに出力される。送信先の動的決定は行わない。

## 通知テンプレート

### Vimエコーエリアの場合

| 項目 | 内容 |
|-----|------|
| 出力先 | Vimエコーエリア |
| 形式 | テキスト（ハイライト付き） |

### 本文テンプレート

```
[#%linter%#] %s [%severity%]
```

- `%linter%` : リンター名（例：eslint, pylint）
- `%s` : エラーメッセージ本文
- `%severity%` : 重大度（ErrorまたはWarning）

### エラー文字列の形式

| 環境 | 表示形式 |
|-----|----------|
| GUI | `Error` |
| Terminal | `✹ Error` |

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| %linter% | リンター名 | ALE内部 | Yes |
| %s | エラーメッセージ | リンターの出力 | Yes |
| %severity% | 重大度文字列 | g:ale_echo_msg_error_str | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| テキスト変更 | normalモードでのテキスト変更 | 500ms遅延後にリント | g:ale_lint_on_text_changed = 'normal' |
| モード変更 | インサートモード離脱 | リント実行 | g:ale_lint_on_insert_leave = 1 |
| カーソル移動 | エラー行へのカーソル移動 | エラーがある場合 | エコーエリアにメッセージ表示 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ALEが無効 | :ALEToggleでALEが無効化されている場合 |
| エラーなし | リントでエラーが検出されなかった場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[テキスト変更/モード変更] --> B[500ms遅延]
    B --> C[ALEがリンター実行]
    C --> D{エラー検出?}
    D -->|Yes| E[エラー情報をパース]
    D -->|No| F[終了]
    E --> G[メッセージフォーマット生成]
    G --> H[エコーエリアに表示]
    H --> I[終了]
```

## データベース参照・更新仕様

### 参照テーブル一覧

該当なし（Vimバッファベースの処理）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| リンター不在 | 対象言語のリンターがインストールされていない | ユーザーがリンターをインストール |
| リンター実行エラー | リンターがクラッシュした場合 | ALEがエラーを無視して継続 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（自動再検出により実質無限） |
| リトライ間隔 | 次のテキスト変更時 |
| リトライ対象エラー | 該当なし |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| リント遅延 | 500ms（g:ale_lint_delay） |
| エコー遅延 | 20ms（g:ale_echo_delay） |

### 配信時間帯

制限なし（エディタ使用中は常時有効）

## セキュリティ考慮事項

- 機密情報は含まれない（ソースコードのエラー情報のみ）
- 外部通信なし（ローカルリンターの実行のみ）
- リンターの実行はユーザーの編集動作に連動

## 備考

- 設定は`layers/+checkers/syntax-checking/config.vim`の12行目で定義
- `g:ale_echo_msg_error_str`変数でエラー文字列を設定
- GUI環境判定は`g:spacevim.gui`で行う
- Vim8またはNeoVim環境でのみALEが使用される（それ以外はSyntastic）

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

ALEの設定変数群を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | config.vim | `layers/+checkers/syntax-checking/config.vim` | ALE関連の設定変数（5-19行目） |

**読解のコツ**: `g:`プレフィックスはグローバル変数を意味する。ALEプラグインがこれらの変数を参照して動作する。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | config.vim | `layers/+checkers/syntax-checking/config.vim` | 条件分岐（3行目）でVim8/NeoVim判定 |

**主要処理フロー**:
1. **3行目**: `if g:spacevim.vim8 || g:spacevim.nvim` - 環境判定
2. **5-23行目**: ALE設定ブロック
3. **12行目**: エラー文字列の設定

#### Step 3: エラー文字列設定を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | config.vim | `layers/+checkers/syntax-checking/config.vim` | エラー文字列設定（12行目） |

**主要処理フロー**:
- **12行目**: `let g:ale_echo_msg_error_str = g:spacevim.gui ? 'Error' : '✹ Error'`
- GUI環境では「Error」、それ以外では「✹ Error」

#### Step 4: メッセージフォーマット設定を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | config.vim | `layers/+checkers/syntax-checking/config.vim` | メッセージフォーマット（7行目） |

**主要処理フロー**:
- **7行目**: `let g:ale_echo_msg_format = '[#%linter%#] %s [%severity%]'`

### プログラム呼び出し階層図

```
space-vim起動
    |
    +-- syntax-checkingレイヤー読み込み
            |
            +-- config.vim実行 (layers/+checkers/syntax-checking/config.vim)
                    |
                    +-- if g:spacevim.vim8 || g:spacevim.nvim
                    |       |
                    |       +-- ALE設定
                    |               +-- g:ale_echo_msg_format設定 (7行目)
                    |               +-- g:ale_echo_msg_error_str設定 (12行目)
                    |               +-- g:ale_lint_delay設定 (17行目)
                    |
                    +-- else (Syntastic設定)
```

### データフロー図

```
[入力]               [処理]                    [出力]

テキスト変更 ──▶ ALE リント実行 ──▶ エラー検出 ──▶ エコーエリア表示
                      |                           |
                 g:ale_lint_delay          g:ale_echo_msg_format
                    (500ms)                       |
                                          [#リンター名#] メッセージ [✹ Error]
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| config.vim | `layers/+checkers/syntax-checking/config.vim` | 設定 | ALE/Syntasticの設定を定義 |
