Skip to content

Commit 6356fca

Browse files
IVIURRAYIVIURRAY
authored
Prevent enum variant attributes from wrapping one character early
Fixes 5801 when using `version=Two` Previously, doc comments would wrap one character less than the `comment_width` when using `wrap_comments=true`, and fn-like attributes would wrap one character before the `attr_fn_like_width`. Now, when using `version=Two` enum variant attributes won't wrap early
1 parent 75e3172 commit 6356fca

9 files changed

+99
-3
lines changed

‎src/items.rs

+10-3
Original file line numberDiff line numberDiff line change
@@ -656,9 +656,16 @@ impl<'a> FmtVisitor<'a> {
656656
}
657657

658658
let context = self.get_context();
659-
// 1 = ','
660-
let shape = self.shape().sub_width(1)?;
661-
let attrs_str = field.attrs.rewrite(&context, shape)?;
659+
let shape = self.shape();
660+
let attrs_str = if context.config.version() == Version::Two {
661+
field.attrs.rewrite(&context, shape)?
662+
} else {
663+
// Version::One formatting that was off by 1. See issue #5801
664+
field.attrs.rewrite(&context, shape.sub_width(1)?)?
665+
};
666+
// sub_width(1) to take the trailing comma into account
667+
let shape = shape.sub_width(1)?;
668+
662669
let lo = field
663670
.attrs
664671
.last()

‎tests/config/issue-5801-v1.toml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
max_width = 120
2+
version = "One"
3+
attr_fn_like_width = 120

‎tests/config/issue-5801-v2.toml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
max_width = 120
2+
version = "Two"
3+
attr_fn_like_width = 120

‎tests/source/issue-5801/attribute_unexpectedly_wraps_before_max_width.rs

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// rustfmt-config: issue-5801-v1.toml
2+
3+
pub enum Severity {
4+
#[something(AAAAAAAAAAAAA, BBBBBBBBBBBBBB, CCCCCCCCCCCCCCCC, DDDDDDDDDDDDD, EEEEEEEEEEEE, FFFFFFFFFFF, GGGGGGGGGGG)]
5+
AttrsWillWrap,
6+
#[something_else(hhhhhhhhhhhhhhhh, iiiiiiiiiiiiiiii, jjjjjjjjjjjjjjj, kkkkkkkkkkkkk, llllllllllll, mmmmmmmmmmmmmm)]
7+
AttrsWontWrap,
8+
}

‎tests/source/issue-5801/comment_unexpectedly_wraps_before_max_width.rs

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// rustfmt-comment_width: 120
2+
// rustfmt-wrap_comments: true
3+
// rustfmt-max_width: 120
4+
// rustfmt-version: One
5+
6+
/// This function is 120 columns wide and is left alone. This comment is 120 columns wide and the formatter is also fine
7+
fn my_super_cool_function_name(my_very_cool_argument_name: String, my_other_very_cool_argument_name: String) -> String {
8+
unimplemented!()
9+
}
10+
11+
pub enum Severity {
12+
/// In version one, the below line got wrapped prematurely as we subtracted 1 to account for `,`. See issue #5801.
13+
/// But here, this comment is 120 columns wide and the formatter wants to split it up onto two separate lines still.
14+
Error,
15+
/// This comment is 119 columns wide and works perfectly. Lorem ipsum. lorem ipsum. lorem ipsum. lorem ipsum lorem.
16+
Warning,
17+
}

‎tests/target/issue-5801/attribute_does_not_wrap_within_max_width.rs

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// rustfmt-config: issue-5801-v2.toml
2+
3+
pub enum Severity {
4+
#[something(AAAAAAAAAAAAA, BBBBBBBBBBBBBB, CCCCCCCCCCCCCCCC, DDDDDDDDDDDDD, EEEEEEEEEEEE, FFFFFFFFFFF, GGGGGGGGGGG)]
5+
AttrsWillWrap,
6+
#[something_else(hhhhhhhhhhhhhhhh, iiiiiiiiiiiiiiii, jjjjjjjjjjjjjjj, kkkkkkkkkkkkk, llllllllllll, mmmmmmmmmmmmmm)]
7+
AttrsWontWrap,
8+
}

‎tests/target/issue-5801/attribute_unexpectedly_wraps_before_max_width.rs

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// rustfmt-config: issue-5801-v1.toml
2+
3+
pub enum Severity {
4+
#[something(
5+
AAAAAAAAAAAAA,
6+
BBBBBBBBBBBBBB,
7+
CCCCCCCCCCCCCCCC,
8+
DDDDDDDDDDDDD,
9+
EEEEEEEEEEEE,
10+
FFFFFFFFFFF,
11+
GGGGGGGGGGG
12+
)]
13+
AttrsWillWrap,
14+
#[something_else(hhhhhhhhhhhhhhhh, iiiiiiiiiiiiiiii, jjjjjjjjjjjjjjj, kkkkkkkkkkkkk, llllllllllll, mmmmmmmmmmmmmm)]
15+
AttrsWontWrap,
16+
}

‎tests/target/issue-5801/comment_does_not_wrap_within_max_width.rs

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// rustfmt-comment_width: 120
2+
// rustfmt-wrap_comments: true
3+
// rustfmt-max_width: 120
4+
// rustfmt-version: Two
5+
6+
/// This function is 120 columns wide and is left alone. This comment is 120 columns wide and the formatter is also fine
7+
fn my_super_cool_function_name(my_very_cool_argument_name: String, my_other_very_cool_argument_name: String) -> String {
8+
unimplemented!()
9+
}
10+
11+
pub enum Severity {
12+
/// But here, this comment is 120 columns wide and the formatter wants to split it up onto two separate lines still.
13+
Error,
14+
/// This comment is 119 columns wide and works perfectly. Lorem ipsum. lorem ipsum. lorem ipsum. lorem ipsum lorem.
15+
Warning,
16+
}

‎tests/target/issue-5801/comment_unexpectedly_wraps_before_max_width.rs

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// rustfmt-comment_width: 120
2+
// rustfmt-wrap_comments: true
3+
// rustfmt-max_width: 120
4+
// rustfmt-version: One
5+
6+
/// This function is 120 columns wide and is left alone. This comment is 120 columns wide and the formatter is also fine
7+
fn my_super_cool_function_name(my_very_cool_argument_name: String, my_other_very_cool_argument_name: String) -> String {
8+
unimplemented!()
9+
}
10+
11+
pub enum Severity {
12+
/// In version one, the below line got wrapped prematurely as we subtracted 1 to account for `,`. See issue #5801.
13+
/// But here, this comment is 120 columns wide and the formatter wants to split it up onto two separate lines
14+
/// still.
15+
Error,
16+
/// This comment is 119 columns wide and works perfectly. Lorem ipsum. lorem ipsum. lorem ipsum. lorem ipsum lorem.
17+
Warning,
18+
}

0 commit comments

Comments
 (0)