diff options
Diffstat (limited to 'xtask')
-rw-r--r-- | xtask/src/codegen.rs | 3 | ||||
-rw-r--r-- | xtask/src/codegen/gen_assists_docs.rs | 4 | ||||
-rw-r--r-- | xtask/src/codegen/gen_diagnostic_docs.rs | 74 | ||||
-rw-r--r-- | xtask/src/codegen/gen_feature_docs.rs | 4 | ||||
-rw-r--r-- | xtask/src/codegen/gen_parser_tests.rs | 2 | ||||
-rw-r--r-- | xtask/src/release.rs | 9 | ||||
-rw-r--r-- | xtask/tests/tidy.rs | 1 |
7 files changed, 91 insertions, 6 deletions
diff --git a/xtask/src/codegen.rs b/xtask/src/codegen.rs index 3ee4c1adf..afa703471 100644 --- a/xtask/src/codegen.rs +++ b/xtask/src/codegen.rs | |||
@@ -10,6 +10,7 @@ mod gen_parser_tests; | |||
10 | mod gen_assists_docs; | 10 | mod gen_assists_docs; |
11 | mod gen_feature_docs; | 11 | mod gen_feature_docs; |
12 | mod gen_features; | 12 | mod gen_features; |
13 | mod gen_diagnostic_docs; | ||
13 | 14 | ||
14 | use std::{ | 15 | use std::{ |
15 | fmt, mem, | 16 | fmt, mem, |
@@ -21,6 +22,7 @@ use crate::{ensure_rustfmt, project_root, Result}; | |||
21 | 22 | ||
22 | pub use self::{ | 23 | pub use self::{ |
23 | gen_assists_docs::{generate_assists_docs, generate_assists_tests}, | 24 | gen_assists_docs::{generate_assists_docs, generate_assists_tests}, |
25 | gen_diagnostic_docs::generate_diagnostic_docs, | ||
24 | gen_feature_docs::generate_feature_docs, | 26 | gen_feature_docs::generate_feature_docs, |
25 | gen_features::generate_features, | 27 | gen_features::generate_features, |
26 | gen_parser_tests::generate_parser_tests, | 28 | gen_parser_tests::generate_parser_tests, |
@@ -47,6 +49,7 @@ impl CodegenCmd { | |||
47 | generate_assists_tests(Mode::Overwrite)?; | 49 | generate_assists_tests(Mode::Overwrite)?; |
48 | generate_assists_docs(Mode::Overwrite)?; | 50 | generate_assists_docs(Mode::Overwrite)?; |
49 | generate_feature_docs(Mode::Overwrite)?; | 51 | generate_feature_docs(Mode::Overwrite)?; |
52 | generate_diagnostic_docs(Mode::Overwrite)?; | ||
50 | Ok(()) | 53 | Ok(()) |
51 | } | 54 | } |
52 | } | 55 | } |
diff --git a/xtask/src/codegen/gen_assists_docs.rs b/xtask/src/codegen/gen_assists_docs.rs index ff307e2aa..d7c85ebe9 100644 --- a/xtask/src/codegen/gen_assists_docs.rs +++ b/xtask/src/codegen/gen_assists_docs.rs | |||
@@ -1,6 +1,6 @@ | |||
1 | //! Generates `assists.md` documentation. | 1 | //! Generates `assists.md` documentation. |
2 | 2 | ||
3 | use std::{fmt, fs, path::Path}; | 3 | use std::{fmt, path::Path}; |
4 | 4 | ||
5 | use crate::{ | 5 | use crate::{ |
6 | codegen::{self, extract_comment_blocks_with_empty_lines, reformat, Location, Mode, PREAMBLE}, | 6 | codegen::{self, extract_comment_blocks_with_empty_lines, reformat, Location, Mode, PREAMBLE}, |
@@ -39,7 +39,7 @@ impl Assist { | |||
39 | return Ok(res); | 39 | return Ok(res); |
40 | 40 | ||
41 | fn collect_file(acc: &mut Vec<Assist>, path: &Path) -> Result<()> { | 41 | fn collect_file(acc: &mut Vec<Assist>, path: &Path) -> Result<()> { |
42 | let text = fs::read_to_string(path)?; | 42 | let text = xshell::read_file(path)?; |
43 | let comment_blocks = extract_comment_blocks_with_empty_lines("Assist", &text); | 43 | let comment_blocks = extract_comment_blocks_with_empty_lines("Assist", &text); |
44 | 44 | ||
45 | for block in comment_blocks { | 45 | for block in comment_blocks { |
diff --git a/xtask/src/codegen/gen_diagnostic_docs.rs b/xtask/src/codegen/gen_diagnostic_docs.rs new file mode 100644 index 000000000..00aaea5b7 --- /dev/null +++ b/xtask/src/codegen/gen_diagnostic_docs.rs | |||
@@ -0,0 +1,74 @@ | |||
1 | //! Generates `assists.md` documentation. | ||
2 | |||
3 | use std::{fmt, path::PathBuf}; | ||
4 | |||
5 | use crate::{ | ||
6 | codegen::{self, extract_comment_blocks_with_empty_lines, Location, Mode, PREAMBLE}, | ||
7 | project_root, rust_files, Result, | ||
8 | }; | ||
9 | |||
10 | pub fn generate_diagnostic_docs(mode: Mode) -> Result<()> { | ||
11 | let diagnostics = Diagnostic::collect()?; | ||
12 | let contents = | ||
13 | diagnostics.into_iter().map(|it| it.to_string()).collect::<Vec<_>>().join("\n\n"); | ||
14 | let contents = format!("//{}\n{}\n", PREAMBLE, contents.trim()); | ||
15 | let dst = project_root().join("docs/user/generated_diagnostic.adoc"); | ||
16 | codegen::update(&dst, &contents, mode)?; | ||
17 | Ok(()) | ||
18 | } | ||
19 | |||
20 | #[derive(Debug)] | ||
21 | struct Diagnostic { | ||
22 | id: String, | ||
23 | location: Location, | ||
24 | doc: String, | ||
25 | } | ||
26 | |||
27 | impl Diagnostic { | ||
28 | fn collect() -> Result<Vec<Diagnostic>> { | ||
29 | let mut res = Vec::new(); | ||
30 | for path in rust_files(&project_root()) { | ||
31 | collect_file(&mut res, path)?; | ||
32 | } | ||
33 | res.sort_by(|lhs, rhs| lhs.id.cmp(&rhs.id)); | ||
34 | return Ok(res); | ||
35 | |||
36 | fn collect_file(acc: &mut Vec<Diagnostic>, path: PathBuf) -> Result<()> { | ||
37 | let text = xshell::read_file(&path)?; | ||
38 | let comment_blocks = extract_comment_blocks_with_empty_lines("Diagnostic", &text); | ||
39 | |||
40 | for block in comment_blocks { | ||
41 | let id = block.id; | ||
42 | if let Err(msg) = is_valid_diagnostic_name(&id) { | ||
43 | panic!("invalid diagnostic name: {:?}:\n {}", id, msg) | ||
44 | } | ||
45 | let doc = block.contents.join("\n"); | ||
46 | let location = Location::new(path.clone(), block.line); | ||
47 | acc.push(Diagnostic { id, location, doc }) | ||
48 | } | ||
49 | |||
50 | Ok(()) | ||
51 | } | ||
52 | } | ||
53 | } | ||
54 | |||
55 | fn is_valid_diagnostic_name(diagnostic: &str) -> Result<(), String> { | ||
56 | let diagnostic = diagnostic.trim(); | ||
57 | if diagnostic.find(char::is_whitespace).is_some() { | ||
58 | return Err("Diagnostic names can't contain whitespace symbols".into()); | ||
59 | } | ||
60 | if diagnostic.chars().any(|c| c.is_ascii_uppercase()) { | ||
61 | return Err("Diagnostic names can't contain uppercase symbols".into()); | ||
62 | } | ||
63 | if diagnostic.chars().any(|c| !c.is_ascii()) { | ||
64 | return Err("Diagnostic can't contain non-ASCII symbols".into()); | ||
65 | } | ||
66 | |||
67 | Ok(()) | ||
68 | } | ||
69 | |||
70 | impl fmt::Display for Diagnostic { | ||
71 | fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
72 | writeln!(f, "=== {}\n**Source:** {}\n{}", self.id, self.location, self.doc) | ||
73 | } | ||
74 | } | ||
diff --git a/xtask/src/codegen/gen_feature_docs.rs b/xtask/src/codegen/gen_feature_docs.rs index 341e67c73..065dd33f1 100644 --- a/xtask/src/codegen/gen_feature_docs.rs +++ b/xtask/src/codegen/gen_feature_docs.rs | |||
@@ -1,6 +1,6 @@ | |||
1 | //! Generates `assists.md` documentation. | 1 | //! Generates `assists.md` documentation. |
2 | 2 | ||
3 | use std::{fmt, fs, path::PathBuf}; | 3 | use std::{fmt, path::PathBuf}; |
4 | 4 | ||
5 | use crate::{ | 5 | use crate::{ |
6 | codegen::{self, extract_comment_blocks_with_empty_lines, Location, Mode, PREAMBLE}, | 6 | codegen::{self, extract_comment_blocks_with_empty_lines, Location, Mode, PREAMBLE}, |
@@ -33,7 +33,7 @@ impl Feature { | |||
33 | return Ok(res); | 33 | return Ok(res); |
34 | 34 | ||
35 | fn collect_file(acc: &mut Vec<Feature>, path: PathBuf) -> Result<()> { | 35 | fn collect_file(acc: &mut Vec<Feature>, path: PathBuf) -> Result<()> { |
36 | let text = fs::read_to_string(&path)?; | 36 | let text = xshell::read_file(&path)?; |
37 | let comment_blocks = extract_comment_blocks_with_empty_lines("Feature", &text); | 37 | let comment_blocks = extract_comment_blocks_with_empty_lines("Feature", &text); |
38 | 38 | ||
39 | for block in comment_blocks { | 39 | for block in comment_blocks { |
diff --git a/xtask/src/codegen/gen_parser_tests.rs b/xtask/src/codegen/gen_parser_tests.rs index 96fdd9216..19ae949d4 100644 --- a/xtask/src/codegen/gen_parser_tests.rs +++ b/xtask/src/codegen/gen_parser_tests.rs | |||
@@ -124,7 +124,7 @@ fn existing_tests(dir: &Path, ok: bool) -> Result<HashMap<String, (PathBuf, Test | |||
124 | let file_name = path.file_name().unwrap().to_str().unwrap(); | 124 | let file_name = path.file_name().unwrap().to_str().unwrap(); |
125 | file_name[5..file_name.len() - 3].to_string() | 125 | file_name[5..file_name.len() - 3].to_string() |
126 | }; | 126 | }; |
127 | let text = fs::read_to_string(&path)?; | 127 | let text = xshell::read_file(&path)?; |
128 | let test = Test { name: name.clone(), text, ok }; | 128 | let test = Test { name: name.clone(), text, ok }; |
129 | if let Some(old) = res.insert(name, (path, test)) { | 129 | if let Some(old) = res.insert(name, (path, test)) { |
130 | println!("Duplicate test: {:?}", old); | 130 | println!("Duplicate test: {:?}", old); |
diff --git a/xtask/src/release.rs b/xtask/src/release.rs index 14fc1f0dd..3cf0d849f 100644 --- a/xtask/src/release.rs +++ b/xtask/src/release.rs | |||
@@ -52,7 +52,14 @@ https://github.com/sponsors/rust-analyzer[GitHub Sponsors]. | |||
52 | let path = changelog_dir.join(format!("{}-changelog-{}.adoc", today, changelog_n)); | 52 | let path = changelog_dir.join(format!("{}-changelog-{}.adoc", today, changelog_n)); |
53 | write_file(&path, &contents)?; | 53 | write_file(&path, &contents)?; |
54 | 54 | ||
55 | for &adoc in ["manual.adoc", "generated_features.adoc", "generated_assists.adoc"].iter() { | 55 | for &adoc in [ |
56 | "manual.adoc", | ||
57 | "generated_features.adoc", | ||
58 | "generated_assists.adoc", | ||
59 | "generated_diagnostic.adoc", | ||
60 | ] | ||
61 | .iter() | ||
62 | { | ||
56 | let src = project_root().join("./docs/user/").join(adoc); | 63 | let src = project_root().join("./docs/user/").join(adoc); |
57 | let dst = website_root.join(adoc); | 64 | let dst = website_root.join(adoc); |
58 | cp(src, dst)?; | 65 | cp(src, dst)?; |
diff --git a/xtask/tests/tidy.rs b/xtask/tests/tidy.rs index 460069407..faaef2fd4 100644 --- a/xtask/tests/tidy.rs +++ b/xtask/tests/tidy.rs | |||
@@ -42,6 +42,7 @@ fn smoke_test_docs_generation() { | |||
42 | // We don't commit docs to the repo, so we can just overwrite in tests. | 42 | // We don't commit docs to the repo, so we can just overwrite in tests. |
43 | codegen::generate_assists_docs(Mode::Overwrite).unwrap(); | 43 | codegen::generate_assists_docs(Mode::Overwrite).unwrap(); |
44 | codegen::generate_feature_docs(Mode::Overwrite).unwrap(); | 44 | codegen::generate_feature_docs(Mode::Overwrite).unwrap(); |
45 | codegen::generate_diagnostic_docs(Mode::Overwrite).unwrap(); | ||
45 | } | 46 | } |
46 | 47 | ||
47 | #[test] | 48 | #[test] |