mirror of
https://github.com/astral-sh/ruff.git
synced 2025-10-02 06:42:02 +00:00
Harmonize help commands' --format
to --output-format
with deprecation warnings (#8203)
## Summary Since `--format` was changed to `--output-format` for `check`, it feels like it makes sense for the same to work for the auxiliary commands. This * adds the same deprecation warning that used to be a thing in #7514 (and un-became a thing in #7984) Fixes #7990. ## Test Plan * `cargo run --bin=ruff -- rule --all --output-format=json` works * `cargo run --bin=ruff -- rule --format=json` works with warnings
This commit is contained in:
parent
9f5102d536
commit
7b4b004506
2 changed files with 35 additions and 8 deletions
|
@ -50,7 +50,11 @@ pub enum Command {
|
||||||
|
|
||||||
/// Output format
|
/// Output format
|
||||||
#[arg(long, value_enum, default_value = "text")]
|
#[arg(long, value_enum, default_value = "text")]
|
||||||
format: HelpFormat,
|
output_format: HelpFormat,
|
||||||
|
|
||||||
|
/// Output format (Deprecated: Use `--output-format` instead).
|
||||||
|
#[arg(long, value_enum, conflicts_with = "output_format", hide = true)]
|
||||||
|
format: Option<HelpFormat>,
|
||||||
},
|
},
|
||||||
/// List or describe the available configuration options.
|
/// List or describe the available configuration options.
|
||||||
Config { option: Option<String> },
|
Config { option: Option<String> },
|
||||||
|
@ -58,7 +62,11 @@ pub enum Command {
|
||||||
Linter {
|
Linter {
|
||||||
/// Output format
|
/// Output format
|
||||||
#[arg(long, value_enum, default_value = "text")]
|
#[arg(long, value_enum, default_value = "text")]
|
||||||
format: HelpFormat,
|
output_format: HelpFormat,
|
||||||
|
|
||||||
|
/// Output format (Deprecated: Use `--output-format` instead).
|
||||||
|
#[arg(long, value_enum, conflicts_with = "output_format", hide = true)]
|
||||||
|
format: Option<HelpFormat>,
|
||||||
},
|
},
|
||||||
/// Clear any caches in the current directory and any subdirectories.
|
/// Clear any caches in the current directory and any subdirectories.
|
||||||
#[clap(alias = "--clean")]
|
#[clap(alias = "--clean")]
|
||||||
|
|
|
@ -18,7 +18,7 @@ use ruff_linter::settings::types::SerializationFormat;
|
||||||
use ruff_linter::{fs, warn_user, warn_user_once};
|
use ruff_linter::{fs, warn_user, warn_user_once};
|
||||||
use ruff_workspace::Settings;
|
use ruff_workspace::Settings;
|
||||||
|
|
||||||
use crate::args::{Args, CheckCommand, Command, FormatCommand};
|
use crate::args::{Args, CheckCommand, Command, FormatCommand, HelpFormat};
|
||||||
use crate::printer::{Flags as PrinterFlags, Printer};
|
use crate::printer::{Flags as PrinterFlags, Printer};
|
||||||
|
|
||||||
pub mod args;
|
pub mod args;
|
||||||
|
@ -101,6 +101,15 @@ fn is_stdin(files: &[PathBuf], stdin_filename: Option<&Path>) -> bool {
|
||||||
file == Path::new("-")
|
file == Path::new("-")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Get the actual value of the `format` desired from either `output_format`
|
||||||
|
/// or `format`, and warn the user if they're using the deprecated form.
|
||||||
|
fn resolve_help_output_format(output_format: HelpFormat, format: Option<HelpFormat>) -> HelpFormat {
|
||||||
|
if format.is_some() {
|
||||||
|
warn_user!("The `--format` argument is deprecated. Use `--output-format` instead.");
|
||||||
|
}
|
||||||
|
format.unwrap_or(output_format)
|
||||||
|
}
|
||||||
|
|
||||||
pub fn run(
|
pub fn run(
|
||||||
Args {
|
Args {
|
||||||
command,
|
command,
|
||||||
|
@ -141,12 +150,18 @@ pub fn run(
|
||||||
commands::version::version(output_format)?;
|
commands::version::version(output_format)?;
|
||||||
Ok(ExitStatus::Success)
|
Ok(ExitStatus::Success)
|
||||||
}
|
}
|
||||||
Command::Rule { rule, all, format } => {
|
Command::Rule {
|
||||||
|
rule,
|
||||||
|
all,
|
||||||
|
format,
|
||||||
|
mut output_format,
|
||||||
|
} => {
|
||||||
|
output_format = resolve_help_output_format(output_format, format);
|
||||||
if all {
|
if all {
|
||||||
commands::rule::rules(format)?;
|
commands::rule::rules(output_format)?;
|
||||||
}
|
}
|
||||||
if let Some(rule) = rule {
|
if let Some(rule) = rule {
|
||||||
commands::rule::rule(rule, format)?;
|
commands::rule::rule(rule, output_format)?;
|
||||||
}
|
}
|
||||||
Ok(ExitStatus::Success)
|
Ok(ExitStatus::Success)
|
||||||
}
|
}
|
||||||
|
@ -154,8 +169,12 @@ pub fn run(
|
||||||
commands::config::config(option.as_deref())?;
|
commands::config::config(option.as_deref())?;
|
||||||
Ok(ExitStatus::Success)
|
Ok(ExitStatus::Success)
|
||||||
}
|
}
|
||||||
Command::Linter { format } => {
|
Command::Linter {
|
||||||
commands::linter::linter(format)?;
|
format,
|
||||||
|
mut output_format,
|
||||||
|
} => {
|
||||||
|
output_format = resolve_help_output_format(output_format, format);
|
||||||
|
commands::linter::linter(output_format)?;
|
||||||
Ok(ExitStatus::Success)
|
Ok(ExitStatus::Success)
|
||||||
}
|
}
|
||||||
Command::Clean => {
|
Command::Clean => {
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue