Skip to content

Commit 6cc513f

Browse files
ytmimiytmimi
committed
Merge remote-tracking branch 'origin/master' into subtree_sync_with_1.77.0_nightly_2023_12_27
2 parents fd78575 + d86fc1b commit 6cc513f

21 files changed

+286
-36
lines changed

‎Configurations.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -1098,7 +1098,7 @@ See also [`format_macro_bodies`](#format_macro_bodies).
10981098

10991099
## `format_macro_bodies`
11001100

1101-
Format the bodies of macros.
1101+
Format the bodies of declarative macro definitions.
11021102

11031103
- **Default value**: `true`
11041104
- **Possible values**: `true`, `false`
@@ -1248,12 +1248,20 @@ Control the case of the letters in hexadecimal literal values
12481248

12491249
## `hide_parse_errors`
12501250

1251-
Do not show parse errors if the parser failed to parse files.
1251+
This option is deprecated and has been renamed to `show_parse_errors` to avoid confusion around the double negative default of `hide_parse_errors=false`.
12521252

12531253
- **Default value**: `false`
12541254
- **Possible values**: `true`, `false`
12551255
- **Stable**: No (tracking issue: [#3390](https://github.com/rust-lang/rustfmt/issues/3390))
12561256

1257+
## `show_parse_errors`
1258+
1259+
Show parse errors if the parser failed to parse files.
1260+
1261+
- **Default value**: `true`
1262+
- **Possible values**: `true`, `false`
1263+
- **Stable**: No (tracking issue: [#5977](https://github.com/rust-lang/rustfmt/issues/5977))
1264+
12571265
## `ignore`
12581266

12591267
Skip formatting files and directories that match the specified pattern.

‎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
}

‎rust-toolchain

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
[toolchain]
2-
channel = "nightly-2023-10-22"
2+
channel = "nightly-2023-12-12"
33
components = ["llvm-tools", "rustc-dev"]

‎src/comment.rs

+1-4
Original file line numberDiff line numberDiff line change
@@ -173,10 +173,7 @@ pub(crate) fn combine_strs_with_missing_comments(
173173
) -> Option<String> {
174174
trace!(
175175
"combine_strs_with_missing_comments `{}` `{}` {:?} {:?}",
176-
prev_str,
177-
next_str,
178-
span,
179-
shape
176+
prev_str, next_str, span, shape
180177
);
181178

182179
let mut result =

‎src/config/config_type.rs

+18-2
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,7 @@ macro_rules! create_config {
129129
| "chain_width" => self.0.set_heuristics(),
130130
"merge_imports" => self.0.set_merge_imports(),
131131
"fn_args_layout" => self.0.set_fn_args_layout(),
132+
"hide_parse_errors" => self.0.set_hide_parse_errors(),
132133
&_ => (),
133134
}
134135
}
@@ -184,6 +185,7 @@ macro_rules! create_config {
184185
self.set_ignore(dir);
185186
self.set_merge_imports();
186187
self.set_fn_args_layout();
188+
self.set_hide_parse_errors();
187189
self
188190
}
189191

@@ -278,19 +280,21 @@ macro_rules! create_config {
278280
| "chain_width" => self.set_heuristics(),
279281
"merge_imports" => self.set_merge_imports(),
280282
"fn_args_layout" => self.set_fn_args_layout(),
283+
"hide_parse_errors" => self.set_hide_parse_errors(),
281284
&_ => (),
282285
}
283286
}
284287

285288
#[allow(unreachable_pub)]
286289
pub fn is_hidden_option(name: &str) -> bool {
287-
const HIDE_OPTIONS: [&str; 6] = [
290+
const HIDE_OPTIONS: [&str; 7] = [
288291
"verbose",
289292
"verbose_diff",
290293
"file_lines",
291294
"width_heuristics",
292295
"merge_imports",
293-
"fn_args_layout"
296+
"fn_args_layout",
297+
"hide_parse_errors"
294298
];
295299
HIDE_OPTIONS.contains(&name)
296300
}
@@ -461,6 +465,18 @@ macro_rules! create_config {
461465
}
462466
}
463467

468+
fn set_hide_parse_errors(&mut self) {
469+
if self.was_set().hide_parse_errors() {
470+
eprintln!(
471+
"Warning: the `hide_parse_errors` option is deprecated. \
472+
Use `show_parse_errors` instead"
473+
);
474+
if !self.was_set().show_parse_errors() {
475+
self.show_parse_errors.2 = self.hide_parse_errors();
476+
}
477+
}
478+
}
479+
464480
#[allow(unreachable_pub)]
465481
/// Returns `true` if the config key was explicitly set and is the default value.
466482
pub fn is_default(&self, key: &str) -> bool {

‎src/config/mod.rs

+13-3
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:
@@ -73,7 +74,7 @@ create_config! {
7374
format_strings: bool, false, false, "Format string literals where necessary";
7475
format_macro_matchers: bool, false, false,
7576
"Format the metavariable matching patterns in macros";
76-
format_macro_bodies: bool, true, false, "Format the bodies of macros";
77+
format_macro_bodies: bool, true, false, "Format the bodies of declarative macro definitions";
7778
skip_macro_invocations: MacroSelectors, MacroSelectors::default(), false,
7879
"Skip formatting the bodies of macros invoked with the following names.";
7980
hex_literal_case: HexLiteralCase, HexLiteralCase::Preserve, false,
@@ -168,7 +169,8 @@ create_config! {
168169
"Enables unstable features. Only available on nightly channel";
169170
disable_all_formatting: bool, false, true, "Don't reformat anything";
170171
skip_children: bool, false, false, "Don't reformat out of line modules";
171-
hide_parse_errors: bool, false, false, "Hide errors from the parser";
172+
hide_parse_errors: bool, false, false, "(deprecated: use show_parse_errors instead)";
173+
show_parse_errors: bool, true, false, "Show errors from the parser (unstable)";
172174
error_on_line_overflow: bool, false, false, "Error if unable to get all lines within max_width";
173175
error_on_unformatted: bool, false, false,
174176
"Error if unable to get comments or string literals within max_width, \
@@ -203,6 +205,7 @@ impl PartialConfig {
203205
cloned.print_misformatted_file_names = None;
204206
cloned.merge_imports = None;
205207
cloned.fn_args_layout = None;
208+
cloned.hide_parse_errors = None;
206209

207210
::toml::to_string(&cloned).map_err(ToTomlError)
208211
}
@@ -455,6 +458,13 @@ mod test {
455458
fn_params_layout: Density, Density::Tall, true,
456459
"Control the layout of parameters in a function signatures.";
457460

461+
// hide_parse_errors renamed to show_parse_errors
462+
hide_parse_errors: bool, false, false,
463+
"(deprecated: use show_parse_errors instead)";
464+
show_parse_errors: bool, true, false,
465+
"Show errors from the parser (unstable)";
466+
467+
458468
// Width Heuristics
459469
use_small_heuristics: Heuristics, Heuristics::Default, true,
460470
"Whether to use different formatting for items and \
@@ -680,7 +690,7 @@ required_version = "{}"
680690
unstable_features = false
681691
disable_all_formatting = false
682692
skip_children = false
683-
hide_parse_errors = false
693+
show_parse_errors = true
684694
error_on_line_overflow = false
685695
error_on_unformatted = false
686696
ignore = []

‎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-2
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]
@@ -305,7 +304,7 @@ fn format_snippet(snippet: &str, config: &Config, is_macro_def: bool) -> Option<
305304
let mut out: Vec<u8> = Vec::with_capacity(snippet.len() * 2);
306305
config.set().emit_mode(config::EmitMode::Stdout);
307306
config.set().verbose(Verbosity::Quiet);
308-
config.set().hide_parse_errors(true);
307+
config.set().show_parse_errors(false);
309308
if is_macro_def {
310309
config.set().error_on_unformatted(true);
311310
}

‎src/macros.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1269,7 +1269,7 @@ impl MacroBranch {
12691269
let has_block_body = old_body.starts_with('{');
12701270

12711271
let mut config = context.config.clone();
1272-
config.set().hide_parse_errors(true);
1272+
config.set().show_parse_errors(false);
12731273

12741274
result += " {";
12751275

‎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
}

0 commit comments

Comments
 (0)