diff --git a/crates/ruff/src/args.rs b/crates/ruff/src/args.rs index da6d3833b7ba8..88abc70d5ad97 100644 --- a/crates/ruff/src/args.rs +++ b/crates/ruff/src/args.rs @@ -207,7 +207,7 @@ pub struct AnalyzeGraphCommand { #[expect(clippy::struct_excessive_bools)] pub struct CheckCommand { /// List of files or directories to check. - #[clap(help = "List of files or directories to check [default: .]")] + #[clap(help = "List of files or directories to check, or `-` to read from stdin [default: .]")] pub files: Vec, /// Apply fixes to resolve lint violations. /// Use `--no-fix` to disable or `--unsafe-fixes` to include unsafe fixes. @@ -475,7 +475,9 @@ pub struct CheckCommand { #[expect(clippy::struct_excessive_bools)] pub struct FormatCommand { /// List of files or directories to format. - #[clap(help = "List of files or directories to format [default: .]")] + #[clap( + help = "List of files or directories to format, or `-` to read from stdin [default: .]" + )] pub files: Vec, /// Avoid writing any formatted files back; instead, exit with a non-zero status code if any /// files would have been modified, and zero otherwise. diff --git a/docs/configuration.md b/docs/configuration.md index 02b89c4c55b97..4ab08aa2cb52a 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -575,7 +575,8 @@ Run Ruff on the given files or directories Usage: ruff check [OPTIONS] [FILES]... Arguments: - [FILES]... List of files or directories to check [default: .] + [FILES]... List of files or directories to check, or `-` to read from stdin + [default: .] Options: --fix @@ -710,7 +711,8 @@ Run the Ruff formatter on the given files or directories Usage: ruff format [OPTIONS] [FILES]... Arguments: - [FILES]... List of files or directories to format [default: .] + [FILES]... List of files or directories to format, or `-` to read from stdin + [default: .] Options: --check