# バッチ設計書 6-checkCopyrightHeaders.mjs

## 概要

本ドキュメントは、Jestモノレポにおける著作権ヘッダー検証バッチ `checkCopyrightHeaders.mjs` の設計仕様を記載したものです。このバッチは、Git で追跡されている全ソースファイルに Meta Platforms 社の著作権ヘッダーが含まれているかを検証します。

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

**業務上の目的・背景**：Jest は Meta Platforms, Inc.（旧 Facebook）が開発・メンテナンスするオープンソースプロジェクトです。法的要件として、全てのソースファイルには適切な著作権表示とライセンス情報を含める必要があります。本バッチは、新規追加されたファイルや既存ファイルに著作権ヘッダーが欠けていないかを自動検証し、コンプライアンスを確保します。

**バッチの実行タイミング**：開発者が `yarn check-copyright-headers` コマンドを実行した際に随時実行されます。CI/CD パイプラインでは、プルリクエストの検証時に自動実行され、著作権ヘッダーが欠けているファイルがある場合はビルドが失敗します。

**主要な処理内容**：
1. `git ls-files` で Git 追跡ファイル一覧を取得
2. 拡張子ベースの除外パターン（.json, .md, .yaml 等）でフィルタリング
3. パスベースの除外パターン（node_modules, third-party 等）でフィルタリング
4. カスタム除外パターン（examples, 外部由来コード等）でフィルタリング
5. バイナリファイルを除外
6. 各ファイルの内容を検査し、著作権ヘッダーの存在を確認
7. ヘッダーが欠けているファイルのリストを出力

**前後の処理との関連**：`yarn lint` コマンドの一部として実行されることが多いです。新規ファイル追加を含むプルリクエストでは必ず実行されます。

**影響範囲**：リポジトリ内の Git 追跡ファイル全体が検証対象です。検証に失敗した場合、CI/CD パイプラインが停止します。

## バッチ種別

検証処理 / コンプライアンスチェック / コード品質

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | ^18.14.0 \|\| ^20.0.0 \|\| ^22.0.0 \|\| >=24.0.0 |
| Git リポジトリ | .git ディレクトリが存在すること |
| Git コマンド | git が PATH に存在すること |

### 実行可否判定

- Git リポジトリ内で実行されること
- `git ls-files` が正常に実行可能であること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | コマンドライン引数は受け付けない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| git ls-files 出力 | テキスト | Git 追跡ファイル一覧 |
| 各ソースファイル | 各種 | 検証対象ファイルの内容 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | エラーメッセージ（ヘッダー欠落ファイルのリスト） |

### 出力ファイル仕様

ファイル出力は行いません。

## 処理フロー

### 処理シーケンス

```
1. Git ファイル一覧取得
   └─ git ls-files を実行し、追跡ファイルを取得
2. フィルタリング処理
   ├─ INCLUDED_PATTERNS で対象ファイルを選択
   ├─ GENERIC_IGNORED_EXTENSIONS で拡張子除外
   ├─ GENERIC_IGNORED_PATTERNS で一般パターン除外
   ├─ CUSTOM_IGNORED_PATTERNS でカスタムパターン除外
   ├─ isDirectory でディレクトリを除外
   └─ isBinaryFileSync でバイナリファイルを除外
3. 著作権ヘッダー検査
   ├─ ファイル内容を読み込み
   ├─ 空ファイルを除外
   └─ COPYRIGHT_LICENSE の存在を確認
4. 結果出力
   ├─ 違反ファイルあり: リストを出力し process.exit(1)
   └─ 違反ファイルなし: 正常終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[git ls-files 実行]
    B --> C[ファイル一覧取得]
    C --> D[各ファイルをフィルタ]
    D --> E{INCLUDED_PATTERNS?}
    E -->|マッチしない| F[スキップ]
    E -->|マッチ| G{IGNORED_PATTERNS?}
    G -->|マッチ| F
    G -->|マッチしない| H{ディレクトリ?}
    H -->|はい| F
    H -->|いいえ| I{バイナリ?}
    I -->|はい| F
    I -->|いいえ| J{著作権ヘッダあり?}
    J -->|はい| F
    J -->|いいえ| K[違反リストに追加]
    K --> F
    F --> L[次のファイル]
    L --> D
    D -->|全ファイル処理完了| M{違反ファイルあり?}
    M -->|はい| N[リスト出力]
    N --> O[process.exit 1]
    M -->|いいえ| P[正常終了]
    O --> Q[バッチ終了]
    P --> Q
```

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

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

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| Exit 1 | ヘッダー欠落 | ファイルに著作権ヘッダーがない | ファイルにヘッダーを追加または除外パターンを追加 |

### リトライ仕様

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

### 障害時対応

1. 出力されたファイルリストを確認
2. 各ファイルに著作権ヘッダーを追加
3. または、scripts/checkCopyrightHeaders.mjs の除外パターンに追加
4. 再度 `yarn check-copyright-headers` を実行して検証

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数千ファイル |
| 目標処理時間 | 数秒 |
| メモリ使用量上限 | ファイル数に依存 |

## 排他制御

- 読み取り専用のため、排他制御は不要
- 複数プロセスでの同時実行可能

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| エラーログ | ヘッダー欠落検出時 | `Meta copyright header check failed for the following files:\n\n{ファイルリスト}` |

## 監視・アラート

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

## 備考

### 必須の著作権ヘッダー

```
/**
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */
```

### 除外される拡張子
- lock, patch, diff, exe, bin, cfg, config, conf
- html, md, markdown, json, yaml, yml, xml
- snap, svg, txt, csv, tsv
- その他多数（GENERIC_IGNORED_EXTENSIONS 参照）

### 除外されるパス
- 隠しファイル・ディレクトリ（.* パターン）
- third-party/ ディレクトリ
- node_modules/ ディレクトリ
- gradle/wrapper/ ディレクトリ
- examples/ ディレクトリ
- 外部由来コード（jasmineUtils.ts, cleanupSemantic.ts 等）

### 注意事項
- isbinaryfile パッケージでバイナリ判定を行う
- 空ファイルは検証対象外
- 内部 Facebook ツールとパターンを同期する必要がある
