Rollup merge of #160998 - ytmimi:nightly_only_cfg_select_formatting, r=jieyouxu

rustfmt: restrict `cfg_select!` formatting to the `nightly` release channel

Closes: #160944

`cfg_select!` formatting was implemented in #154202. The formatting diverged from what was outlined in the original Style FCP (rust-lang/style-team#201 (comment) and #144323 (comment)).

Since the 1.99 beta is scheduled to branch from main on August 14 I want to get this nightly formatting gate out so that we can correct the formatting issues before we promote the formatting to the beta / stable release channels.

Style Guide PR: #160967

r? @jieyouxu

cc: @traviscross

Author: jhpratt

src/tools/rustfmt/src/macros.rs

@@ -27,6 +27,7 @@ use crate::config::StyleEdition;
 use crate::config::lists::*;
 use crate::expr::{RhsAssignKind, rewrite_array, rewrite_assign_rhs};
 use crate::header::{HeaderPart, format_header};
+use crate::is_nightly_channel;
 use crate::lists::{ListFormatting, itemize_list, write_list};
 use crate::overflow;
 use crate::parse::macros::cfg_select::{CfgSelectFormatPredicate, parse_cfg_select_arms};
@@ -247,7 +248,7 @@ fn rewrite_macro_inner(
         }
     }
 
-    if macro_name.ends_with("cfg_select!") {
+    if is_nightly_channel!() && macro_name.ends_with("cfg_select!") {
         match format_cfg_select(context, shape, mac.span(), &macro_name, style, ts.clone()) {
             Ok(rw) => return Ok(rw),
             Err(err) => match err {

src/tools/rustfmt/src/test/mod.rs

@@ -754,6 +754,15 @@ fn check_files(files: Vec<PathBuf>, opt_config: &Option<PathBuf>) -> (Vec<Format
             continue;
         }
 
+        if sig_comments.contains_key("stable") && is_nightly_channel!() {
+            debug!(
+                "Skipping '{}' because nightly introduces formatting changes. \
+                 Formatting should be stable on the `stable` channel.",
+                file_name.display()
+            );
+            continue;
+        }
+
         debug!("Testing '{}'...", file_name.display());
 
         match idempotent_check(&file_name, opt_config) {
@@ -824,7 +833,7 @@ fn read_config(filename: &Path) -> Config {
     };
 
     for (key, val) in &sig_comments {
-        if key != "target" && key != "config" && key != "unstable" {
+        if key != "target" && key != "config" && key != "unstable" && key != "stable" {
             config.override_value(key, val);
             if config.is_default(key) {
                 warn!("Default value {} used explicitly for {}", val, key);

src/tools/rustfmt/tests/source/cfg_select.rs

@@ -1,3 +1,4 @@
+// rustfmt-unstable: true
 // rustfmt-style_edition: 2024
 // rustfmt-skip_children: true
 

src/tools/rustfmt/tests/source/cfg_select_stable.rs

@@ -0,0 +1,10 @@
+// rustfmt-stable: true
+
+// While we gate the `cfg_select!` formatting behind the `is_nightly_channel!()` check
+// this test helps ensure that we don't start formatting `cfg_select!` on the `stable`
+// or `beta` release channels. It is intentionally formatted incorrectly. As soon as the
+// `is_nightly_channel!()` gate is removed this will start formatting and we can remove this test.
+cfg_select! (
+       unix     => 1,
+       windows     => 1,
+);

src/tools/rustfmt/tests/target/cfg_select.rs

@@ -1,3 +1,4 @@
+// rustfmt-unstable: true
 // rustfmt-style_edition: 2024
 // rustfmt-skip_children: true
 

src/tools/rustfmt/tests/target/cfg_select_stable.rs

@@ -0,0 +1,10 @@
+// rustfmt-stable: true
+
+// While we gate the `cfg_select!` formatting behind the `is_nightly_channel!()` check
+// this test helps ensure that we don't start formatting `cfg_select!` on the `stable`
+// or `beta` release channels. It is intentionally formatted incorrectly. As soon as the
+// `is_nightly_channel!()` gate is removed this will start formatting and we can remove this test.
+cfg_select! (
+       unix     => 1,
+       windows     => 1,
+);