diff options
Diffstat (limited to 'xtask/src/codegen')
-rw-r--r-- | xtask/src/codegen/gen_assists_docs.rs | 123 | ||||
-rw-r--r-- | xtask/src/codegen/gen_syntax.rs | 25 |
2 files changed, 126 insertions, 22 deletions
diff --git a/xtask/src/codegen/gen_assists_docs.rs b/xtask/src/codegen/gen_assists_docs.rs new file mode 100644 index 000000000..654ae09d6 --- /dev/null +++ b/xtask/src/codegen/gen_assists_docs.rs | |||
@@ -0,0 +1,123 @@ | |||
1 | use std::{fs, path::Path}; | ||
2 | |||
3 | use crate::{ | ||
4 | codegen::{self, extract_comment_blocks, Mode}, | ||
5 | project_root, Result, | ||
6 | }; | ||
7 | |||
8 | pub fn generate_assists_docs(mode: Mode) -> Result<()> { | ||
9 | let assists = collect_assists()?; | ||
10 | generate_tests(&assists, mode)?; | ||
11 | generate_docs(&assists, mode)?; | ||
12 | Ok(()) | ||
13 | } | ||
14 | |||
15 | #[derive(Debug)] | ||
16 | struct Assist { | ||
17 | id: String, | ||
18 | doc: String, | ||
19 | before: String, | ||
20 | after: String, | ||
21 | } | ||
22 | |||
23 | fn collect_assists() -> Result<Vec<Assist>> { | ||
24 | let mut res = Vec::new(); | ||
25 | for entry in fs::read_dir(project_root().join(codegen::ASSISTS_DIR))? { | ||
26 | let entry = entry?; | ||
27 | let path = entry.path(); | ||
28 | if path.is_file() { | ||
29 | collect_file(&mut res, path.as_path())?; | ||
30 | } | ||
31 | } | ||
32 | res.sort_by(|lhs, rhs| lhs.id.cmp(&rhs.id)); | ||
33 | return Ok(res); | ||
34 | |||
35 | fn collect_file(acc: &mut Vec<Assist>, path: &Path) -> Result<()> { | ||
36 | let text = fs::read_to_string(path)?; | ||
37 | let comment_blocks = extract_comment_blocks(&text); | ||
38 | |||
39 | for block in comment_blocks { | ||
40 | // FIXME: doesn't support blank lines yet, need to tweak | ||
41 | // `extract_comment_blocks` for that. | ||
42 | let mut lines = block.iter(); | ||
43 | let first_line = lines.next().unwrap(); | ||
44 | if !first_line.starts_with("Assist: ") { | ||
45 | continue; | ||
46 | } | ||
47 | let id = first_line["Assist: ".len()..].to_string(); | ||
48 | assert!(id.chars().all(|it| it.is_ascii_lowercase() || it == '_')); | ||
49 | |||
50 | let doc = take_until(lines.by_ref(), "```"); | ||
51 | let before = take_until(lines.by_ref(), "```"); | ||
52 | |||
53 | assert_eq!(lines.next().unwrap().as_str(), "->"); | ||
54 | assert_eq!(lines.next().unwrap().as_str(), "```"); | ||
55 | let after = take_until(lines.by_ref(), "```"); | ||
56 | acc.push(Assist { id, doc, before, after }) | ||
57 | } | ||
58 | |||
59 | fn take_until<'a>(lines: impl Iterator<Item = &'a String>, marker: &str) -> String { | ||
60 | let mut buf = Vec::new(); | ||
61 | for line in lines { | ||
62 | if line == marker { | ||
63 | break; | ||
64 | } | ||
65 | buf.push(line.clone()); | ||
66 | } | ||
67 | buf.join("\n") | ||
68 | } | ||
69 | Ok(()) | ||
70 | } | ||
71 | } | ||
72 | |||
73 | fn generate_tests(assists: &[Assist], mode: Mode) -> Result<()> { | ||
74 | let mut buf = String::from("use super::check;\n"); | ||
75 | |||
76 | for assist in assists.iter() { | ||
77 | let test = format!( | ||
78 | r######" | ||
79 | #[test] | ||
80 | fn doctest_{}() {{ | ||
81 | check( | ||
82 | "{}", | ||
83 | r#####" | ||
84 | {} | ||
85 | "#####, r#####" | ||
86 | {} | ||
87 | "#####) | ||
88 | }} | ||
89 | "######, | ||
90 | assist.id, assist.id, assist.before, assist.after | ||
91 | ); | ||
92 | |||
93 | buf.push_str(&test) | ||
94 | } | ||
95 | let buf = codegen::reformat(buf)?; | ||
96 | codegen::update(&project_root().join(codegen::ASSISTS_TESTS), &buf, mode) | ||
97 | } | ||
98 | |||
99 | fn generate_docs(assists: &[Assist], mode: Mode) -> Result<()> { | ||
100 | let mut buf = String::from("# Assists\n"); | ||
101 | |||
102 | for assist in assists { | ||
103 | let docs = format!( | ||
104 | " | ||
105 | ## `{}` | ||
106 | |||
107 | {} | ||
108 | |||
109 | ```rust | ||
110 | // BEFORE | ||
111 | {} | ||
112 | |||
113 | // AFTER | ||
114 | {} | ||
115 | ``` | ||
116 | ", | ||
117 | assist.id, assist.doc, assist.before, assist.after | ||
118 | ); | ||
119 | buf.push_str(&docs); | ||
120 | } | ||
121 | |||
122 | codegen::update(&project_root().join(codegen::ASSISTS_DOCS), &buf, mode) | ||
123 | } | ||
diff --git a/xtask/src/codegen/gen_syntax.rs b/xtask/src/codegen/gen_syntax.rs index 6a81c0e4d..88f2ac0e3 100644 --- a/xtask/src/codegen/gen_syntax.rs +++ b/xtask/src/codegen/gen_syntax.rs | |||
@@ -3,12 +3,7 @@ | |||
3 | //! Specifically, it generates the `SyntaxKind` enum and a number of newtype | 3 | //! Specifically, it generates the `SyntaxKind` enum and a number of newtype |
4 | //! wrappers around `SyntaxNode` which implement `ra_syntax::AstNode`. | 4 | //! wrappers around `SyntaxNode` which implement `ra_syntax::AstNode`. |
5 | 5 | ||
6 | use std::{ | 6 | use std::{collections::BTreeMap, fs}; |
7 | collections::BTreeMap, | ||
8 | fs, | ||
9 | io::Write, | ||
10 | process::{Command, Stdio}, | ||
11 | }; | ||
12 | 7 | ||
13 | use proc_macro2::{Punct, Spacing}; | 8 | use proc_macro2::{Punct, Spacing}; |
14 | use quote::{format_ident, quote}; | 9 | use quote::{format_ident, quote}; |
@@ -163,7 +158,7 @@ fn generate_ast(grammar: &Grammar) -> Result<String> { | |||
163 | #(#nodes)* | 158 | #(#nodes)* |
164 | }; | 159 | }; |
165 | 160 | ||
166 | let pretty = reformat(ast)?; | 161 | let pretty = codegen::reformat(ast)?; |
167 | Ok(pretty) | 162 | Ok(pretty) |
168 | } | 163 | } |
169 | 164 | ||
@@ -276,21 +271,7 @@ fn generate_syntax_kinds(grammar: &Grammar) -> Result<String> { | |||
276 | } | 271 | } |
277 | }; | 272 | }; |
278 | 273 | ||
279 | reformat(ast) | 274 | codegen::reformat(ast) |
280 | } | ||
281 | |||
282 | fn reformat(text: impl std::fmt::Display) -> Result<String> { | ||
283 | let mut rustfmt = Command::new("rustfmt") | ||
284 | .arg("--config-path") | ||
285 | .arg(project_root().join("rustfmt.toml")) | ||
286 | .stdin(Stdio::piped()) | ||
287 | .stdout(Stdio::piped()) | ||
288 | .spawn()?; | ||
289 | write!(rustfmt.stdin.take().unwrap(), "{}", text)?; | ||
290 | let output = rustfmt.wait_with_output()?; | ||
291 | let stdout = String::from_utf8(output.stdout)?; | ||
292 | let preamble = "Generated file, do not edit by hand, see `crate/ra_tools/src/codegen`"; | ||
293 | Ok(format!("//! {}\n\n{}", preamble, stdout)) | ||
294 | } | 275 | } |
295 | 276 | ||
296 | #[derive(Deserialize, Debug)] | 277 | #[derive(Deserialize, Debug)] |