aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChayim Refael Friedman <[email protected]>2021-04-18 03:09:20 +0100
committerChayim Refael Friedman <[email protected]>2021-04-18 04:15:40 +0100
commit6c287e150433e848c97b89c7211a3464a5675634 (patch)
tree5b87c25afe703ad2a55abc8ffce7a76e860da7f5
parent19fc1f333f64e76784ced4ea185e62329d0defb6 (diff)
Accept `E<error_number>` notation in doctests
```compile_fail,E0000 ``` The code was stolen from rustdoc at https://github.com/rust-lang/rust/blob/392ba2ba1a7d6c542d2459fb8133bebf62a4a423/src/librustdoc/html/markdown.rs#L866-L867
-rw-r--r--crates/ide/src/syntax_highlighting/inject.rs10
-rw-r--r--crates/rust-analyzer/src/markdown.rs18
2 files changed, 23 insertions, 5 deletions
diff --git a/crates/ide/src/syntax_highlighting/inject.rs b/crates/ide/src/syntax_highlighting/inject.rs
index 04fafd244..855c7fba8 100644
--- a/crates/ide/src/syntax_highlighting/inject.rs
+++ b/crates/ide/src/syntax_highlighting/inject.rs
@@ -90,6 +90,13 @@ const RUSTDOC_FENCE_TOKENS: &[&'static str] = &[
90 "edition2021", 90 "edition2021",
91]; 91];
92 92
93fn is_rustdoc_fence_token(token: &str) -> bool {
94 if RUSTDOC_FENCE_TOKENS.contains(&token) {
95 return true;
96 }
97 token.starts_with('E') && token.len() == 5 && token[1..].parse::<u32>().is_ok()
98}
99
93/// Injection of syntax highlighting of doctests. 100/// Injection of syntax highlighting of doctests.
94pub(super) fn doc_comment( 101pub(super) fn doc_comment(
95 hl: &mut Highlights, 102 hl: &mut Highlights,
@@ -174,8 +181,7 @@ pub(super) fn doc_comment(
174 is_codeblock = !is_codeblock; 181 is_codeblock = !is_codeblock;
175 // Check whether code is rust by inspecting fence guards 182 // Check whether code is rust by inspecting fence guards
176 let guards = &line[idx + RUSTDOC_FENCE.len()..]; 183 let guards = &line[idx + RUSTDOC_FENCE.len()..];
177 let is_rust = 184 let is_rust = guards.split(',').all(|sub| is_rustdoc_fence_token(sub.trim()));
178 guards.split(',').all(|sub| RUSTDOC_FENCE_TOKENS.contains(&sub.trim()));
179 is_doctest = is_codeblock && is_rust; 185 is_doctest = is_codeblock && is_rust;
180 continue; 186 continue;
181 } 187 }
diff --git a/crates/rust-analyzer/src/markdown.rs b/crates/rust-analyzer/src/markdown.rs
index 865eaae9b..a51ff89e4 100644
--- a/crates/rust-analyzer/src/markdown.rs
+++ b/crates/rust-analyzer/src/markdown.rs
@@ -27,9 +27,8 @@ pub(crate) fn format_docs(src: &str) -> String {
27 in_code_block ^= true; 27 in_code_block ^= true;
28 28
29 if in_code_block { 29 if in_code_block {
30 is_rust = header 30 is_rust =
31 .split(',') 31 header.split(',').all(|sub| is_rust_specific_code_block_attribute(sub.trim()));
32 .all(|sub| RUSTDOC_CODE_BLOCK_ATTRIBUTES_RUST_SPECIFIC.contains(&sub.trim()));
33 32
34 if is_rust { 33 if is_rust {
35 line = "```rust"; 34 line = "```rust";
@@ -42,6 +41,13 @@ pub(crate) fn format_docs(src: &str) -> String {
42 processed_lines.join("\n") 41 processed_lines.join("\n")
43} 42}
44 43
44fn is_rust_specific_code_block_attribute(attr: &str) -> bool {
45 if RUSTDOC_CODE_BLOCK_ATTRIBUTES_RUST_SPECIFIC.contains(&attr) {
46 return true;
47 }
48 attr.starts_with('E') && attr.len() == 5 && attr[1..].parse::<u32>().is_ok()
49}
50
45fn code_line_ignored_by_rustdoc(line: &str) -> bool { 51fn code_line_ignored_by_rustdoc(line: &str) -> bool {
46 let trimmed = line.trim(); 52 let trimmed = line.trim();
47 trimmed == "#" || trimmed.starts_with("# ") || trimmed.starts_with("#\t") 53 trimmed == "#" || trimmed.starts_with("# ") || trimmed.starts_with("#\t")
@@ -82,6 +88,12 @@ mod tests {
82 } 88 }
83 89
84 #[test] 90 #[test]
91 fn test_format_docs_handles_error_codes() {
92 let comment = "```compile_fail,E0641\nlet b = 0 as *const _;\n```";
93 assert_eq!(format_docs(comment), "```rust\nlet b = 0 as *const _;\n```");
94 }
95
96 #[test]
85 fn test_format_docs_skips_comments_in_rust_block() { 97 fn test_format_docs_skips_comments_in_rust_block() {
86 let comment = 98 let comment =
87 "```rust\n # skip1\n# skip2\n#stay1\nstay2\n#\n #\n # \n #\tskip3\n\t#\t\n```"; 99 "```rust\n # skip1\n# skip2\n#stay1\nstay2\n#\n #\n # \n #\tskip3\n\t#\t\n```";