Skip to content

Commit 227e361

Browse files
ytmimiytmimi
committed
Merge remote-tracking branch 'upstream/master' into subtree_push_2023_12_12
2 parents 948c904 + 2174e60 commit 227e361

File tree

12 files changed

+184
-14
lines changed

12 files changed

+184
-14
lines changed

‎Cargo.lock

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎ci/check_diff.sh

+30-6
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22

33
set -e
44

5-
# https://github.com/rust-lang/rustfmt/issues/5675
6-
export LD_LIBRARY_PATH=$(rustc --print sysroot)/lib:$LD_LIBRARY_PATH
7-
85
function print_usage() {
96
echo "usage check_diff REMOTE_REPO FEATURE_BRANCH [COMMIT_HASH] [OPTIONAL_RUSTFMT_CONFIGS]"
107
}
@@ -114,15 +111,42 @@ function compile_rustfmt() {
114111
git remote add feature $REMOTE_REPO
115112
git fetch feature $FEATURE_BRANCH
116113

117-
cargo build --release --bin rustfmt && cp target/release/rustfmt $1/rustfmt
114+
CARGO_VERSON=$(cargo --version)
115+
echo -e "\ncompiling with $CARGO_VERSON\n"
116+
117+
# Because we're building standalone binaries we need to set `LD_LIBRARY_PATH` so each
118+
# binary can find it's runtime dependencies. See https://github.com/rust-lang/rustfmt/issues/5675
119+
# This will prepend the `LD_LIBRARY_PATH` for the master rustfmt binary
120+
export LD_LIBRARY_PATH=$(rustc --print sysroot)/lib:$LD_LIBRARY_PATH
121+
122+
echo "Building rustfmt from src"
123+
cargo build -q --release --bin rustfmt && cp target/release/rustfmt $1/rustfmt
124+
118125
if [ -z "$OPTIONAL_COMMIT_HASH" ] || [ "$FEATURE_BRANCH" = "$OPTIONAL_COMMIT_HASH" ]; then
119126
git switch $FEATURE_BRANCH
120127
else
121128
git switch $OPTIONAL_COMMIT_HASH --detach
122129
fi
123-
cargo build --release --bin rustfmt && cp target/release/rustfmt $1/feature_rustfmt
130+
131+
# This will prepend the `LD_LIBRARY_PATH` for the feature branch rustfmt binary.
132+
# In most cases the `LD_LIBRARY_PATH` should be the same for both rustfmt binaries that we build
133+
# in `compile_rustfmt`, however, there are scenarios where each binary has different runtime
134+
# dependencies. For example, during subtree syncs we bump the nightly toolchain required to build
135+
# rustfmt, and therefore the feature branch relies on a newer set of runtime dependencies.
136+
export LD_LIBRARY_PATH=$(rustc --print sysroot)/lib:$LD_LIBRARY_PATH
137+
138+
echo "Building feature rustfmt from src"
139+
cargo build -q --release --bin rustfmt && cp target/release/rustfmt $1/feature_rustfmt
140+
141+
echo -e "\nRuntime dependencies for rustfmt -- LD_LIBRARY_PATH: $LD_LIBRARY_PATH"
142+
124143
RUSFMT_BIN=$1/rustfmt
144+
RUSTFMT_VERSION=$($RUSFMT_BIN --version)
145+
echo -e "\nRUSFMT_BIN $RUSTFMT_VERSION\n"
146+
125147
FEATURE_BIN=$1/feature_rustfmt
148+
FEATURE_VERSION=$($FEATURE_BIN --version)
149+
echo -e "FEATURE_BIN $FEATURE_VERSION\n"
126150
}
127151

128152
# Check the diff for running rustfmt and the feature branch on all the .rs files in the repo.
@@ -155,7 +179,7 @@ function check_repo() {
155179
STATUSES+=($?)
156180
set -e
157181

158-
echo "removing tmp_dir $tmp_dir"
182+
echo -e "removing tmp_dir $tmp_dir\n\n"
159183
rm -rf $tmp_dir
160184
cd $WORKDIR
161185
}

‎src/config/mod.rs

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ pub(crate) mod file_lines;
2626
#[allow(unreachable_pub)]
2727
pub(crate) mod lists;
2828
pub(crate) mod macro_names;
29+
pub(crate) mod style_edition;
2930

3031
// This macro defines configuration options used in rustfmt. Each option
3132
// is defined as follows:

‎src/config/options.rs

+24
Original file line numberDiff line numberDiff line change
@@ -470,3 +470,27 @@ pub enum MatchArmLeadingPipe {
470470
/// Preserve any existing leading pipes
471471
Preserve,
472472
}
473+
474+
/// Defines the default values for each config according to [the style guide].
475+
/// rustfmt output may differ between style editions.
476+
///
477+
/// [the style guide]: https://doc.rust-lang.org/nightly/style-guide/
478+
#[config_type]
479+
pub enum StyleEdition {
480+
#[value = "2015"]
481+
#[doc_hint = "2015"]
482+
/// [Edition 2015]()
483+
Edition2015,
484+
#[value = "2018"]
485+
#[doc_hint = "2018"]
486+
/// [Edition 2018]()
487+
Edition2018,
488+
#[value = "2021"]
489+
#[doc_hint = "2021"]
490+
/// [Edition 2021]()
491+
Edition2021,
492+
#[value = "2024"]
493+
#[doc_hint = "2024"]
494+
/// [Edition 2024]().
495+
Edition2024,
496+
}

‎src/config/style_edition.rs

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
use crate::config::StyleEdition;
2+
3+
/// Defines the default value for the given style edition
4+
pub(crate) trait StyleEditionDefault {
5+
type ConfigType;
6+
fn style_edition_default(style_edition: StyleEdition) -> Self::ConfigType;
7+
}
8+
9+
/// macro to help implement `StyleEditionDefault` for config options
10+
#[macro_export]
11+
macro_rules! style_edition_default {
12+
($ty:ident, $config_ty:ty, _ => $default:expr) => {
13+
impl $crate::config::style_edition::StyleEditionDefault for $ty {
14+
type ConfigType = $config_ty;
15+
16+
fn style_edition_default(_: $crate::config::StyleEdition) -> Self::ConfigType {
17+
$default
18+
}
19+
}
20+
};
21+
($ty:ident, $config_ty:ty, Edition2024 => $default_2024:expr, _ => $default_2015:expr) => {
22+
impl $crate::config::style_edition::StyleEditionDefault for $ty {
23+
type ConfigType = $config_ty;
24+
25+
fn style_edition_default(
26+
style_edition: $crate::config::StyleEdition,
27+
) -> Self::ConfigType {
28+
match style_edition {
29+
$crate::config::StyleEdition::Edition2015
30+
| $crate::config::StyleEdition::Edition2018
31+
| $crate::config::StyleEdition::Edition2021 => $default_2015,
32+
$crate::config::StyleEdition::Edition2024 => $default_2024,
33+
}
34+
}
35+
}
36+
};
37+
}
38+
39+
#[cfg(test)]
40+
mod test {
41+
use super::*;
42+
use crate::config::StyleEdition;
43+
44+
#[test]
45+
fn test_impl_default_style_edition_struct_for_all_editions() {
46+
struct Unit;
47+
style_edition_default!(Unit, usize, _ => 100);
48+
49+
// regardless of the style edition used the value will always return 100
50+
assert_eq!(Unit::style_edition_default(StyleEdition::Edition2015), 100);
51+
assert_eq!(Unit::style_edition_default(StyleEdition::Edition2018), 100);
52+
assert_eq!(Unit::style_edition_default(StyleEdition::Edition2021), 100);
53+
assert_eq!(Unit::style_edition_default(StyleEdition::Edition2024), 100);
54+
}
55+
56+
#[test]
57+
fn test_impl_default_style_edition_for_old_and_new_editions() {
58+
struct Unit;
59+
style_edition_default!(Unit, usize, Edition2024 => 50, _ => 100);
60+
61+
// style edition 2015-2021 are all the same
62+
assert_eq!(Unit::style_edition_default(StyleEdition::Edition2015), 100);
63+
assert_eq!(Unit::style_edition_default(StyleEdition::Edition2018), 100);
64+
assert_eq!(Unit::style_edition_default(StyleEdition::Edition2021), 100);
65+
66+
// style edition 2024
67+
assert_eq!(Unit::style_edition_default(StyleEdition::Edition2024), 50);
68+
}
69+
}

‎src/items.rs

+6-4
Original file line numberDiff line numberDiff line change
@@ -832,13 +832,15 @@ pub(crate) fn format_impl(
832832

833833
if is_impl_single_line(context, items.as_slice(), &result, &where_clause_str, item)? {
834834
result.push_str(&where_clause_str);
835-
if where_clause_str.contains('\n') || last_line_contains_single_line_comment(&result) {
836-
// if the where_clause contains extra comments AND
837-
// there is only one where-clause predicate
838-
// recover the suppressed comma in single line where_clause formatting
835+
if where_clause_str.contains('\n') {
836+
// If there is only one where-clause predicate
837+
// and the where-clause spans multiple lines,
838+
// then recover the suppressed comma in single line where-clause formatting
839839
if generics.where_clause.predicates.len() == 1 {
840840
result.push(',');
841841
}
842+
}
843+
if where_clause_str.contains('\n') || last_line_contains_single_line_comment(&result) {
842844
result.push_str(&format!("{sep}{{{sep}}}"));
843845
} else {
844846
result.push_str(" {}");

‎src/lib.rs

-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
#![warn(unreachable_pub)]
44
#![recursion_limit = "256"]
55
#![allow(clippy::match_like_matches_macro)]
6-
#![allow(unreachable_pub)]
76

87
#[cfg(test)]
98
#[macro_use]

‎src/matches.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -451,8 +451,8 @@ fn rewrite_match_body(
451451
};
452452

453453
let block_sep = match context.config.control_brace_style() {
454-
ControlBraceStyle::AlwaysNextLine => format!("{}{}", alt_block_sep, body_prefix),
455454
_ if body_prefix.is_empty() => "".to_owned(),
455+
ControlBraceStyle::AlwaysNextLine => format!("{}{}", alt_block_sep, body_prefix),
456456
_ if forbid_same_line || !arrow_comment.is_empty() => {
457457
format!("{}{}", alt_block_sep, body_prefix)
458458
}

‎tests/rustfmt/main.rs

+16
Original file line numberDiff line numberDiff line change
@@ -184,3 +184,19 @@ fn dont_emit_ICE() {
184184
assert!(!stderr.contains("thread 'main' panicked"));
185185
}
186186
}
187+
188+
#[test]
189+
fn rustfmt_emits_error_when_control_brace_style_is_always_next_line() {
190+
// See also https://github.com/rust-lang/rustfmt/issues/5912
191+
let args = [
192+
"--config=color=Never",
193+
"--config",
194+
"control_brace_style=AlwaysNextLine",
195+
"--config",
196+
"match_arm_blocks=false",
197+
"tests/target/issue_5912.rs",
198+
];
199+
200+
let (_stdout, stderr) = rustfmt(&args);
201+
assert!(!stderr.contains("error[internal]: left behind trailing whitespace"))
202+
}

‎tests/source/issue_5912.rs

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// rustfmt-match_arm_blocks: false
2+
// rustfmt-control_brace_style: AlwaysNextLine
3+
4+
fn foo() {
5+
match 0 {
6+
0 => {
7+
aaaaaaaaaaaaaaaaaaaaaaaa
8+
+ bbbbbbbbbbbbbbbbbbbbbbbbb
9+
+ bbbbbbbbbbbbbbbbbbbbbbbbb
10+
+ bbbbbbbbbbbbbbbbbbbbbbbbb
11+
+ bbbbbbbbbbbbbbbbbbbbbbbbb
12+
}
13+
_ => 2,
14+
}
15+
}

‎tests/target/impl.rs

+5
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ where
3232
{
3333
}
3434

35+
// #5941
36+
impl T where (): Clone // Should not add comma to comment
37+
{
38+
}
39+
3540
// #1823
3641
default impl Trait for X {}
3742
default unsafe impl Trait for Y {}

‎tests/target/issue_5912.rs

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// rustfmt-match_arm_blocks: false
2+
// rustfmt-control_brace_style: AlwaysNextLine
3+
4+
fn foo() {
5+
match 0
6+
{
7+
0 =>
8+
aaaaaaaaaaaaaaaaaaaaaaaa
9+
+ bbbbbbbbbbbbbbbbbbbbbbbbb
10+
+ bbbbbbbbbbbbbbbbbbbbbbbbb
11+
+ bbbbbbbbbbbbbbbbbbbbbbbbb
12+
+ bbbbbbbbbbbbbbbbbbbbbbbbb,
13+
_ => 2,
14+
}
15+
}

0 commit comments

Comments
 (0)