# 帳票設計書 5-to yml

## 概要

本ドキュメントは、Nushellの`to yml`コマンドに関する設計書である。`to yml`コマンドは`to yaml`コマンドのエイリアスであり、任意のNushellデータをYAML形式のテキストに変換するデータ変換コマンドである。

### 本帳票の処理概要

`to yml`コマンドは、`to yaml`コマンドと完全に同一の機能を提供する。内部的には同じ変換関数`to_yaml`を呼び出しており、コマンド名のみが異なる。YAMLファイルの拡張子として`.yml`を使用する慣習に対応するために提供されている。

**業務上の目的・背景**：YAMLファイルの拡張子として`.yaml`と`.yml`の両方が広く使用されているため、ユーザーの好みや既存の命名規則に合わせてコマンドを選択できるようにしている。特にGitHubActionsの設定ファイルなど、`.yml`拡張子が標準的に使用されるケースに対応する。

**帳票の利用シーン**：
- GitHub Actions設定ファイルの生成（.yml拡張子が標準）
- 短い拡張子を好むユーザー向け
- 既存の.ymlファイルとの一貫性維持
- スクリプト内でのファイル拡張子との対応

**主要な出力内容**：
1. YAMLマッピング（レコードから変換）
2. YAMLシーケンス（リストから変換）
3. YAMLスカラー値（文字列、数値、真偽値など）

**帳票の出力タイミング**：パイプライン処理において`to yml`コマンドが実行されたとき

**帳票の利用者**：Nushellユーザー、DevOpsエンジニア、システム管理者

## 帳票種別

データ変換出力（テキスト形式）

## 利用画面

| 画面No | 画面名 | URL/ルーティング | 出力操作 |
|--------|--------|-----------------|---------|
| N/A | Nushell CLI | コマンドライン | `to yml` コマンド実行 |

## 出力形式

### 基本仕様

| 項目 | 内容 |
|-----|------|
| ファイル形式 | YAML (テキスト) |
| 用紙サイズ | N/A |
| 向き | N/A |
| ファイル名 | パイプラインで`save`コマンドと組み合わせて指定 |
| 出力方法 | 標準出力またはファイル保存 |
| 文字コード | UTF-8 |

### 出力オプション

| オプション | 短縮形 | 説明 | デフォルト値 |
|-----------|--------|------|-------------|
| --serialize | -s | デシリアライズ不可能なNushell型をシリアライズ | false |

## 帳票レイアウト

### レイアウト概要

YAML出力は`to yaml`コマンドと同一の構造を持つ。

```
┌─────────────────────────────────────┐
│  YAML構造                           │
│  key1: value1                       │
│  key2:                              │
│    - item1                          │
│    - item2                          │
│  key3:                              │
│    nested: true                     │
└─────────────────────────────────────┘
```

### 型変換マッピング

`to yaml`コマンドと同一。詳細は「4-to_yaml.md」を参照。

## 出力条件

### 入力条件

| 条件名 | 説明 | 必須 |
|-------|------|-----|
| 入力データ型 | Any（任意の型） | Yes |

### 制約条件

`to yaml`コマンドと同一。

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

### 参照テーブル一覧

本コマンドはデータベースを直接参照しない。パイプラインから受け取るデータを処理する。

## 計算仕様

### 計算項目一覧

本コマンドには計算処理は含まれない。型変換のみ実施。

## 処理フロー

### 出力フロー

```mermaid
flowchart TD
    A[入力データ受信] --> B[オプション解析]
    B --> C[Range展開]
    C --> D[to_yaml関数呼び出し]
    D --> E[value_to_yaml_value変換]
    E --> F[serde_yaml::to_string]
    F --> G{変換成功?}
    G -->|Yes| H[Value::string作成]
    G -->|No| I[CantConvertエラー]
    H --> J[メタデータ付与]
    J --> K[PipelineData返却]
    I --> K
```

## エラー処理

### エラーケース一覧

`to yaml`コマンドと同一。

| エラー種別 | 発生条件 | 表示メッセージ | 対処方法 |
|----------|---------|--------------|---------|
| CantConvert | YAML変換失敗 | "CantConvert to YAML" | 入力データを確認 |
| Error伝播 | Value::Error入力 | 元のエラーメッセージ | 元のエラーを解決 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定データ件数 | メモリ制限内 |
| 目標出力時間 | データサイズに依存 |
| 同時出力数上限 | N/A |

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

`to yaml`コマンドと同一。

## 備考

- `to yaml`コマンドのエイリアスとして実装
- content_type メタデータは "application/yaml" として設定される
- 内部的には同じ`to_yaml`関数を呼び出す

---

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

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

### 推奨読解順序

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

`to yml`コマンドの実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | yaml.rs | `crates/nu-command/src/formats/to/yaml.rs` | ToYml構造体とCommandトレイト実装（50-94行目） |

**主要処理フロー**:
1. **54行目**: コマンド名 "to yml" の定義
2. **58-66行目**: シグネチャ定義（--serializeオプション）
3. **81-93行目**: runメソッドで`to_yaml`関数を呼び出し

**読解のコツ**: ToYmlとToYamlの実装を比較し、nameメソッド以外は同一であることを確認する。

#### Step 2: 共通変換ロジックを理解する

`to_yaml`関数の詳細は「4-to_yaml.md」のコードリーディングガイドを参照。

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

```
ToYml::run (yaml.rs:81)
    │
    ├─ input.try_expand_range() (yaml.rs:90)
    │
    └─ to_yaml (yaml.rs:92)  ← ToYaml::runと同じ関数
           │
           ├─ input.into_value()
           │
           ├─ value_to_yaml_value
           │
           └─ serde_yaml::to_string
```

### データフロー図

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

Value (Any型) ────────▶ ToYml::run ──────────────────▶ PipelineData::Value
                              │                              │
                              ▼                              ▼
                        to_yaml                        YAML形式文字列
                        (ToYamlと共通)                 "key: value\n"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| yaml.rs | `crates/nu-command/src/formats/to/yaml.rs` | ソース | to yaml / to ymlコマンドの実装（同一ファイル） |
| mod.rs | `crates/nu-command/src/formats/to/mod.rs` | ソース | toモジュールの公開定義 |
| serde_yaml (crate) | 外部依存 | ライブラリ | YAML出力ライブラリ |
