# バッチ設計書 21-toolkit clippy wasm

## 概要

本ドキュメントは、Nushellプロジェクトにおけるtoolkit clippy wasmコマンドの設計仕様を定義したものである。このバッチはWebAssembly（wasm）ターゲット向けのClippy静的解析チェックを実行し、wasm環境との互換性を検証する。

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

toolkit clippy wasmは、NushellのクレートがWebAssembly環境で正しく動作することを保証するための静的解析ツールである。wasm32-unknown-unknownターゲットに対してClippyチェックを実行し、wasm非互換なAPIの使用を検出する。

**業務上の目的・背景**：Nushellはブラウザ環境やサーバーレス環境でのwasm実行を視野に入れており、コアとなるクレートがwasm互換であることを保証する必要がある。例えば`std::time::Instant`はwasmで使用するとパニックを引き起こすため、`web_time::Instant`の使用を強制する。このバッチにより、開発者がwasm非互換なコードを誤ってコミットすることを防止し、wasm対応の品質を維持する。

**バッチの実行タイミング**：開発中の任意のタイミングで手動実行される。特にwasm対応クレートに変更を加えた際や、PR提出前のローカル検証時に実行される。CI/CDパイプラインでの自動実行も想定される。

**主要な処理内容**：
1. rustupを使用してwasm32-unknown-unknownターゲットを追加インストール
2. wasm互換対象となる各クレート（nu-cmd-base、nu-command、nu-engine等19クレート）に対してループ処理
3. 各クレートに対してcargo clippyを実行（wasm32-unknown-unknownターゲット、no-default-features）
4. wasm専用のclippy.toml設定を適用し、禁止されたAPI使用を検出

**前後の処理との関連**：toolkit build wasmと組み合わせて使用されることが多い。build wasmがビルド可能性を確認し、clippy wasmがコード品質とwasm互換性を検証する。

**影響範囲**：wasm互換対象の19クレートのソースコードが検査対象となる。検査結果はコンソールに出力され、警告やエラーがあれば非ゼロの終了コードが返される。

## バッチ種別

コード品質検査 / 静的解析

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動 / CI/CD |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Rust環境 | rustupおよびcargoがインストールされていること |
| Nushell環境 | Nushellがインストールされ、toolkitモジュールが利用可能であること |
| ネットワーク接続 | wasm32-unknown-unknownターゲットのダウンロードに必要（初回のみ） |

### 実行可否判定

toolkitモジュールがインポート可能であり、Rustツールチェーンが利用可能な場合に実行可能。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | パラメータは受け付けない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| wasm_compatible_crates定数 | Nushellリスト | 検査対象クレートの一覧（19クレート） |
| clippy/wasm/clippy.toml | TOML | wasm用のClippy設定ファイル |
| 各クレートのソースコード | Rust | 検査対象のRustソースファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 各クレートの検査進捗と結果 |
| 標準エラー出力 | テキスト | Clippyの警告・エラーメッセージ |

### 出力ファイル仕様

ファイル出力なし。結果はコンソールに出力される。

## 処理フロー

### 処理シーケンス

```
1. wasmターゲット準備（prep wasm）
   └─ rustup target add wasm32-unknown-unknownを実行
2. CLIPPY_CONF_DIR環境変数の設定
   └─ clippy/wasmディレクトリをClippy設定ディレクトリとして指定
3. 各クレートに対するループ処理
   └─ wasm_compatible_crates定数で定義された19クレートを順次処理
4. クレート名の表示
   └─ "Checking {クレート名} for wasm"を出力
5. cargo clippyの実行
   └─ -p {クレート名} --target wasm32-unknown-unknown --no-default-features
   └─ -D warnings -D clippy::unwrap_used -D clippy::unchecked_duration_subtraction
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[prep wasm実行]
    B --> C[wasm32-unknown-unknownターゲット追加]
    C --> D[CLIPPY_CONF_DIR設定]
    D --> E[クレートリスト取得]
    E --> F{次のクレートあり?}
    F -->|あり| G[クレート名表示]
    G --> H[cargo clippy実行]
    H --> I{エラー発生?}
    I -->|あり| J[エラー出力]
    I -->|なし| F
    J --> F
    F -->|なし| K[バッチ終了]
```

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

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

データベース操作なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ターゲット追加失敗 | rustupが利用不可またはネットワークエラー | rustupのインストール確認、ネットワーク接続確認 |
| - | Clippy警告 | wasm非互換なコード使用 | 該当コードをwasm互換な実装に修正 |
| - | コンパイルエラー | ソースコードの構文エラー等 | エラーメッセージに従い修正 |

### リトライ仕様

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

### 障害時対応

Clippyチェックが失敗した場合は、エラーメッセージを確認し、該当するソースコードを修正する。特に`std::time::Instant`等の禁止されたAPIの使用が検出された場合は、wasm互換な代替実装（`web_time::Instant`等）に置き換える。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし（静的解析のみ） |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 19クレート |
| 目標処理時間 | 数分〜数十分（初回ビルド時は長くなる） |
| メモリ使用量上限 | Cargoビルドに依存（通常数GB） |

## 排他制御

同一プロジェクトディレクトリでの同時実行は推奨されない。Cargoのビルドロックにより排他制御される。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | 各クレート処理開始時 | "Checking {クレート名} for wasm" |
| 区切り線 | 各クレート処理開始時 | "----------------------------" |
| 警告ログ | Clippy警告検出時 | 警告の詳細（ファイル名、行番号、内容） |
| エラーログ | エラー発生時 | エラーの詳細 |

## 監視・アラート

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

## 備考

- 検査対象の19クレート: nu-cmd-base, nu-cmd-extra, nu-cmd-lang, nu-color-config, nu-command, nu-derive-value, nu-engine, nu-glob, nu-json, nu-parser, nu-path, nu-pretty-hex, nu-protocol, nu-std, nu-system, nu-table, nu-term-grid, nu-utils, nuon
- wasm専用のclippy.tomlでは`std::time::Instant`の使用が禁止されている
- Clippyオプション: `-D warnings`（警告をエラー扱い）、`-D clippy::unwrap_used`（unwrap使用禁止）、`-D clippy::unchecked_duration_subtraction`（未チェックの時間減算禁止）
