# 通知設計書 47-WINDOW_DISABLE_DIAGNOSTIC

## 概要

本ドキュメントは、lua-language-serverにおける「ワークスペース診断無効化」ボタン通知（WINDOW_DISABLE_DIAGNOSTIC）の設計仕様を定義する。この通知は、ワークスペース診断を完全に無効化するオプションをユーザーに提示するボタンラベルを提供する。

### 本通知の処理概要

この通知は、ワークスペース診断設定案内ダイアログ（WINDOW_SETTING_WS_DIAGNOSTIC）内のアクションボタンとして使用される。ユーザーがこのボタンを選択すると、ワークスペース診断が完全に無効化される。

**業務上の目的・背景**：非常に大規模なプロジェクトや、特定のワークフローではワークスペース全体の診断が不要な場合がある。また、パフォーマンスを最優先する場合や、外部ツールで診断を行う場合など、LSPによる診断を完全に停止したいユースケースが存在する。この設定により、ユーザーは診断機能を完全にオフにできる。

**通知の送信タイミング**：WINDOW_SETTING_WS_DIAGNOSTICダイアログの一部として表示される。askForDisable関数内で、他の選択肢（再度表示しない、遅延診断）と共に提示される。

**通知の受信者**：VSCode等のIDEを使用してLuaプロジェクトを編集している開発者。診断機能を完全に停止したい場合に関連する。

**通知内容の概要**：「Disable workspace diagnostics」（日本語：「ワークスペース診断を無効にします」）というボタンラベル。

**期待されるアクション**：ユーザーがこのボタンをクリックすると、`Lua.diagnostics.workspaceDelay`設定が-1に設定され、ワークスペース診断が無効化される。ファイル単位の診断（開いているファイルのみ）は引き続き機能する。

## 通知種別

LSPメッセージリクエスト（`window/showMessageRequest`）のアクションボタンラベル

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期 |
| 優先度 | 中（Info） |
| リトライ | なし |

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

WINDOW_SETTING_WS_DIAGNOSTICダイアログの送信先決定ロジックに従う。

## 通知テンプレート

### ボタンラベルの場合

| 項目 | 内容 |
|-----|------|
| 用途 | 診断無効化ボタン |
| 親メッセージ | WINDOW_SETTING_WS_DIAGNOSTIC |
| 形式 | テキスト |

### 本文テンプレート

```
英語: Disable workspace diagnostics
日本語: ワークスペース診断を無効にします
中国語(簡体): 禁用工作区诊断
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | ボタンラベルは固定テキスト | locale/*/script.lua | N/A |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ダイアログ表示 | askForDisable | dontAskedForDisable = false | 診断設定案内ダイアログの一部 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| dontAskedForDisable = true | 親ダイアログが抑止されている場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[askForDisable呼び出し] --> B[ダイアログ表示]
    B --> C[WINDOW_DISABLE_DIAGNOSTICボタン表示]
    C --> D{ユーザー選択}
    D -->|WINDOW_DISABLE_DIAGNOSTIC| E[client.setConfig呼び出し]
    E --> F[workspaceDelay = -1 設定]
    F --> G[終了]
    D -->|他のアクション| H[他の処理]
    H --> G
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない。

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| N/A | N/A | データベース不使用 |

### 設定更新

| 設定キー | 操作 | 値 | 説明 |
|---------|------|-----|------|
| Lua.diagnostics.workspaceDelay | SET | -1 | 診断無効化を示す特殊値 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 設定更新失敗 | client.setConfigが失敗した場合 | ログ記録、処理継続 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | 親ダイアログに依存 |

### 配信時間帯

制限なし

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

- 設定変更はローカルの設定ファイルのみに影響
- ユーザーの明示的な選択が必要
- 機密情報は含まれない
- 診断無効化後も手動で再有効化可能

## 備考

- workspaceDelay = -1は診断無効化を示す特殊値として定義されている
- ファイル診断（開いているファイル単体の診断）は無効化されない
- 関連する通知：WINDOW_SETTING_WS_DIAGNOSTIC、WINDOW_DONT_SHOW_AGAIN、WINDOW_DELAY_WS_DIAGNOSTIC

---

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

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

### 推奨読解順序

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

askForDisable関数でのボタン定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | diagnostic.lua | `script/provider/diagnostic.lua` | 483-485行目：アクションボタン定義 |

**主要処理フロー**:
- **484行目**: `title = lang.script.WINDOW_DISABLE_DIAGNOSTIC` - ボタンラベル設定

#### Step 2: クリック時の処理を理解する

設定変更処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | diagnostic.lua | `script/provider/diagnostic.lua` | 502-510行目：選択処理 |

**主要処理フロー**:
- **502行目**: `item.title == lang.script.WINDOW_DISABLE_DIAGNOSTIC` - 選択判定
- **503-510行目**: `client.setConfig`で`workspaceDelay = -1`を設定

#### Step 3: 言語リソースを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | script.lua | `locale/en-us/script.lua` | 562-563行目：英語メッセージ |
| 3-2 | script.lua | `locale/ja-jp/script.lua` | 562-563行目：日本語メッセージ |

#### Step 4: workspaceDelay = -1の意味を理解する

診断処理での-1の扱いを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | diagnostic.lua | `script/provider/diagnostic.lua` | workspaceDelay設定の参照箇所 |

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

```
askForDisable (diagnostic.lua:467)
    |
    +-- proto.awaitRequest (473行目)
    |       |
    |       +-- actions: [{title: WINDOW_DISABLE_DIAGNOSTIC}, ...]
    |
    +-- [選択処理] (502-510行目)
            |
            +-- item.title == lang.script.WINDOW_DISABLE_DIAGNOSTIC
                    |
                    +-- client.setConfig
                            |
                            +-- key: 'Lua.diagnostics.workspaceDelay'
                            +-- action: 'set'
                            +-- value: -1 (診断無効化)
                            +-- uri: uri
```

### データフロー図

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

ダイアログ表示    ───▶  proto.awaitRequest     ───▶  ボタン表示
                                |                      [WINDOW_DISABLE_DIAGNOSTIC]
                                ▼
                          [ユーザークリック]
                                |
                                ▼
                          client.setConfig      ───▶  設定更新
                          workspaceDelay = -1          .luarc.json等
                                |
                                ▼
                          [ワークスペース診断停止]
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| diagnostic.lua | `script/provider/diagnostic.lua` | ソース | 診断プロバイダー（メイン処理） |
| client.lua | `script/client.lua` | ソース | 設定変更API |
| script.lua | `locale/en-us/script.lua` | 言語リソース | 英語メッセージ定義 |
| script.lua | `locale/ja-jp/script.lua` | 言語リソース | 日本語メッセージ定義 |
