# バッチ設計書 8-lint-changelog.js

## 概要

本ドキュメントは、changelogファイルの形式を検証するスクリプト `scripts/lint-changelog.js` の設計仕様を記載したものです。

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

本バッチは、changelog_unreleasedディレクトリ内の変更エントリファイルが正しい形式で記述されているかを検証し、問題がある場合はエラーメッセージを出力します。

**業務上の目的・背景**：Prettierの変更履歴は、複数の開発者が個別にエントリを追加する形式で管理されています。形式が統一されていないと、リリース時のブログ記事生成や changelog 統合で問題が発生します。本バッチは、PR投稿時やCI/CDで実行され、形式の不備を早期に検出して品質を保証します。

**バッチの実行タイミング**：CI/CDパイプラインでのプルリクエスト検証時、または手動でのchangelogエントリ作成後に実行されます。

**主要な処理内容**：
1. changelog_unreleasedディレクトリの構造検証（必須ファイル・ディレクトリの存在確認）
2. 各カテゴリディレクトリ内のエントリファイル名の形式検証（{PR番号}.md）
3. エントリファイル内容の検証
   - PRリンクの存在確認
   - 著者リンクの形式確認
   - テンプレートコメントの削除確認
   - タイトル形式の検証（h4使用、スペース配置等）
   - HTMLの制限確認
4. 重複ファイルの検出

**前後の処理との関連**：本バッチはCIで実行され、changelogエントリの品質を保証します。検証に合格したエントリは、draft-blog-post.jsやchangelog-for-patch.jsで使用されます。

**影響範囲**：changelog_unreleased/ディレクトリ配下の全ファイル。process.exitCodeの設定によりCIの成功/失敗を制御。

## バッチ種別

検証・リント / 品質保証

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（PR時、手動） |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | CI/CD / 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | Node.jsがインストールされていること |
| 依存パッケージ | yarn installにより依存パッケージがインストール済みであること |
| changelogディレクトリ | changelog_unreleased/ディレクトリが存在すること |

### 実行可否判定

changelog_unreleasedディレクトリが存在しない場合はエラーとなります。

## 入力仕様

### 入力パラメータ

本バッチはコマンドライン引数を受け取りません。

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| changelog_unreleased/ | ディレクトリ | 検証対象のルートディレクトリ |
| changelog_unreleased/TEMPLATE.md | Markdown | テンプレートファイル（コメント抽出用） |
| changelog_unreleased/{category}/*.md | Markdown | 検証対象のエントリファイル |
| utilities/changelog-categories.js | JavaScript | 有効なカテゴリの定義 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| stderr | テキスト | エラーメッセージ |
| process.exitCode | 数値 | 0:成功、1:エラーあり |

### 出力ファイル仕様

本バッチはファイル出力を行いません。

## 処理フロー

### 処理シーケンス

```
1. ディレクトリ構造の検証
   └─ 必須ファイル（TEMPLATE.md等）の存在確認
   └─ 未知のファイル/ディレクトリの検出
2. テンプレートの読み込み
   └─ テンプレートからコメントと著者リンクを抽出
3. カテゴリディレクトリのループ
   └─ .gitkeepの存在確認
   └─ 各エントリファイルの検証
4. エントリファイルの検証
   └─ ファイル名形式（{PR番号}.md）
   └─ PRリンクの存在
   └─ 著者リンクの形式
   └─ テンプレートコメントの削除
   └─ タイトル形式（h4、スペース配置）
   └─ HTMLの不使用
   └─ 「master」ではなく「main」の使用
5. 重複ファイルの検出
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[ディレクトリ読み込み]
    B --> C[必須ファイル確認]
    C --> D[未知ファイル検出]
    D --> E[テンプレート読み込み]
    E --> F[カテゴリループ]
    F --> G[.gitkeep確認]
    G --> H[エントリファイルループ]
    H --> I{ファイル名有効?}
    I -->|No| J[エラー出力]
    I -->|Yes| K[重複チェック]
    K --> L[PRリンク確認]
    L --> M[著者リンク確認]
    M --> N[テンプレートコメント確認]
    N --> O[タイトル形式確認]
    O --> P[HTML確認]
    P --> Q{次ファイル?}
    Q -->|Yes| H
    Q -->|No| R{次カテゴリ?}
    R -->|Yes| F
    R -->|No| S[バッチ終了]
    J --> Q
```

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

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

本バッチはデータベースを使用しません。

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

N/A

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Please remove | 不要なファイルが存在 | 指定ファイルを削除 |
| - | Please don't remove | 必須ファイルが欠落 | 必須ファイルを復元 |
| - | Filename is not in form | ファイル名形式不正 | {PR番号}.md形式に変更 |
| - | Duplicate files | 同一PRの重複エントリ | 重複ファイルを削除 |
| - | PR link missing | PRリンクが未記載 | #PR番号を追加 |
| - | Author link missing | 著者リンクが未記載 | by @username形式を追加 |
| - | Template comment | テンプレートコメント残存 | コメントを削除 |
| - | Please use h4 | h4以外の見出し使用 | ####に変更 |
| - | HTML restricted | タイトルにHTML使用 | HTMLを削除 |
| - | Please use "main" | masterの使用 | mainに変更 |

### リトライ仕様

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

### 障害時対応

エラーが検出された場合、process.exitCode = 1が設定され、CIが失敗します。各エラーメッセージに従ってエントリファイルを修正してください。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数十〜数百のchangelogエントリ |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | Node.jsデフォルト制限に依存 |

## 排他制御

読み取り専用の処理のため、排他制御は不要です。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| エラーログ | 検証エラー時 | ファイルパスとエラー詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| process.exitCode | 1 | CI/CD失敗 |

## 備考

- unified/remark-parseでMarkdownをパースしてHTML検出
- index-to-positionでコメント位置の行番号を算出
- outdentパッケージでエラーメッセージを整形
- 著者リンクは2形式をサポート：by @username または by [@username](https://github.com/username)
- タイトル形式：#### タイトル (#PR番号) または #### タイトル ([#PR番号])
- CHANGELOG_CATEGORIESは外部モジュールから取得
- checkedFilesMapで重複検出を管理
- <!-- prettier-ignore -->コメントは許可（検証対象外）
