`fmt`

0.20.0の新機能

プロジェクトでコードフォーマッタを実行する。このコマンドはformatにエイリアス付けされています。

Ruffの構成方法に関する詳細については、Ruff設定ドキュメントを参照してください。

例

コードをフォーマットしてファイルに書き戻す

$ rye fmt
1 file reformatted, 231 files left unchanged

コードがフォーマットを必要とするかどうかを確認する

$ rye fmt --check
Would reformat: src/my_project/utils.py
1 file would be reformatted, 231 files already formatted

--を使用して、基盤のruffフォーマッターに追加の引数を渡す

$ rye fmt -- --diff
--- src/my_project/utils.py
+++ src/my_project/utils.py
@@ -2,5 +2,4 @@


 def foo():
-
     pass

1 file would be reformatted, 231 files already formatted

特定のファイルをフォーマットする

rye fmt src/foo.py

引数

[PATHS]... lintするファイルまたはディレクトリのリスト。指定しない場合は、すべてのファイルがフォーマットされます。
[EXTRA_ARGS]... フォーマッターへの追加引数。

これらの引数は直接基盤のフォーマッター（現在は常にruff）に転送されます。追加の引数は--マーカーで他の引数から区切る必要があることに注意してください。

オプション

-a, --all: ワークスペース内のすべてのパッケージをフォーマットする
-p, --package <PACKAGE>: 特定のパッケージをフォーマットする
--pyproject <PYPROJECT_TOML>: このpyproject.tomlファイルを使用する
--check: checkモードでフォーマットを実行する
-v, --verbose: 詳細な診断を有効にする
-q, --quiet: すべての出力をオフにする
-h, --help: ヘルプを表示する（要約は「-h」を参照）