mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-10-02 14:51:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Remove deprecated CLI option --format (#10170)

Browse source 
Co-authored-by: Tibor Reiss <tibor.reiss@gmail.com>
This commit is contained in:
Micha Reiser 2024-02-29 14:59:08 +01:00 • committed by GitHub
parent eceffe74a0
commit 52f4c1e41b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 3 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

8
crates/ruff/src/args.rs
View file

@ -63,10 +63,6 @@ pub enum Command {
/// Output format /// Output format
#[arg(long, value_enum, default_value = "text")] #[arg(long, value_enum, default_value = "text")]
output_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> },
@ -75,10 +71,6 @@ pub enum Command {
/// Output format /// Output format
#[arg(long, value_enum, default_value = "text")] #[arg(long, value_enum, default_value = "text")]
output_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")]

21
crates/ruff/src/lib.rs
View file

@ -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, HelpFormat}; use crate::args::{Args, CheckCommand, Command, FormatCommand};
use crate::printer::{Flags as PrinterFlags, Printer}; use crate::printer::{Flags as PrinterFlags, Printer};
pub mod args; pub mod args;
@ -114,15 +114,6 @@ fn resolve_default_files(files: Vec<PathBuf>, is_stdin: bool) -> Vec<PathBuf> {
} }
} }
/// 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,
@ -171,10 +162,8 @@ pub fn run(
Command::Rule { Command::Rule {
rule, rule,
all, all,
format, output_format,
mut output_format,
} => { } => {
output_format = resolve_help_output_format(output_format, format);
if all { if all {
commands::rule::rules(output_format)?; commands::rule::rules(output_format)?;
} }
@ -187,11 +176,7 @@ pub fn run(
commands::config::config(option.as_deref())?; commands::config::config(option.as_deref())?;
Ok(ExitStatus::Success) Ok(ExitStatus::Success)
} }
Command::Linter { Command::Linter { output_format } => {
format,
mut output_format,
} => {
output_format = resolve_help_output_format(output_format, format);
commands::linter::linter(output_format)?; commands::linter::linter(output_format)?;
Ok(ExitStatus::Success) Ok(ExitStatus::Success)
} }