yx format
YaoXiang のソースコードをフォーマットし、コードスタイルを統一する。
使い方
yx format [OPTIONS] <PATH>引数
| 引数 | 説明 |
|---|---|
PATH | フォーマット対象のソースファイルまたはディレクトリ |
オプション
| オプション | 説明 | デフォルト値 |
|---|---|---|
-n, --dry-run | ドライラン：フォーマットの差分を表示し、書き戻さない | いいえ |
-w, --write | フォーマット結果をその場に書き戻す | いいえ |
--stdout | 標準出力に出力（-n / -w 未指定時のデフォルト動作） | -- |
--no-verify | フォーマット後の検証をスキップ（パフォーマンス最適化） | いいえ |
--indent <N> | インデント幅を上書き | 設定値 |
--line-width <N> | 最大行幅を上書き | 設定値 |
--use-tabs | Tab インデントを使用 | 設定値 |
--single-quote | 文字列に単一引用符を使用 | 設定値 |
設定の優先順位
フォーマットオプションは以下の優先順位で適用される（優先度の高い順）：
- コマンドラインフラグ
- プロジェクト設定
yaoxiang.tomlのフォーマット設定 - ユーザー設定ファイル
設定項目とデフォルト値の詳細については、フォーマット設定の設計 を参照。
終了コード
| 終了コード | 説明 |
|---|---|
0 | 成功（フォーマットが不要な場合を含む） |
2 | --dry-run でフォーマットが必要なファイルが検出された、または .yx ファイルが見つからない |
1 | その他のエラー |
例
bash
# フォーマットして標準出力に出力（デフォルト）
yx format src/main.yx
# その場に書き戻す
yx format -w src/
# CI チェック：フォーマットが必要なファイルがある場合、終了コード 2 で失敗
yx format -n .
# インデントと行幅を一時的に上書き
yx format --indent 4 --line-width 100 main.yxCI との統合
yaml
# GitHub Actions
- name: Format check
run: yx format --dry-run .終了コード 2 はフォーマットが必要なファイルが存在することを示す。詳細な CI 設定については CI 統合ガイド を参照。
関連項目
yx check-- 静的検査yx test-- テストを実行- フォーマットルール概要 -- 各フォーマットルール
- CI 統合ガイド -- CI/CD 統合