# バッチ設計書 53-Generate-ThirdPartyNotices

## 概要

本ドキュメントは、MarkdownファイルのサードパーティノーティスをHTML形式に変換するPowerShellスクリプト「Generate-ThirdPartyNotices.ps1」のバッチ設計書である。

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

本バッチは、Markdown形式で記述されたサードパーティライセンス通知ファイルを読み込み、HTML形式に変換して出力する。ConvertFrom-Markdownコマンドレットを使用してMarkdownをHTMLに変換し、基本的なHTML構造（html/head/body）で囲んで出力ファイルに書き出す。

**業務上の目的・背景**：Windows Terminalはオープンソースのサードパーティライブラリを使用しており、ライセンス条項に基づきサードパーティノーティス（帰属表示）を同梱する必要がある。Markdown形式で管理されたノーティスをアプリケーション内で表示可能なHTML形式に変換することが本バッチの目的である。

**バッチの実行タイミング**：ビルドプロセス中に実行される。サードパーティノーティスのMarkdownファイルが更新された場合にも手動で実行される。

**主要な処理内容**：
1. 指定されたMarkdownファイルをConvertFrom-Markdownで解析
2. 解析結果のHtmlプロパティを取得
3. HTML基本構造（html/head/body）で囲む
4. UTF-8エンコーディングで出力ファイルに書き出し

**前後の処理との関連**：本バッチの出力HTMLはAppXパッケージに同梱される。Markdownファイルの更新が前提条件となる。

**影響範囲**：出力されたHTMLファイルがパッケージに含まれ、アプリケーション内のサードパーティノーティス表示に使用される。

## バッチ種別

データ変換処理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（ビルド時） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | ビルドパイプライン / 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Markdownファイル | 入力となるMarkdownノーティスファイルが存在すること |
| PowerShell | ConvertFrom-Markdownコマンドレットが利用可能であること（PowerShell 6.1以上） |

### 実行可否判定

入力Markdownファイルのパスが正しく指定されていれば実行される。ファイルが存在しない場合はエラーとなる。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| MarkdownNoticePath | string | Yes | - | 入力Markdownファイルのパス |
| OutputPath | string | Yes | - | 出力HTMLファイルのパス |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| MarkdownNoticePath | Markdown | サードパーティライセンス通知のMarkdownファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| OutputPath | HTML | サードパーティノーティスのHTMLファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | OutputPathで指定された名前 |
| 出力先 | OutputPathで指定されたパス |
| 文字コード | UTF-8 |
| 形式 | HTML |

## 処理フロー

### 処理シーケンス

```
1. パラメータ受け取り
   └─ MarkdownNoticePath と OutputPath を受け取る
2. Markdown→HTML変換
   └─ ConvertFrom-Markdown で Markdown を HTML に変換
3. HTML構造の組み立て
   └─ <html><head><title>Third-Party Notices</title></head><body>...</body></html> で囲む
4. ファイル出力
   └─ Out-File -Encoding UTF-8 で出力パスに書き出し（-Force で上書き）
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[Markdownファイルを読み込み]
    B --> C[ConvertFrom-MarkdownでHTML変換]
    C --> D[HTML基本構造で囲む]
    D --> E[UTF-8でファイル出力]
    E --> F[バッチ終了]
```

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | ファイル未存在エラー | 入力Markdownファイルが存在しない | 正しいパスを指定する |
| N/A | 書き込みエラー | 出力パスに書き込みできない | 出力先のパーミッション・ディレクトリ存在を確認 |

### リトライ仕様

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

### 障害時対応

入力ファイルのパスと出力先のパスを確認し、再実行する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 単一ファイル出力 |
| コミットタイミング | Out-File完了時 |
| ロールバック条件 | なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1ファイル |
| 目標処理時間 | 1秒以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

同時実行の制御は行っていない。単一ファイルの変換処理であり、排他制御の必要性は低い。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| なし | - | 明示的なログ出力は行わない |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 特になし | N/A | N/A |

## 備考

- 非常にシンプルなスクリプト（実質的にワンライナー）である
- CmdletBindingが定義されており、-Verbose等の共通パラメータに対応している
- Out-Fileの-Forceオプションにより、既存ファイルは上書きされる
- HTMLのtitleタグは固定で"Third-Party Notices"が設定される
