# 帳票設計書 5-TOML Frontmatter Markdownファイル出力

## 概要

本ドキュメントは、Decap CMSにおけるTOML Frontmatter付きMarkdownファイル出力機能の設計を記述する。FrontmatterFormatterクラスのtoFileメソッドにより、メタデータ部分を`+++`区切りのTOML形式で、本文をMarkdownとして結合出力する仕組みを定義する。

### 本帳票の処理概要

本帳票は、CMSのコンテンツエディタで編集されたエントリデータを、TOML Frontmatter付きMarkdownファイルとして出力する機能を定義する。

**業務上の目的・背景**：TOML Frontmatter付きMarkdownは、主にHugoで使用されるコンテンツ形式である。HugoはGo言語で実装された高速な静的サイトジェネレータであり、TOML形式のメタデータを`+++`デリミタで囲む形式をネイティブにサポートしている。本機能はHugoベースのサイトでTOML形式のFrontmatterを使用するプロジェクトにおいて必要である。

**帳票の利用シーン**：コレクション設定でformat: toml-frontmatterが指定されている場合に使用される。Hugoサイトのコンテンツ管理で、TOML形式のメタデータを好むプロジェクトにおいて利用される。

**主要な出力内容**：
1. `+++`区切りのTOML Frontmatter部分（メタデータフィールド）
2. Markdown本文（bodyフィールド）
3. sortedKeysによるメタデータキーのソート順制御
4. TOML固有の値変換（整数のtoString変換、Dayjs日付フォーマット、AssetProxyパス変換）

**帳票の出力タイミング**：エディタ画面で「Save」ボタンを押下した際、resolveFormatで決定されたフォーマッタのtoFileメソッドが呼び出され、TOML Frontmatter付きMarkdown文字列が生成される。

**帳票の利用者**：コンテンツ編集者（CMS利用者）、Hugo静的サイトジェネレータ

## 帳票種別

データファイル出力（TOML Frontmatter付きMarkdownファイル）

## 利用画面

| 画面No | 画面名 | URL/ルーティング | 出力操作 |
|--------|--------|-----------------|---------|
| - | エディタ画面 | /collections/{collection}/entries/{slug} | Saveボタン押下 |
| - | 新規エントリ作成画面 | /collections/{collection}/new | Saveボタン押下 |

## 出力形式

### 基本仕様

| 項目 | 内容 |
|-----|------|
| ファイル形式 | Markdown (.md) |
| 用紙サイズ | N/A（テキストファイル） |
| 向き | N/A |
| ファイル名 | コレクション設定のslugテンプレートに基づく |
| 出力方法 | Gitリポジトリへのコミット（バックエンドAPI経由） |
| 文字コード | UTF-8 |

### PDF固有設定

N/A（テキストファイル出力のため該当なし）

### Excel固有設定

N/A（テキストファイル出力のため該当なし）

## 帳票レイアウト

### レイアウト概要

TOML Frontmatter部分とMarkdown本文部分が`+++`デリミタで区切られたファイルとして出力される。

```
┌─────────────────────────────────────┐
│ +++                                 │
│ title = "記事タイトル"               │
│ date = 2024-01-01                   │
│ tags = ["tag1", "tag2"]             │
│ +++                                 │
├─────────────────────────────────────┤
│                                     │
│ # 見出し                            │
│                                     │
│ 本文のMarkdownコンテンツ             │
│                                     │
└─────────────────────────────────────┘
```

### ヘッダー部（Frontmatter）

| No | 項目名 | 説明 | データ取得元 | 表示形式 |
|----|-------|------|-------------|---------|
| 1 | 開始デリミタ | Frontmatter開始マーカー | 固定値 `+++` | +++ |
| 2 | メタデータ | body以外の全フィールドデータ | entry.data（bodyを除く） | TOML形式 |
| 3 | 終了デリミタ | Frontmatter終了マーカー | 固定値 `+++` | +++ |

### 明細部（本文）

| No | 項目名 | 説明 | データ取得元 | 表示形式 | 列幅 |
|----|-------|------|-------------|---------|-----|
| 1 | 本文 | Markdownコンテンツ | entry.data.body | Markdown記法 | N/A |

### フッター部

N/A

## 出力条件

### 抽出条件

| 条件名 | 説明 | 必須 |
|-------|------|-----|
| エントリデータ | エディタで入力された全フィールドデータ | Yes |
| ソートキー指定 | sortedKeysパラメータで指定されたキー順序 | No |

### ソート順

| 優先度 | 項目 | 昇順/降順 |
|-------|------|---------|
| 1 | sortedKeysで指定された順序 | 指定順（TOML parsers経由） |

### 改ページ条件

N/A（テキストファイルのため該当なし）

## データベース参照仕様

### 参照テーブル一覧

N/A（Gitリポジトリベース）

### テーブル別参照項目詳細

N/A

## 計算仕様

### 計算項目一覧

| 項目名 | 計算式 | 端数処理 | 備考 |
|-------|-------|---------|------|
| body分離 | `const { body = '', ...meta } = data` | N/A | FrontmatterFormatter.toFileでbodyとメタデータを分離 |
| TOML値変換 | outputReplacer関数による型変換 | N/A | Dayjsフォーマット、AssetProxyパス、整数toString（toml.ts経由） |
| 末尾改行トリム | `body.slice(-1) !== '\n'`の場合に末尾改行除去 | N/A | gray-matterの末尾改行付加への対策 |

## 処理フロー

### 出力フロー

```mermaid
flowchart TD
    A[Save操作] --> B[resolveFormat でフォーマッタ決定]
    B --> C[FrontmatterFormatter.toFile 呼び出し]
    C --> D[bodyとmetaを分離]
    D --> E[format = TOML, delimiters = +++]
    E --> F[matter.stringify でFrontmatter生成]
    F --> G[parsers.toml.stringify呼び出し]
    G --> H[tomlFormatter.toFile呼び出し]
    H --> I[末尾改行トリム処理]
    I --> J[バックエンドAPIでGitコミット]
    J --> K[終了]
```

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 表示メッセージ | 対処方法 |
|----------|---------|--------------|---------|
| TOMLシリアライズエラー | メタデータにTOMLで表現できない型が含まれる場合 | tomlifyのエラーメッセージ | メタデータの型・構造を確認 |
| バックエンドエラー | Gitコミットに失敗した場合 | バックエンド固有のエラーメッセージ | ネットワーク接続・認証情報を確認 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定データ件数 | 1エントリ（メタデータ + 本文） |
| 目標出力時間 | 数ミリ秒 |
| 同時出力数上限 | 1件（エディタ操作は逐次処理） |

## セキュリティ考慮事項

- TOML Frontmatter付きMarkdownファイルはGitリポジトリに保存されるため、リポジトリのアクセス制御に依存する
- YAML版と同様、gray-matterライブラリのcustomEngines使用により安全性を確保

## 備考

- YAML Frontmatter（No.4）と同じFrontmatterFormatterクラスを使用し、Languageパラメータのみが異なる
- TOML形式ではコメント付与（comments）パラメータは非対応（parsers.toml.stringifyにcommentsがない）
- カスタムデリミタの指定が可能（frontmatterTOML関数のcustomDelimiter引数）
- フォーマット自動推論時は先頭行の`+++`でTOMLと判定される（inferFrontmatterFormat関数）

---

## コードリーディングガイド

本帳票を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

No.4（YAML Frontmatter）と共通のFrontmatterFormatter構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | frontmatter.ts | `packages/decap-cms-core/src/formats/frontmatter.ts` | parsers.tomlオブジェクト（19-24行目）のparse/stringifyメソッドを確認。stringifyがtomlFormatter.toFileを呼び出すことを理解 |
| 1-2 | toml.ts | `packages/decap-cms-core/src/formats/toml.ts` | outputReplacer関数（8-23行目）によるTOML固有の値変換を確認 |

**読解のコツ**: TOML Frontmatter出力の処理はfrontmatter.ts（共通処理）とtoml.ts（TOML固有処理）の2層構造になっている。parsers.toml.stringifyがメタデータのTOMLシリアライズを担当する。

#### Step 2: エントリーポイントを理解する

FrontmatterFormatterのTOMLモードでのインスタンス化を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | frontmatter.ts | `packages/decap-cms-core/src/formats/frontmatter.ts` | frontmatterTOML関数（144-146行目）でLanguages.TOML指定のFrontmatterFormatterを生成 |
| 2-2 | formats.ts | `packages/decap-cms-core/src/formats/formats.ts` | formatByNameで`toml-frontmatter`キーに対してfrontmatterTOML()を呼び出す（50行目） |

**主要処理フロー**:
1. **144行目**: `frontmatterTOML(customDelimiter)` 呼び出し
2. **145行目**: `new FrontmatterFormatter(Languages.TOML, customDelimiter)` でインスタンス生成
3. **82行目**: getFormatOpts内でTOMLのデリミタ`+++`が設定される

#### Step 3: toFile処理を理解する

No.4と共通のtoFileメソッドがTOML parsersを使用する流れを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | frontmatter.ts | `packages/decap-cms-core/src/formats/frontmatter.ts` | toFileメソッド（112-135行目）はNo.4と同一。format.languageがtomlの場合にparsers.toml.stringifyが使用される |

**主要処理フロー**:
- **117行目**: bodyとmetaの分離（No.4と同じ）
- **126-133行目**: matter.stringify呼び出し。engineとしてparsersが渡され、format.languageがtomlのためparsers.toml.stringifyが選択される
- **21-23行目**: parsers.toml.stringifyがtomlFormatter.toFile(metadata, sortedKeys)を呼び出す

### プログラム呼び出し階層図

```
resolveFormat (formats.ts:66)
    |
    +-- formatByName (formats.ts:42)
            |
            +-- frontmatterTOML (frontmatter.ts:144)
                    |
                    +-- new FrontmatterFormatter('toml', customDelimiter)
                            |
                            +-- toFile (frontmatter.ts:112)
                                    |
                                    +-- matter.stringify (gray-matter library)
                                    |       +-- parsers.toml.stringify
                                    |               +-- tomlFormatter.toFile (toml.ts:30)
                                    |                       +-- tomlify.toToml
                                    |                       +-- outputReplacer (toml.ts:8)
                                    |                       +-- sortKeys (helpers.ts:1)
                                    +-- 末尾改行トリム処理
```

### データフロー図

```
[入力]                          [処理]                          [出力]

entry.data ─────────────┐
  |                     |
  +-- body (string) ----+-> matter.stringify --------> +++区切りの
  |                     |     |                        TOML Frontmatter
  +-- meta (残り) ------+     +-- parsers.toml         付きMarkdown (.md)
                              |     +-- tomlFormatter
sortedKeys (string[]) --------+         +-- outputReplacer
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| frontmatter.ts | `packages/decap-cms-core/src/formats/frontmatter.ts` | ソース | FrontmatterFormatterクラス、parsers.tomlオブジェクト |
| toml.ts | `packages/decap-cms-core/src/formats/toml.ts` | ソース | TOMLフォーマッタ（parsers.toml.stringify経由で呼び出し） |
| formats.ts | `packages/decap-cms-core/src/formats/formats.ts` | ソース | フォーマット解決・フォーマッタ選択ロジック |
| helpers.ts | `packages/decap-cms-core/src/formats/helpers.ts` | ソース | sortKeysユーティリティ（tomlFormatter.toFile経由で使用） |
| AssetProxy.ts | `packages/decap-cms-core/src/valueObjects/AssetProxy.ts` | ソース | AssetProxyクラス（outputReplacerの変換対象） |
