# バッチ設計書 6-lint

## 概要

本ドキュメントは、GitHub Actions CI/CDパイプラインにおけるコードリントおよびcompat-dataチェックバッチの設計仕様を定義する。

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

Babelプロジェクトのコードに対してESLintによる静的解析を実行し、コーディング規約への準拠を検証するバッチ処理である。同時にcompat-dataの整合性チェックも実行する。

**業務上の目的・背景**：Babelは大規模なオープンソースプロジェクトであり、多数のコントリビューターが参加している。一貫したコードスタイルと品質を維持するために、ESLintによる自動チェックが不可欠である。また、compat-data（ブラウザ互換性データ）の整合性を保証することで、@babel/preset-envなどのターゲット設定の信頼性を維持する。本バッチはビルド済みコードに対して実行され、コンパイル後の出力も検証対象となる。

**バッチの実行タイミング**：リポジトリへのpush時およびプルリクエスト作成時に自動実行される。buildジョブの完了後に実行される。

**主要な処理内容**：
1. リポジトリのチェックアウトとNode.jsセットアップ
2. 依存関係のインストール
3. ビルド済みアーティファクトのダウンロード
4. ESLint実行（make lint-ci）
5. compat-data整合性チェック（make check-compat-data）
6. Git差分チェック（未コミット変更の検出）

**前後の処理との関連**：buildジョブに依存し、ビルド済みアーティファクトをダウンロードして使用する。本バッチの成功はプルリクエストのマージ条件となる。

**影響範囲**：コード品質チェック結果、CIパイプライン全体の成功/失敗判定。

## バッチ種別

コード品質検証 / CI/CD

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（イベント駆動） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | push / pull_request イベント |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| build | ビルドジョブが正常完了していること |
| babel-artifact | ビルドアーティファクトが利用可能であること |
| ESLint設定 | eslint.config.jsが存在すること |

### 実行可否判定

GitHub Actionsのneeds設定に基づき、buildジョブの正常完了後に自動実行される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| N/A | N/A | N/A | N/A | 環境変数・パラメータなし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| babel-artifact | アーティファクト | ビルド済みパッケージ |
| packages/*/src | TypeScript | Babelパッケージのソースコード |
| eslint.config.js | JavaScript | ESLint設定 |
| packages/babel-compat-data | JavaScript | 互換性データ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | リント結果、エラー詳細 |
| GitHub Actions | ステータス | 成功/失敗ステータス |

### 出力ファイル仕様

本バッチはファイル出力を行わない。

## 処理フロー

### 処理シーケンス

```
1. Checkout code
   └─ actions/checkout@v4でリポジトリをチェックアウト
2. Use Node.js latest
   └─ actions/setup-node@v4でNode.js 25.6.1をセットアップ
3. Install
   └─ yarn installで依存関係をインストール
4. Download artifact
   └─ actions/download-artifact@v4でbabel-artifactをダウンロード
5. Lint
   └─ make -j lint-ci check-compat-data（並列実行）
6. Ensure cwd does not contain uncommitted changes
   └─ node ./scripts/assert-dir-git-clean.ts
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[actions/checkout: リポジトリ取得]
    B --> C[actions/setup-node: Node.js セットアップ]
    C --> D[yarn install: 依存関係インストール]
    D --> E[actions/download-artifact: アーティファクト取得]
    E --> F[make lint-ci check-compat-data]
    F --> G{リント成功?}
    G -->|失敗| H[バッチ失敗終了]
    G -->|成功| I[Git差分チェック]
    I --> J{差分なし?}
    J -->|あり| H
    J -->|なし| K[バッチ正常終了]
```

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

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

本バッチではデータベース操作は行わない。

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

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| EXIT_1 | ESLintエラー | リント違反検出時 | エラー箇所を修正してコミット |
| EXIT_1 | compat-dataエラー | 整合性チェック失敗時 | compat-dataを再生成 |
| EXIT_1 | Git差分エラー | 未コミット変更存在時 | 変更をコミット |

### リトライ仕様

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

### 障害時対応

1. GitHub Actionsのジョブログを確認
2. ESLintエラーの場合：
   - エラー詳細を確認して該当箇所を修正
   - ローカルで`yarn lint`を実行して確認
3. compat-dataエラーの場合：
   - `cd packages/babel-compat-data && yarn run build-data`で再生成
4. 修正後、再度プッシュしてCI実行

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数千ファイルのリント処理 |
| 目標処理時間 | 5分以内 |
| メモリ使用量上限 | ubuntu-latestランナーのデフォルト |

## 排他制御

concurrency設定により、同一ワークフロー・同一リファレンスの実行は1つに制限される。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ジョブ開始時 | GitHub Actions自動出力 |
| リントログ | ESLint実行時 | エラー・警告の詳細 |
| compat-dataログ | チェック実行時 | 整合性チェック結果 |
| 終了ログ | ジョブ終了時 | 成功/失敗ステータス |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ジョブ成功率 | 100% | GitHubステータスチェック |
| リントエラー件数 | 0件 | プルリクエストステータス |

## 備考

- make -jオプションにより、lint-ciとcheck-compat-dataを並列実行
- ESLint 10を使用（package.jsonで確認）
- eslint-formatter-codeframeでエラー出力をフォーマット
- assert-dir-git-clean.tsの引数が"lint-ci check-compat-data"（実行したコマンドを引数として渡す）
- ビルド済みアーティファクトを使用するため、ビルド成果物の品質も検証対象
