Remove deprecated configurations 'show-source' and 'no-show-source'

astral-sh · Feb 8, 2024 · e5a7e31 · e5a7e31
1 parent 24e6538
commit e5a7e31
Show file tree

Hide file tree

Showing 6 changed files with 5 additions and 189 deletions.
diff --git a/crates/ruff/src/args.rs b/crates/ruff/src/args.rs
@@ -94,13 +94,6 @@ pub struct CheckCommand {
     unsafe_fixes: bool,
     #[arg(long, overrides_with("unsafe_fixes"), hide = true)]
     no_unsafe_fixes: bool,
-    /// Show violations with source code.
-    /// Use `--no-show-source` to disable.
-    /// (Deprecated: use `--output-format=full` or `--output-format=concise` instead of `--show-source` and `--no-show-source`, respectively)
-    #[arg(long, overrides_with("no_show_source"))]
-    show_source: bool,
-    #[clap(long, overrides_with("show_source"), hide = true)]
-    no_show_source: bool,
     /// Show an enumeration of all fixed lint violations.
     /// Use `--no-show-fixes` to disable.
     #[arg(long, overrides_with("no_show_fixes"))]
@@ -305,7 +298,6 @@ pub struct CheckCommand {
         long,
         // Unsupported default-command arguments.
         conflicts_with = "diff",
-        conflicts_with = "show_source",
         conflicts_with = "watch",
     )]
     pub statistics: bool,
@@ -539,7 +531,6 @@ impl CheckCommand {
                 force_exclude: resolve_bool_arg(self.force_exclude, self.no_force_exclude),
                 output_format: resolve_output_format(
                     self.output_format,
-                    resolve_bool_arg(self.show_source, self.no_show_source),
                     resolve_bool_arg(self.preview, self.no_preview).unwrap_or_default(),
                 ),
                 show_fixes: resolve_bool_arg(self.show_fixes, self.no_show_fixes),
@@ -594,32 +585,11 @@ fn resolve_bool_arg(yes: bool, no: bool) -> Option<bool> {
 
 fn resolve_output_format(
     output_format: Option<SerializationFormat>,
-    show_sources: Option<bool>,
     preview: bool,
 ) -> Option<SerializationFormat> {
-    Some(match (output_format, show_sources) {
-        (Some(o), None) => o,
-        (Some(SerializationFormat::Grouped), Some(true)) => {
-            warn_user!("`--show-source` with `--output-format=grouped` is deprecated, and will not show source files. Use `--output-format=full` to show source information.");
-            SerializationFormat::Grouped
-        }
-        (Some(fmt), Some(true)) => {
-            warn_user!("The `--show-source` argument is deprecated and has been ignored in favor of `--output-format={fmt}`.");
-            fmt
-        }
-        (Some(fmt), Some(false)) => {
-            warn_user!("The `--no-show-source` argument is deprecated and has been ignored in favor of `--output-format={fmt}`.");
-            fmt
-        }
-        (None, Some(true)) => {
-            warn_user!("The `--show-source` argument is deprecated. Use `--output-format=full` instead.");
-            SerializationFormat::Full
-        }
-        (None, Some(false)) => {
-            warn_user!("The `--no-show-source` argument is deprecated. Use `--output-format=concise` instead.");
-            SerializationFormat::Concise
-        }
-        (None, None) => return None
+    Some(match output_format {
+        Some(o) => o,
+        None => return None
     }).map(|format| match format {
         SerializationFormat::Text => {
             warn_user!("`--output-format=text` is deprecated. Use `--output-format=full` or `--output-format=concise` instead. `text` will be treated as `{}`.", SerializationFormat::default(preview));

diff --git a/crates/ruff/tests/deprecation.rs b/crates/ruff/tests/deprecation.rs
@@ -9,141 +9,27 @@ const BIN_NAME: &str = "ruff";
 
 const STDIN: &str = "l = 1";
 
-fn ruff_check(show_source: Option<bool>, output_format: Option<String>) -> Command {
+fn ruff_check(output_format: Option<String>) -> Command {
     let mut cmd = Command::new(get_cargo_bin(BIN_NAME));
     let output_format = output_format.unwrap_or(format!("{}", SerializationFormat::default(false)));
     cmd.arg("--output-format");
     cmd.arg(output_format);
     cmd.arg("--no-cache");
-    match show_source {
-        Some(true) => {
-            cmd.arg("--show-source");
-        }
-        Some(false) => {
-            cmd.arg("--no-show-source");
-        }
-        None => {}
-    }
     cmd.arg("-");
 
     cmd
 }
 
-#[test]
-fn ensure_show_source_is_deprecated() {
-    assert_cmd_snapshot!(ruff_check(Some(true), None).pass_stdin(STDIN), @r###"
-    success: false
-    exit_code: 1
-    ----- stdout -----
-    -:1:1: E741 Ambiguous variable name: `l`
-    Found 1 error.
-
-    ----- stderr -----
-    warning: The `--show-source` argument is deprecated and has been ignored in favor of `--output-format=concise`.
-    "###);
-}
-
-#[test]
-fn ensure_no_show_source_is_deprecated() {
-    assert_cmd_snapshot!(ruff_check(Some(false), None).pass_stdin(STDIN), @r###"
-    success: false
-    exit_code: 1
-    ----- stdout -----
-    -:1:1: E741 Ambiguous variable name: `l`
-    Found 1 error.
-
-    ----- stderr -----
-    warning: The `--no-show-source` argument is deprecated and has been ignored in favor of `--output-format=concise`.
-    "###);
-}
-
 #[test]
 fn ensure_output_format_is_deprecated() {
-    assert_cmd_snapshot!(ruff_check(None, Some("text".into())).pass_stdin(STDIN), @r###"
-    success: false
-    exit_code: 1
-    ----- stdout -----
-    -:1:1: E741 Ambiguous variable name: `l`
-    Found 1 error.
-
-    ----- stderr -----
-    warning: `--output-format=text` is deprecated. Use `--output-format=full` or `--output-format=concise` instead. `text` will be treated as `concise`.
-    "###);
-}
-
-#[test]
-fn ensure_output_format_overrides_show_source() {
-    assert_cmd_snapshot!(ruff_check(Some(true), Some("concise".into())).pass_stdin(STDIN), @r###"
-    success: false
-    exit_code: 1
-    ----- stdout -----
-    -:1:1: E741 Ambiguous variable name: `l`
-    Found 1 error.
-
-    ----- stderr -----
-    warning: The `--show-source` argument is deprecated and has been ignored in favor of `--output-format=concise`.
-    "###);
-}
-
-#[test]
-fn ensure_full_output_format_overrides_no_show_source() {
-    assert_cmd_snapshot!(ruff_check(Some(false), Some("full".into())).pass_stdin(STDIN), @r###"
-    success: false
-    exit_code: 1
-    ----- stdout -----
-    -:1:1: E741 Ambiguous variable name: `l`
-      |
-    1 | l = 1
-      | ^ E741
-      |
-
-    Found 1 error.
-
-    ----- stderr -----
-    warning: The `--no-show-source` argument is deprecated and has been ignored in favor of `--output-format=full`.
-    "###);
-}
-
-#[test]
-fn ensure_output_format_uses_concise_over_no_show_source() {
-    assert_cmd_snapshot!(ruff_check(Some(false), Some("concise".into())).pass_stdin(STDIN), @r###"
-    success: false
-    exit_code: 1
-    ----- stdout -----
-    -:1:1: E741 Ambiguous variable name: `l`
-    Found 1 error.
-
-    ----- stderr -----
-    warning: The `--no-show-source` argument is deprecated and has been ignored in favor of `--output-format=concise`.
-    "###);
-}
-
-#[test]
-fn ensure_deprecated_output_format_overrides_show_source() {
-    assert_cmd_snapshot!(ruff_check(Some(true), Some("text".into())).pass_stdin(STDIN), @r###"
-    success: false
-    exit_code: 1
-    ----- stdout -----
-    -:1:1: E741 Ambiguous variable name: `l`
-    Found 1 error.
-
-    ----- stderr -----
-    warning: The `--show-source` argument is deprecated and has been ignored in favor of `--output-format=text`.
-    warning: `--output-format=text` is deprecated. Use `--output-format=full` or `--output-format=concise` instead. `text` will be treated as `concise`.
-    "###);
-}
-
-#[test]
-fn ensure_deprecated_output_format_overrides_no_show_source() {
-    assert_cmd_snapshot!(ruff_check(Some(false), Some("text".into())).pass_stdin(STDIN), @r###"
+    assert_cmd_snapshot!(ruff_check(Some("text".into())).pass_stdin(STDIN), @r###"
     success: false
     exit_code: 1
     ----- stdout -----
     -:1:1: E741 Ambiguous variable name: `l`
     Found 1 error.
 
     ----- stderr -----
-    warning: The `--no-show-source` argument is deprecated and has been ignored in favor of `--output-format=text`.
     warning: `--output-format=text` is deprecated. Use `--output-format=full` or `--output-format=concise` instead. `text` will be treated as `concise`.
     "###);
 }
diff --git a/crates/ruff_workspace/src/configuration.rs b/crates/ruff_workspace/src/configuration.rs
@@ -421,12 +421,6 @@ impl Configuration {
 
         #[allow(deprecated)]
         let output_format = {
-            if options.show_source.is_some() {
-                warn_user_once!(
-                    r#"The `show-source` option has been deprecated in favor of `output-format`'s "full" and "concise" variants. Please update your configuration to use `output-format = <full|concise>` instead."#
-                );
-            }
-
             options
                 .output_format
                 .map(|format| match format {
@@ -436,13 +430,6 @@ impl Configuration {
                     },
                     other => other
                 })
-                .or(options.show_source.map(|show_source| {
-                    if show_source {
-                        SerializationFormat::Full
-                    } else {
-                        SerializationFormat::Concise
-                    }
-                }))
         };
 
         Ok(Self {

diff --git a/crates/ruff_workspace/src/options.rs b/crates/ruff_workspace/src/options.rs
@@ -108,21 +108,6 @@ pub struct Options {
     #[option(default = "false", value_type = "bool", example = "fix-only = true")]
     pub fix_only: Option<bool>,
 
-    /// Whether to show source code snippets when reporting lint violations
-    /// (overridden by the `--show-source` command-line flag).
-    #[option(
-        default = "false",
-        value_type = "bool",
-        example = r#"
-            # By default, always show source code snippets.
-            show-source = true
-        "#
-    )]
-    #[deprecated(
-        note = "`show_source` is deprecated and is now part of `output_format` in the form of `full` or `concise` options. Please update your configuration."
-    )]
-    pub show_source: Option<bool>,
-
     /// Whether to show an enumeration of all fixed lint violations
     /// (overridden by the `--show-fixes` command-line flag).
     #[option(

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -509,10 +509,6 @@ Options:
       --unsafe-fixes
           Include fixes that may not retain the original intent of the code.
           Use `--no-unsafe-fixes` to disable
-      --show-source
-          Show violations with source code. Use `--no-show-source` to disable.
-          (Deprecated: use `--output-format=full` or `--output-format=concise`
-          instead of `--show-source` and `--no-show-source`, respectively)
       --show-fixes
           Show an enumeration of all fixed lint violations. Use
           `--no-show-fixes` to disable

diff --git a/ruff.schema.json b/ruff.schema.json