RFC-015: YaoXiang 設定システム設計
承認日: 2026-02-15
前提 RFC: RFC-014: パッケージ管理システム設計
概要
YaoXiang 言語の統一設定システムを設計し、ユーザーレベルとプロジェクトレベルの2つのレベルをサポートし、パッケージマネージャー、コンパイラ、REPL、LSP などのコンポーネントに共有の設定インフラストラクチャを提供します。
動機
なぜこの機能/変更が必要なのか
YaoXiang ツールチェーンには複数のコンポーネントが含まれています:
- パッケージマネージャー(依存関係設定を読み取る)
- コンパイラフロントエンド(i18n 設定を読み取る)
- REPL(インタラクション設定を読み取る)
- LSP(fmt/lint/test 設定を読み取る)
- ビルドシステム(ビルド設定を読み取る)
各コンポーネントは統一された設定インフラストラクチャを必要とします。
現在の問題
- 各コンポーネントの設定が分散しており、統一された仕様がない
- ユーザーが好みを統一的に管理できない
- プロジェクト設定とユーザー設定の間に明確なレベル划分がない
提案
コア設計
レイヤーアーキテクチャ:
設定優先度(高 → 低):
┌─────────────────────────────────────────────┐
│ 1. プロジェクトレベル yaoxiang.toml │ ← プロジェクトチームが管理
├─────────────────────────────────────────────┤
│ 2. ユーザーレベル ~/.config/yaoxiang/config.toml │ ← ユーザーの好み
├─────────────────────────────────────────────┤
│ 3. コンパイラのデフォルト値 │ ← 合理的な初期値
└─────────────────────────────────────────────┘ルール:上位レベルは下位レベルを上書きし、設定されていないオプションは下位レベルにフォールバックします。
設定レベルの制限
| 設定節 | ユーザーレベル | プロジェクトレベル | コンシューマー |
|---|---|---|---|
[package].* | ❌ | ✅ | パッケージマネージャー |
[yaoxiang] | ❌ | ✅ | コンパイラ |
[dependencies] | ❌ | ✅ | パッケージマネージャー |
[dev-dependencies] | ❌ | ✅ | パッケージマネージャー |
[bin] | ❌ | ✅ | パッケージマネージャー |
[lib] | ❌ | ✅ | パッケージマネージャー |
[build] | ✅ | ✅ | ビルドシステム |
[profile.*] | ✅ | ✅ | ビルドシステム |
[install] | ✅ | ❌ | パッケージマネージャー |
[i18n] | ✅ | ✅ | コンパイラ |
[repl] | ✅ | ✅ | REPL |
[fmt] | ✅ | ✅ | LSP |
[lint] | ✅ | ✅ | LSP |
[test] | ✅ | ✅ | LSP |
[tasks] | ✅ | ✅ | CLI |
例
プロジェクトレベル設定:
toml
# yaoxiang.toml
[package]
name = "my-package"
version = "0.1.0"
[yaoxiang]
version = ">=0.1.0, <1.0.0"
[dependencies]
foo = "^1.0.0"
[build]
output = "dist/"
[tasks]
build = "yaoxiang build"
test = "yaoxiang test"ユーザーレベル設定:
toml
# ~/.config/yaoxiang/config.toml
[install]
dir = "~/.local/share/yaoxiang"
[i18n]
lang = "zh"
fallback = "en"
[repl]
history-size = 1000
prompt = "yx> "
colors = true
[fmt]
line-width = 120
indent-width = 4
[lint]
rules = ["recommended"]詳細設計
プロジェクトレベル限定設定
toml
[package]
name = "my-package"
version = "0.1.0"
description = "A short description"
authors = ["Alice <alice@example.com>"]
license = "MIT"
repository = "https://github.com/alice/my-project"
[yaoxiang]
version = ">=0.1.0, <1.0.0"
[dependencies]
foo = "^1.0.0"
[dev-dependencies]
test-utils = "0.1.0"
[lib]
path = "src/lib.yx"
[[bin]]
name = "my-cli"
path = "src/cli.yx"
[exports]
"." = "src/lib.yx"
"./foo" = "src/foo.yx"
[build]
script = "build.yx"
output = "dist/"
[profile.release]
optimize = true
lto = true
[run]
main = "src/main.yx"
args = ["--quiet"]
[tasks]
build = "yaoxiang build"
test = "yaoxiang test"
lint = "yaoxiang fmt && yaoxiang check"ユーザーレベル限定設定
toml
[install]
dir = "~/.local/share/yaoxiang"両方で使用可能な設定
| フィールド | タイプ | デフォルト値 | 説明 |
|---|---|---|---|
[i18n].lang | String | "en" | 言語 |
[i18n].fallback | String | "en" | フォールバック言語 |
[repl].history-size | Number | 1000 | 履歴条数 |
[repl].history-file | Path | ~ | 履歴ファイル |
[repl].prompt | String | "yx> " | プロンプト |
[repl].colors | Boolean | true | シンタックスハイライト |
[repl].auto-imports | [String] | [] | 自動インポート |
[fmt].line-width | Number | 120 | 行幅 |
[fmt].indent-width | Number | 4 | インデント |
[fmt].use-tabs | Boolean | false | Tab インデント |
[fmt].single-quote | Boolean | false | シングルクォート |
[lint].rules | [String] | ["recommended"] | ルールセット |
[lint].strict | Boolean | false | 厳格モード |
[test].report | String | "console" | テストレポート |
[build].output | String | "dist/" | 出力ディレクトリ |
コマンドラインと環境変数によるオーバーライド
bash
# コマンドラインによるオーバーライド
yaoxiang run main.yx --lang zh
yaoxiang fmt --config-indent-width=2
# 環境変数
export YAOXIANG_LANG=zh
export YAOXIANG_FMT_INDENT_WIDTH=2優先度:コマンドライン > 環境変数 > 設定ファイル
yaoxiang config コマンド
設定を管理するための CLI コマンドを提供します:
bash
# ユーザーレベル設定を初期化(デフォルトオプションで生成)
yaoxiang config init
# ユーザーレベル設定を編集(エディタを開く)
yaoxiang config edit
# 現在の設定を表示(マージ後の有効な設定)
yaoxiang config show
# 設定ソースを表示
yaoxiang config show --source
# デフォルト設定にリセット
yaoxiang config reset初回実行:ユーザーが初めて yaoxiang コマンドを実行すると、ユーザーレベル設定が存在するかを自動的に検出します。存在しない場合、デフォルトオプションで自動生成されます。
設定ファイルの位置:
- プロジェクトレベル:
./yaoxiang.toml(プロジェクトルートディレクトリ) - ユーザーレベル:
~/.config/yaoxiang/config.toml
設定マージのセマンティクス
異なるレベルの設定は次のルールでマージされます:
| タイプ | ストラテジー | 説明 |
|---|---|---|
| スカラー (String/Number/Boolean) | 置換 | プロジェクトレベルがユーザーレベルを上書き |
| 配列 (Array) | 置換 | プロジェクトレベルがユーザーレベルを完全に置換 |
| オブジェクト (Object) | 深いマージ | フィールドごとにマージし、未定義のフィールドは下位レベルから継承 |
例 - オブジェクトの深いマージ:
toml
# ユーザーレベル
[lint]
rules = ["recommended"]
severity = "warn"
# プロジェクトレベル
[lint]
strict = true
# マージ結果
[lint]
rules = ["recommended"] # ユーザーレベルから
severity = "warn" # ユーザーレベルから
strict = true # プロジェクトレベルから下位互換性
- ✅ 既存の設定ファイルなしモードは引き続きサポート(すべてのコンポーネントは組み込みデフォルト値を使用)
- ✅ 新規設定項目にはすべて合理的なデフォルト値がある
- ✅ ユーザーが初めてコマンドを実行するとデフォルトオプションで設定を自動生成
- ✅ 設定解析失敗時は具体的な行番号とエラー原因を友好的なエラーで表示
トレードオフ
メリット
- 統一された設定インフラストラクチャで重複コードを削減
- ユーザーの好みはプロジェクト間で一貫している
- LSP/REPL/コンパイラは同じ設定セットを共有
- 漸進的な設定で、必要に応じて宣言可能
デメリット
- 設定項目较多で、学習コストが少し増える
- 統一された設定パーサーが必要
代替案
| 案 | なぜ選択しなかったか |
|---|---|
| 各コンポーネント独立設定 | 重複コードが発生し、ユーザー体験が分断される |
| コマンドライン引数のみサポート | ユーザーの好みを永続化できない |
| 環境変数のみサポート | プロジェクト設定がバージョン管理しにくい |
実装戦略
フェーズ分け
| フェーズ | 内容 |
|---|---|
| Phase 1 | 基本的な設定パーサー、toml サポート、プロジェクトレベル設定、yaoxiang config init |
| Phase 2 | ユーザーレベル設定、設定マージロジック、yaoxiang config edit/show |
| Phase 3 | コマンドライン/環境変数によるオーバーライド、platform プラットフォーム制約、[tool.*] 拡張 |
依存関係
- RFC-014 パッケージ管理システムに依存
リスク
| リスク | 緩和措施 |
|---|---|
| 設定項目过多 | 合理的なデフォルト値を提供し、ユーザーには見えない |
| パーサーが複雑 | 既存の toml ライブラリを使用 |
オープン問題
- [x]
features条件付きコンパイル構文? → отдельное RFC に移動、RFC-011 ジェネリクスシステムに依存 - [x]
workspaceワークスペース設計? → отдельное RFC に移動、複雑度が高く、独立して設計する必要がある
承認済み機能(第三フェーズ)
platform プラットフォーム制約
注意:以下の構文は
yaoxiang.toml設定ファイル 用であり、YaoXiang ソースコード (.yxファイル) 内では使用しません。ユーザーはコード内でcfg(...)構文を書く必要はありません。
ターゲット OS/アーキテクチャに基づくプラットフォーム固有設定をサポートします:
toml
# yaoxiang.toml(設定ファイル)
[target.'cfg(windows)'.build]
output = "dist/win32"
[target.'cfg(unix)'.build]
output = "dist/unix"
[target.'cfg(target_arch = "x86_64")'.build]
rustflags = ["-C target-cpu=native"]構文:[target.'<条件>'.<設定節>]
説明:
- この構文は
yaoxiang.toml設定ファイル에만表示されます - ビルド時に
--targetパラメータに基づいて対応する設定が選択されます - ユーザーは
.yxソースコードではcfg(...)構文を書かず、書くべきではありません
サポートされる条件:
cfg(os = "windows")- Windows システムcfg(os = "linux")- Linux システムcfg(os = "macos")- macOS システムcfg(target_arch = "x86_64")- 64ビット x86 アーキテクチャcfg(target_arch = "aarch64")- ARM 64ビットアーキテクチャ
[tool.*] サードパーティツール設定拡張
サードパーティツールが [tool.<名前>] の下に設定を保存することを許可します:
toml
[tool.eslint]
extension = ["yx", "yxp"]
ignore = ["node_modules/", "dist/"]
[tool.prettier]
semi = false
singleQuote = true動作:
- YaoXiang は不明な
[tool.*]節を無視しますが、設定ファイルには保持します - サードパーティツールは
yaoxiang tool run <名前>を通じて統合するか、直接アクセスできます - ツール固有の設定は検証されません
