# バッチ設計書 7-lintTs.mjs

## 概要

本ドキュメントは、Jestモノレポにおける TypeScript 型情報付き ESLint チェックバッチ `lintTs.mjs` の設計仕様を記載したものです。このバッチは typescript-eslint の recommendedTypeChecked および stylisticTypeChecked ルールセットを使用して、TypeScript の型情報を活用した高度な静的解析を実行します。

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

**業務上の目的・背景**：通常の ESLint チェックではTypeScriptの型情報を利用しないため、型に関連する潜在的な問題を検出できません。本バッチは typescript-eslint のタイプチェック機能を活用し、型安全性に関わる問題（不正な型キャスト、不要な型アサーション、null/undefined の適切な処理など）を検出します。これにより、ランタイムエラーの発生を事前に防止し、コードの品質を向上させます。

**バッチの実行タイミング**：開発者が `yarn lint-ts-files` コマンドを実行した際に随時実行されます。CI/CD パイプラインでは、プルリクエストの検証時に自動実行されます。通常の `yarn lint` とは別に、より厳密なチェックとして実行されます。

**主要な処理内容**：
1. `getPackagesWithTsConfig()` で対象パッケージ一覧を取得
2. 一部のパッケージを除外（packagesNotToTest リスト）
3. 各パッケージに対して並列で ESLint を実行
4. typescript-eslint の型チェック付きルールを適用
5. `--fix` オプション対応で自動修正を実行
6. エラー結果を stylish フォーマットで出力

**前後の処理との関連**：`yarn build:ts` による TypeScript ビルドが完了していることが前提です。通常の `yarn lint` コマンドとは独立して実行されます。

**影響範囲**：`packages/*/src/` ディレクトリ配下の TypeScript ファイルが対象です。一部のパッケージは現在除外されています（移行中）。

## バッチ種別

検証処理 / 静的解析 / コード品質

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（開発者操作時）/ CI/CD |
| 実行時刻 | 任意 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | `yarn lint-ts-files` コマンド実行 / CI/CDパイプライン |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | ^18.14.0 \|\| ^20.0.0 \|\| ^22.0.0 \|\| >=24.0.0 |
| 依存関係インストール済み | `yarn install` が完了していること |
| tsconfig.json 存在 | 各パッケージに tsconfig.json が存在すること |

### 実行可否判定

- `getPackagesWithTsConfig()` で取得したパッケージのうち、`packagesNotToTest` に含まれないパッケージが対象
- 各パッケージの `src/` ディレクトリが存在すること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --fix | フラグ | No | false | 自動修正を有効にする |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| packages/*/src/*.ts | TypeScript | 検証対象ソースファイル |
| packages/*/tsconfig.json | JSON | TypeScript 設定 |
| tsconfig.json | JSON | ルートの TypeScript 設定 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力/標準エラー | テキスト | ESLint 結果（stylish フォーマット） |
| packages/*/.eslintcache | バイナリ | ESLint キャッシュ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| キャッシュファイル | `.eslintcache`（各パッケージディレクトリ） |
| 修正ファイル | `--fix` 指定時、元ファイルを上書き |

## 処理フロー

### 処理シーケンス

```
1. パッケージ一覧取得
   └─ getPackagesWithTsConfig() で対象を取得し、除外パッケージをフィルタ
2. 並列制御の初期化
   └─ pLimit(cpus) で並列数を制限
3. 各パッケージの並列処理
   ├─ ESLint インスタンスを生成（パッケージごと）
   ├─ typescript-eslint 設定を適用
   ├─ lintFiles() でファイルを検証
   ├─ --fix 時: outputFixes() で修正を出力
   └─ エラー結果を収集
4. 結果出力
   ├─ エラーあり: stylish フォーマットで出力、process.exitCode = 1
   └─ エラーなし: 成功メッセージを出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[パッケージ一覧取得]
    B --> C[除外パッケージをフィルタ]
    C --> D[pLimit で並列制御初期化]
    D --> E[各パッケージを並列処理]
    E --> F[ESLint インスタンス生成]
    F --> G[typescript-eslint 設定適用]
    G --> H[lintFiles 実行]
    H --> I{--fix 指定?}
    I -->|はい| J[outputFixes 実行]
    J --> K[再度 lintFiles 実行]
    I -->|いいえ| L[エラー結果をフィルタ]
    K --> L
    L --> M[allLintResults に追加]
    M --> N[次のパッケージ]
    N --> E
    E -->|全パッケージ完了| O{エラーあり?}
    O -->|はい| P[stylish で出力]
    P --> Q[process.exitCode = 1]
    O -->|いいえ| R[成功メッセージ出力]
    Q --> S[バッチ終了]
    R --> S
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | - | - | データベースへのアクセスなし |

### テーブル別操作詳細

データベース操作は発生しません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ESLint Error | Lint エラー | コードが ESLint ルールに違反 | コードを修正または `--fix` で自動修正 |
| Error | 型チェックエラー | TypeScript の型解析に失敗 | tsconfig.json を確認 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認し、該当ファイル・行番号を特定
2. ESLint ルールに従ってコードを修正
3. `yarn lint-ts-files --fix` で自動修正可能なものは修正
4. 再実行して検証

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 対象パッケージ数（除外後） |
| 目標処理時間 | 数分（型チェック付きのため時間がかかる） |
| 並列処理 | CPU コア数 - 1 で並列実行（pLimit 使用） |

## 排他制御

- 同一パッケージに対する複数実行は非推奨
- ESLint キャッシュファイルへの同時書き込みを避けること

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| エラーログ | Lint エラー時 | ESLint stylish フォーマット出力 |
| エラーログ | 例外発生時 | `Unable to lint using TypeScript info files` |
| 成功ログ | 正常終了時 | `Successfully linted using TypeScript info files` |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 非0 | CI/CDパイプライン |

## 備考

### 適用される主要ルール

- `@typescript-eslint/strict-boolean-expressions`: 厳密な boolean 式チェック
- `@typescript-eslint/prefer-nullish-coalescing`: ?? 演算子の推奨
- `@typescript-eslint/no-unnecessary-template-expression`: 不要なテンプレートリテラル
- `@typescript-eslint/return-await`: return await の適切な使用
- `@typescript-eslint/switch-exhaustiveness-check`: switch 文の網羅性チェック

### 除外されているパッケージ

現在、以下のパッケージは移行中のため除外されています：
- expect, expect-utils, jest-circus, jest-cli, jest-config, jest-core
- jest-diff, jest-each, jest-environment-jsdom, jest-environment-node
- jest-fake-timers, jest-get-type, jest-haste-map, jest-jasmine2
- jest-leak-detector, jest-matcher-utils, jest-message-util, jest-mock
- その他多数（packagesNotToTest リスト参照）

### 特別なファイル設定

- `__tests__/**` ファイルには jest プラグインのルールを適用
- 一部ファイルには特定ルールの無効化設定あり
- `.js`, `.cjs`, `.mjs` ファイルは対象外
