Skip to content

Commit 2c04c1a

Browse files
kraktuskraktus
committed
[manual_assert]: Preserve comments in the suggestion
1 parent 5d837b5 commit 2c04c1a

File tree

7 files changed

+237
-51
lines changed

7 files changed

+237
-51
lines changed

‎clippy_lints/src/manual_assert.rs‎

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
use clippy_utils::diagnostics::span_lint_and_sugg;
1+
use crate::rustc_lint::LintContext;
2+
use clippy_utils::diagnostics::span_lint_and_then;
23
use clippy_utils::macros::{root_macro_call, FormatArgsExpn};
34
use clippy_utils::source::snippet_with_applicability;
4-
use clippy_utils::{peel_blocks_with_stmt, sugg};
5+
use clippy_utils::{peel_blocks_with_stmt, span_extract_comment, sugg};
56
use rustc_errors::Applicability;
6-
use rustc_hir::{Expr, ExprKind, UnOp};
7+
use rustc_hir::{Expr, ExprKind};
78
use rustc_lint::{LateContext, LateLintPass};
89
use rustc_session::{declare_lint_pass, declare_tool_lint};
910
use rustc_span::sym;
@@ -50,20 +51,33 @@ impl<'tcx> LateLintPass<'tcx> for ManualAssert {
5051
let mut applicability = Applicability::MachineApplicable;
5152
let format_args_snip = snippet_with_applicability(cx, format_args.inputs_span(), "..", &mut applicability);
5253
let cond = cond.peel_drop_temps();
53-
let (cond, not) = match cond.kind {
54-
ExprKind::Unary(UnOp::Not, e) => (e, ""),
55-
_ => (cond, "!"),
56-
};
57-
let cond_sugg = sugg::Sugg::hir_with_applicability(cx, cond, "..", &mut applicability).maybe_par();
58-
let sugg = format!("assert!({not}{cond_sugg}, {format_args_snip});");
59-
span_lint_and_sugg(
54+
let mut comments = span_extract_comment(cx.sess().source_map(), expr.span);
55+
if !comments.is_empty() {
56+
comments += "\n";
57+
}
58+
// we need to negate the <cond> expression because `assert!` panics when <cond> is `false`, wherease original pattern panicked when evaluating to `true`
59+
let cond_sugg = !sugg::Sugg::hir_with_applicability(cx, cond, "..", &mut applicability);
60+
let sugg = format!("assert!({cond_sugg}, {format_args_snip});");
61+
// we show to the user the suggestion without the comments, but when applicating the fix, include the comments in the block
62+
span_lint_and_then(
6063
cx,
6164
MANUAL_ASSERT,
6265
expr.span,
6366
"only a `panic!` in `if`-then statement",
64-
"try",
65-
sugg,
66-
Applicability::MachineApplicable,
67+
|diag| {
68+
// comments can be noisy, do not show them to the user
69+
diag.tool_only_span_suggestion(
70+
expr.span.shrink_to_lo(),
71+
"add comments back",
72+
comments,
73+
applicability);
74+
diag.span_suggestion(
75+
expr.span,
76+
"try instead",
77+
sugg,
78+
applicability);
79+
}
80+
6781
);
6882
}
6983
}

‎clippy_utils/src/lib.rs‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2295,6 +2295,29 @@ pub fn span_contains_comment(sm: &SourceMap, span: Span) -> bool {
22952295
});
22962296
}
22972297

2298+
/// Return all the comments a given span contains
2299+
/// Comments are returned wrapped with their relevant delimiters
2300+
pub fn span_extract_comment(sm: &SourceMap, span: Span) -> String {
2301+
let snippet = sm.span_to_snippet(span).unwrap_or_default();
2302+
let mut comments_buf: Vec<String> = Vec::new();
2303+
let mut index: usize = 0;
2304+
2305+
for token in tokenize(&snippet) {
2306+
let token_range = index..(index + token.len as usize);
2307+
index += token.len as usize;
2308+
match token.kind {
2309+
TokenKind::BlockComment { .. } | TokenKind::LineComment { .. } => {
2310+
if let Some(comment) = snippet.get(token_range) {
2311+
comments_buf.push(comment.to_string());
2312+
}
2313+
},
2314+
_ => (),
2315+
}
2316+
}
2317+
2318+
comments_buf.join("\n")
2319+
}
2320+
22982321
macro_rules! op_utils {
22992322
($($name:ident $assign:ident)*) => {
23002323
/// Binary operation traits like `LangItem::Add`

‎tests/ui/manual_assert.edition2018.fixed‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
#![warn(clippy::manual_assert)]
77
#![allow(clippy::nonminimal_bool)]
8+
#![allow(dead_code)]
89

910
macro_rules! one {
1011
() => {
@@ -27,8 +28,8 @@ fn main() {
2728
{
2829
panic!("qaqaq{:?}", a);
2930
}
30-
assert!(a.is_empty(), "qaqaq{:?}", a);
31-
assert!(a.is_empty(), "qwqwq");
31+
assert!(!(!a.is_empty()), "qaqaq{:?}", a);
32+
assert!(!(!a.is_empty()), "qwqwq");
3233
if a.len() == 3 {
3334
println!("qwq");
3435
println!("qwq");
@@ -50,3 +51,14 @@ fn main() {
5051
assert!(!(a.is_empty() || !b.is_empty()), "panic5");
5152
assert!(!a.is_empty(), "with expansion {}", one!());
5253
}
54+
55+
fn issue7730() {
56+
// Suggestion should preserve comment
57+
// comment
58+
/* this is a
59+
multiline
60+
comment */
61+
/// Doc comment
62+
// comment after `panic!`
63+
assert!(!true, "panic with comment");
64+
}

‎tests/ui/manual_assert.edition2018.stderr‎

Lines changed: 73 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,124 @@
11
error: only a `panic!` in `if`-then statement
2-
--> $DIR/manual_assert.rs:30:5
2+
--> $DIR/manual_assert.rs:31:5
33
|
44
LL | / if !a.is_empty() {
55
LL | | panic!("qaqaq{:?}", a);
66
LL | | }
7-
| |_____^ help: try: `assert!(a.is_empty(), "qaqaq{:?}", a);`
7+
| |_____^
88
|
99
= note: `-D clippy::manual-assert` implied by `-D warnings`
10+
help: try instead
11+
|
12+
LL | assert!(!(!a.is_empty()), "qaqaq{:?}", a);
13+
|
1014

1115
error: only a `panic!` in `if`-then statement
12-
--> $DIR/manual_assert.rs:33:5
16+
--> $DIR/manual_assert.rs:34:5
1317
|
1418
LL | / if !a.is_empty() {
1519
LL | | panic!("qwqwq");
1620
LL | | }
17-
| |_____^ help: try: `assert!(a.is_empty(), "qwqwq");`
21+
| |_____^
22+
|
23+
help: try instead
24+
|
25+
LL | assert!(!(!a.is_empty()), "qwqwq");
26+
|
1827

1928
error: only a `panic!` in `if`-then statement
20-
--> $DIR/manual_assert.rs:50:5
29+
--> $DIR/manual_assert.rs:51:5
2130
|
2231
LL | / if b.is_empty() {
2332
LL | | panic!("panic1");
2433
LL | | }
25-
| |_____^ help: try: `assert!(!b.is_empty(), "panic1");`
34+
| |_____^
35+
|
36+
help: try instead
37+
|
38+
LL | assert!(!b.is_empty(), "panic1");
39+
|
2640

2741
error: only a `panic!` in `if`-then statement
28-
--> $DIR/manual_assert.rs:53:5
42+
--> $DIR/manual_assert.rs:54:5
2943
|
3044
LL | / if b.is_empty() && a.is_empty() {
3145
LL | | panic!("panic2");
3246
LL | | }
33-
| |_____^ help: try: `assert!(!(b.is_empty() && a.is_empty()), "panic2");`
47+
| |_____^
48+
|
49+
help: try instead
50+
|
51+
LL | assert!(!(b.is_empty() && a.is_empty()), "panic2");
52+
|
3453

3554
error: only a `panic!` in `if`-then statement
36-
--> $DIR/manual_assert.rs:56:5
55+
--> $DIR/manual_assert.rs:57:5
3756
|
3857
LL | / if a.is_empty() && !b.is_empty() {
3958
LL | | panic!("panic3");
4059
LL | | }
41-
| |_____^ help: try: `assert!(!(a.is_empty() && !b.is_empty()), "panic3");`
60+
| |_____^
61+
|
62+
help: try instead
63+
|
64+
LL | assert!(!(a.is_empty() && !b.is_empty()), "panic3");
65+
|
4266

4367
error: only a `panic!` in `if`-then statement
44-
--> $DIR/manual_assert.rs:59:5
68+
--> $DIR/manual_assert.rs:60:5
4569
|
4670
LL | / if b.is_empty() || a.is_empty() {
4771
LL | | panic!("panic4");
4872
LL | | }
49-
| |_____^ help: try: `assert!(!(b.is_empty() || a.is_empty()), "panic4");`
73+
| |_____^
74+
|
75+
help: try instead
76+
|
77+
LL | assert!(!(b.is_empty() || a.is_empty()), "panic4");
78+
|
5079

5180
error: only a `panic!` in `if`-then statement
52-
--> $DIR/manual_assert.rs:62:5
81+
--> $DIR/manual_assert.rs:63:5
5382
|
5483
LL | / if a.is_empty() || !b.is_empty() {
5584
LL | | panic!("panic5");
5685
LL | | }
57-
| |_____^ help: try: `assert!(!(a.is_empty() || !b.is_empty()), "panic5");`
86+
| |_____^
87+
|
88+
help: try instead
89+
|
90+
LL | assert!(!(a.is_empty() || !b.is_empty()), "panic5");
91+
|
5892

5993
error: only a `panic!` in `if`-then statement
60-
--> $DIR/manual_assert.rs:65:5
94+
--> $DIR/manual_assert.rs:66:5
6195
|
6296
LL | / if a.is_empty() {
6397
LL | | panic!("with expansion {}", one!())
6498
LL | | }
65-
| |_____^ help: try: `assert!(!a.is_empty(), "with expansion {}", one!());`
99+
| |_____^
100+
|
101+
help: try instead
102+
|
103+
LL | assert!(!a.is_empty(), "with expansion {}", one!());
104+
|
105+
106+
error: only a `panic!` in `if`-then statement
107+
--> $DIR/manual_assert.rs:73:5
108+
|
109+
LL | / if true {
110+
LL | | // comment
111+
LL | | /* this is a
112+
LL | | multiline
113+
... |
114+
LL | | panic!("panic with comment") // comment after `panic!`
115+
LL | | }
116+
| |_____^
117+
|
118+
help: try instead
119+
|
120+
LL | assert!(!true, "panic with comment");
121+
|
66122

67-
error: aborting due to 8 previous errors
123+
error: aborting due to 9 previous errors
68124

‎tests/ui/manual_assert.edition2021.fixed‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
#![warn(clippy::manual_assert)]
77
#![allow(clippy::nonminimal_bool)]
8+
#![allow(dead_code)]
89

910
macro_rules! one {
1011
() => {
@@ -27,8 +28,8 @@ fn main() {
2728
{
2829
panic!("qaqaq{:?}", a);
2930
}
30-
assert!(a.is_empty(), "qaqaq{:?}", a);
31-
assert!(a.is_empty(), "qwqwq");
31+
assert!(!(!a.is_empty()), "qaqaq{:?}", a);
32+
assert!(!(!a.is_empty()), "qwqwq");
3233
if a.len() == 3 {
3334
println!("qwq");
3435
println!("qwq");
@@ -50,3 +51,14 @@ fn main() {
5051
assert!(!(a.is_empty() || !b.is_empty()), "panic5");
5152
assert!(!a.is_empty(), "with expansion {}", one!());
5253
}
54+
55+
fn issue7730() {
56+
// Suggestion should preserve comment
57+
// comment
58+
/* this is a
59+
multiline
60+
comment */
61+
/// Doc comment
62+
// comment after `panic!`
63+
assert!(!true, "panic with comment");
64+
}

0 commit comments

Comments
 (0)