Abort or warn user when they use unstable options on stable channel

This commit fully implements the feature requested in 5022.

Author: ytmimi

src/bin/main.rs

@@ -276,6 +276,7 @@ fn format_string(input: String, options: GetOptsOptions) -> Result<i32> {
     }
 
     let out = &mut stdout();
+    rustfmt::abort_or_warn_on_unstable_options!(config);
     let mut session = Session::new(config, Some(out));
     format_and_emit_report(&mut session, Input::Text(input));
 
@@ -302,6 +303,8 @@ fn format(
     }
 
     let out = &mut stdout();
+
+    rustfmt::abort_or_warn_on_unstable_options!(config);
     let mut session = Session::new(config, Some(out));
 
     for file in files {
@@ -326,6 +329,7 @@ fn format(
                     }
                 }
 
+                rustfmt::abort_or_warn_on_unstable_options!(local_config);
                 session.override_config(local_config, |sess| {
                     format_and_emit_report(sess, Input::File(file))
                 });

src/config/mod.rs

@@ -322,6 +322,24 @@ impl Config {
             }
         }
     }
+
+    /// When using nightly options on stable channel decide whether to abort or
+    /// log out warnings to the user.
+    pub fn abort_or_warn_on_unstable_options(&self) -> Option<HandleUnstableOptions> {
+        if !self.using_unstable_options_on_stable_channel() {
+            return None;
+        }
+
+        if self.abort_on_unrecognised_options() {
+            Some(HandleUnstableOptions::Abort(
+                self.unstable_options_abort_message().unwrap(),
+            ))
+        } else {
+            Some(HandleUnstableOptions::Warn(
+                self.unstable_options_warning_message().unwrap(),
+            ))
+        }
+    }
 }
 
 /// Loads a config by checking the client-supplied options and if appropriate, the
@@ -402,6 +420,29 @@ fn config_path(options: &dyn CliOptions) -> Result<Option<PathBuf>, Error> {
     }
 }
 
+#[macro_export]
+macro_rules! abort_or_warn_on_unstable_options {
+    ($config:expr) => {
+        match $config.abort_or_warn_on_unstable_options() {
+            Some($crate::HandleUnstableOptions::Abort(message)) => {
+                eprint!("{}", message);
+                return Ok(1);
+            }
+            Some($crate::HandleUnstableOptions::Warn(message)) => {
+                eprint!("{}", message);
+            }
+            None => {}
+        }
+    };
+}
+
+#[allow(unreachable_pub)]
+pub use abort_or_warn_on_unstable_options;
+pub enum HandleUnstableOptions {
+    Abort(String),
+    Warn(String),
+}
+
 #[cfg(test)]
 mod test {
     use super::*;
@@ -647,6 +688,68 @@ Set `abort_on_unrecognised_options = false` to convert this error into a warning
         assert!(config.unstable_options_abort_message().is_none())
     }
 
+    #[test]
+    fn test_on_stable_handle_unstable_options_by_issuing_a_warning() {
+        if crate::is_nightly_channel!() {
+            // This test requires non-nightly
+            return;
+        }
+        let toml = r#"
+            reorder_impl_items = true
+            abort_on_unrecognised_options = false
+        "#;
+        let config = Config::from_toml(toml, Path::new("")).unwrap();
+        assert!(matches!(
+            config.abort_or_warn_on_unstable_options(),
+            Some(HandleUnstableOptions::Warn(_))
+        ))
+    }
+
+    #[test]
+    fn test_on_stable_handle_unstable_options_by_aborting() {
+        if crate::is_nightly_channel!() {
+            // This test requires non-nightly
+            return;
+        }
+        let toml = r#"
+            reorder_impl_items = true
+            abort_on_unrecognised_options = true
+        "#;
+        let config = Config::from_toml(toml, Path::new("")).unwrap();
+        assert!(matches!(
+            config.abort_or_warn_on_unstable_options(),
+            Some(HandleUnstableOptions::Abort(_))
+        ))
+    }
+
+    #[test]
+    fn test_on_stable_no_need_to_handle_unstable_options_since_non_are_used() {
+        if crate::is_nightly_channel!() {
+            // This test requires non-nightly
+            return;
+        }
+        use self::*;
+        let toml = r#"
+            array_width = 50
+        "#;
+        let config = Config::from_toml(toml, Path::new("")).unwrap();
+        assert!(matches!(config.abort_or_warn_on_unstable_options(), None))
+    }
+
+    #[test]
+    fn test_on_unstable_no_need_to_warn_or_abort_when_usinig_unstable_options() {
+        if !crate::is_nightly_channel!() {
+            // This test requires nightly
+            return;
+        }
+        use self::*;
+        let toml = r#"
+            array_width = 50
+        "#;
+        let config = Config::from_toml(toml, Path::new("")).unwrap();
+        assert!(matches!(config.abort_or_warn_on_unstable_options(), None))
+    }
+
     #[test]
     fn test_dump_default_config() {
         let default_config = format!(

src/lib.rs

@@ -45,8 +45,8 @@ use crate::syntux::parser::DirectoryOwnership;
 use crate::utils::indent_next_line;
 
 pub use crate::config::{
-    load_config, CliOptions, Color, Config, Edition, EmitMode, FileLines, FileName, NewlineStyle,
-    Range, Verbosity,
+    load_config, CliOptions, Color, Config, Edition, EmitMode, FileLines, FileName,
+    HandleUnstableOptions, NewlineStyle, Range, Verbosity,
 };
 
 pub use crate::format_report_formatter::{FormatReportFormatter, FormatReportFormatterBuilder};