Skip to content

Commit 0430782

Browse files
workingjubileeworkingjubilee
authored
Rollup merge of #118872 - GuillaumeGomez:codeblock-attr-lint, r=notriddle
Add rustX check to codeblock attributes lint We discovered this issue [here](#118802 (comment)). I assume that the issue will be present in other places outside of the compiler so it's worth adding a check for it. First commit is just a small cleanup about variables creation which was a bit strange (at least more than necessary). r? ```@notriddle```
2 parents a33f1a3 + 58327c1 commit 0430782

File tree

5 files changed

+168
-70
lines changed

5 files changed

+168
-70
lines changed

‎src/librustdoc/html/markdown.rs

+56-43
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
//! ```
2828
2929
use rustc_data_structures::fx::FxHashMap;
30-
use rustc_errors::{DiagnosticMessage, SubdiagnosticMessage};
30+
use rustc_errors::{DiagnosticBuilder, DiagnosticMessage};
3131
use rustc_hir::def_id::DefId;
3232
use rustc_middle::ty::TyCtxt;
3333
pub(crate) use rustc_resolve::rustdoc::main_body_opts;
@@ -234,10 +234,6 @@ impl<'a, I: Iterator<Item = Event<'a>>> Iterator for CodeBlocks<'_, 'a, I> {
234234

235235
fn next(&mut self) -> Option<Self::Item> {
236236
let event = self.inner.next();
237-
let compile_fail;
238-
let should_panic;
239-
let ignore;
240-
let edition;
241237
let Some(Event::Start(Tag::CodeBlock(kind))) = event else {
242238
return event;
243239
};
@@ -253,49 +249,44 @@ impl<'a, I: Iterator<Item = Event<'a>>> Iterator for CodeBlocks<'_, 'a, I> {
253249
}
254250
}
255251

256-
let parse_result = match kind {
257-
CodeBlockKind::Fenced(ref lang) => {
258-
let parse_result = LangString::parse_without_check(
259-
lang,
260-
self.check_error_codes,
261-
false,
262-
self.custom_code_classes_in_docs,
263-
);
264-
if !parse_result.rust {
265-
let added_classes = parse_result.added_classes;
266-
let lang_string = if let Some(lang) = parse_result.unknown.first() {
267-
format!("language-{}", lang)
268-
} else {
269-
String::new()
270-
};
271-
let whitespace = if added_classes.is_empty() { "" } else { " " };
272-
return Some(Event::Html(
273-
format!(
274-
"<div class=\"example-wrap\">\
252+
let LangString { added_classes, compile_fail, should_panic, ignore, edition, .. } =
253+
match kind {
254+
CodeBlockKind::Fenced(ref lang) => {
255+
let parse_result = LangString::parse_without_check(
256+
lang,
257+
self.check_error_codes,
258+
false,
259+
self.custom_code_classes_in_docs,
260+
);
261+
if !parse_result.rust {
262+
let added_classes = parse_result.added_classes;
263+
let lang_string = if let Some(lang) = parse_result.unknown.first() {
264+
format!("language-{}", lang)
265+
} else {
266+
String::new()
267+
};
268+
let whitespace = if added_classes.is_empty() { "" } else { " " };
269+
return Some(Event::Html(
270+
format!(
271+
"<div class=\"example-wrap\">\
275272
<pre class=\"{lang_string}{whitespace}{added_classes}\">\
276273
<code>{text}</code>\
277274
</pre>\
278275
</div>",
279-
added_classes = added_classes.join(" "),
280-
text = Escape(&original_text),
281-
)
282-
.into(),
283-
));
276+
added_classes = added_classes.join(" "),
277+
text = Escape(&original_text),
278+
)
279+
.into(),
280+
));
281+
}
282+
parse_result
284283
}
285-
parse_result
286-
}
287-
CodeBlockKind::Indented => Default::default(),
288-
};
284+
CodeBlockKind::Indented => Default::default(),
285+
};
289286

290-
let added_classes = parse_result.added_classes;
291287
let lines = original_text.lines().filter_map(|l| map_line(l).for_html());
292288
let text = lines.intersperse("\n".into()).collect::<String>();
293289

294-
compile_fail = parse_result.compile_fail;
295-
should_panic = parse_result.should_panic;
296-
ignore = parse_result.ignore;
297-
edition = parse_result.edition;
298-
299290
let explicit_edition = edition.is_some();
300291
let edition = edition.unwrap_or(self.edition);
301292

@@ -852,15 +843,17 @@ impl<'tcx> ExtraInfo<'tcx> {
852843
fn error_invalid_codeblock_attr_with_help(
853844
&self,
854845
msg: impl Into<DiagnosticMessage>,
855-
help: impl Into<SubdiagnosticMessage>,
846+
f: impl for<'a, 'b> FnOnce(
847+
&'b mut DiagnosticBuilder<'a, ()>,
848+
) -> &'b mut DiagnosticBuilder<'a, ()>,
856849
) {
857850
if let Some(def_id) = self.def_id.as_local() {
858851
self.tcx.struct_span_lint_hir(
859852
crate::lint::INVALID_CODEBLOCK_ATTRIBUTES,
860853
self.tcx.local_def_id_to_hir_id(def_id),
861854
self.sp,
862855
msg,
863-
|lint| lint.help(help),
856+
f,
864857
);
865858
}
866859
}
@@ -1293,6 +1286,21 @@ impl LangString {
12931286
LangStringToken::LangToken(x) if x.starts_with("edition") => {
12941287
data.edition = x[7..].parse::<Edition>().ok();
12951288
}
1289+
LangStringToken::LangToken(x)
1290+
if x.starts_with("rust") && x[4..].parse::<Edition>().is_ok() =>
1291+
{
1292+
if let Some(extra) = extra {
1293+
extra.error_invalid_codeblock_attr_with_help(
1294+
format!("unknown attribute `{x}`"),
1295+
|lint| {
1296+
lint.help(format!(
1297+
"there is an attribute with a similar name: `edition{}`",
1298+
&x[4..],
1299+
))
1300+
},
1301+
);
1302+
}
1303+
}
12961304
LangStringToken::LangToken(x)
12971305
if allow_error_code_check && x.starts_with('E') && x.len() == 5 =>
12981306
{
@@ -1337,8 +1345,13 @@ impl LangString {
13371345
} {
13381346
if let Some(extra) = extra {
13391347
extra.error_invalid_codeblock_attr_with_help(
1340-
format!("unknown attribute `{x}`. Did you mean `{flag}`?"),
1341-
help,
1348+
format!("unknown attribute `{x}`"),
1349+
|lint| {
1350+
lint.help(format!(
1351+
"there is an attribute with a similar name: `{flag}`"
1352+
))
1353+
.help(help)
1354+
},
13421355
);
13431356
}
13441357
}

‎tests/rustdoc-ui/doctest/check-attr-test.stderr

+24-12
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
error: unknown attribute `compile-fail`. Did you mean `compile_fail`?
1+
error: unknown attribute `compile-fail`
22
--> $DIR/check-attr-test.rs:5:1
33
|
44
5 | / /// foo
@@ -8,14 +8,15 @@ error: unknown attribute `compile-fail`. Did you mean `compile_fail`?
88
9 | | /// ```
99
| |_______^
1010
|
11+
= help: there is an attribute with a similar name: `compile_fail`
1112
= help: the code block will either not be tested if not marked as a rust one or won't fail if it compiles successfully
1213
note: the lint level is defined here
1314
--> $DIR/check-attr-test.rs:3:9
1415
|
1516
3 | #![deny(rustdoc::invalid_codeblock_attributes)]
1617
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1718

18-
error: unknown attribute `compilefail`. Did you mean `compile_fail`?
19+
error: unknown attribute `compilefail`
1920
--> $DIR/check-attr-test.rs:5:1
2021
|
2122
5 | / /// foo
@@ -25,9 +26,10 @@ error: unknown attribute `compilefail`. Did you mean `compile_fail`?
2526
9 | | /// ```
2627
| |_______^
2728
|
29+
= help: there is an attribute with a similar name: `compile_fail`
2830
= help: the code block will either not be tested if not marked as a rust one or won't fail if it compiles successfully
2931

30-
error: unknown attribute `comPile_fail`. Did you mean `compile_fail`?
32+
error: unknown attribute `comPile_fail`
3133
--> $DIR/check-attr-test.rs:5:1
3234
|
3335
5 | / /// foo
@@ -37,9 +39,10 @@ error: unknown attribute `comPile_fail`. Did you mean `compile_fail`?
3739
9 | | /// ```
3840
| |_______^
3941
|
42+
= help: there is an attribute with a similar name: `compile_fail`
4043
= help: the code block will either not be tested if not marked as a rust one or won't fail if it compiles successfully
4144

42-
error: unknown attribute `should-panic`. Did you mean `should_panic`?
45+
error: unknown attribute `should-panic`
4346
--> $DIR/check-attr-test.rs:12:1
4447
|
4548
12 | / /// bar
@@ -49,9 +52,10 @@ error: unknown attribute `should-panic`. Did you mean `should_panic`?
4952
16 | | /// ```
5053
| |_______^
5154
|
55+
= help: there is an attribute with a similar name: `should_panic`
5256
= help: the code block will either not be tested if not marked as a rust one or won't fail if it doesn't panic when running
5357

54-
error: unknown attribute `shouldpanic`. Did you mean `should_panic`?
58+
error: unknown attribute `shouldpanic`
5559
--> $DIR/check-attr-test.rs:12:1
5660
|
5761
12 | / /// bar
@@ -61,9 +65,10 @@ error: unknown attribute `shouldpanic`. Did you mean `should_panic`?
6165
16 | | /// ```
6266
| |_______^
6367
|
68+
= help: there is an attribute with a similar name: `should_panic`
6469
= help: the code block will either not be tested if not marked as a rust one or won't fail if it doesn't panic when running
6570

66-
error: unknown attribute `shOuld_panic`. Did you mean `should_panic`?
71+
error: unknown attribute `shOuld_panic`
6772
--> $DIR/check-attr-test.rs:12:1
6873
|
6974
12 | / /// bar
@@ -73,9 +78,10 @@ error: unknown attribute `shOuld_panic`. Did you mean `should_panic`?
7378
16 | | /// ```
7479
| |_______^
7580
|
81+
= help: there is an attribute with a similar name: `should_panic`
7682
= help: the code block will either not be tested if not marked as a rust one or won't fail if it doesn't panic when running
7783

78-
error: unknown attribute `no-run`. Did you mean `no_run`?
84+
error: unknown attribute `no-run`
7985
--> $DIR/check-attr-test.rs:19:1
8086
|
8187
19 | / /// foobar
@@ -85,9 +91,10 @@ error: unknown attribute `no-run`. Did you mean `no_run`?
8591
23 | | /// ```
8692
| |_______^
8793
|
94+
= help: there is an attribute with a similar name: `no_run`
8895
= help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)
8996

90-
error: unknown attribute `norun`. Did you mean `no_run`?
97+
error: unknown attribute `norun`
9198
--> $DIR/check-attr-test.rs:19:1
9299
|
93100
19 | / /// foobar
@@ -97,9 +104,10 @@ error: unknown attribute `norun`. Did you mean `no_run`?
97104
23 | | /// ```
98105
| |_______^
99106
|
107+
= help: there is an attribute with a similar name: `no_run`
100108
= help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)
101109

102-
error: unknown attribute `nO_run`. Did you mean `no_run`?
110+
error: unknown attribute `nO_run`
103111
--> $DIR/check-attr-test.rs:19:1
104112
|
105113
19 | / /// foobar
@@ -109,9 +117,10 @@ error: unknown attribute `nO_run`. Did you mean `no_run`?
109117
23 | | /// ```
110118
| |_______^
111119
|
120+
= help: there is an attribute with a similar name: `no_run`
112121
= help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)
113122

114-
error: unknown attribute `test-harness`. Did you mean `test_harness`?
123+
error: unknown attribute `test-harness`
115124
--> $DIR/check-attr-test.rs:26:1
116125
|
117126
26 | / /// b
@@ -121,9 +130,10 @@ error: unknown attribute `test-harness`. Did you mean `test_harness`?
121130
30 | | /// ```
122131
| |_______^
123132
|
133+
= help: there is an attribute with a similar name: `test_harness`
124134
= help: the code block will either not be tested if not marked as a rust one or the code will be wrapped inside a main function
125135

126-
error: unknown attribute `testharness`. Did you mean `test_harness`?
136+
error: unknown attribute `testharness`
127137
--> $DIR/check-attr-test.rs:26:1
128138
|
129139
26 | / /// b
@@ -133,9 +143,10 @@ error: unknown attribute `testharness`. Did you mean `test_harness`?
133143
30 | | /// ```
134144
| |_______^
135145
|
146+
= help: there is an attribute with a similar name: `test_harness`
136147
= help: the code block will either not be tested if not marked as a rust one or the code will be wrapped inside a main function
137148

138-
error: unknown attribute `tesT_harness`. Did you mean `test_harness`?
149+
error: unknown attribute `tesT_harness`
139150
--> $DIR/check-attr-test.rs:26:1
140151
|
141152
26 | / /// b
@@ -145,6 +156,7 @@ error: unknown attribute `tesT_harness`. Did you mean `test_harness`?
145156
30 | | /// ```
146157
| |_______^
147158
|
159+
= help: there is an attribute with a similar name: `test_harness`
148160
= help: the code block will either not be tested if not marked as a rust one or the code will be wrapped inside a main function
149161

150162
error: aborting due to 12 previous errors

‎tests/rustdoc-ui/lints/check-attr.rs

+17
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,20 @@ pub fn foobar() {}
3939
/// boo
4040
/// ```
4141
pub fn b() {}
42+
43+
/// b
44+
//~^ ERROR
45+
///
46+
/// ```rust2018
47+
/// boo
48+
/// ```
49+
pub fn c() {}
50+
51+
/// b
52+
//~^ ERROR
53+
//~| ERROR
54+
///
55+
/// ```rust2018 shouldpanic
56+
/// boo
57+
/// ```
58+
pub fn d() {}

0 commit comments

Comments
 (0)