diff options
Diffstat (limited to 'xtask/src/codegen')
-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_features.rs | 10 | ||||
-rw-r--r-- | xtask/src/codegen/gen_lint_completions.rs | 113 | ||||
-rw-r--r-- | xtask/src/codegen/gen_parser_tests.rs | 2 |
6 files changed, 196 insertions, 11 deletions
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_features.rs b/xtask/src/codegen/gen_features.rs index b58c4a0c9..3cf15ce02 100644 --- a/xtask/src/codegen/gen_features.rs +++ b/xtask/src/codegen/gen_features.rs | |||
@@ -3,15 +3,13 @@ use std::path::{Path, PathBuf}; | |||
3 | 3 | ||
4 | use quote::quote; | 4 | use quote::quote; |
5 | use walkdir::WalkDir; | 5 | use walkdir::WalkDir; |
6 | use xshell::{cmd, read_file}; | ||
6 | 7 | ||
7 | use crate::{ | 8 | use crate::codegen::{project_root, reformat, update, Mode, Result}; |
8 | codegen::{project_root, reformat, update, Mode, Result}, | ||
9 | not_bash::{fs2, run}, | ||
10 | }; | ||
11 | 9 | ||
12 | pub fn generate_features(mode: Mode) -> Result<()> { | 10 | pub fn generate_features(mode: Mode) -> Result<()> { |
13 | if !Path::new("./target/rust").exists() { | 11 | if !Path::new("./target/rust").exists() { |
14 | run!("git clone https://github.com/rust-lang/rust ./target/rust")?; | 12 | cmd!("git clone https://github.com/rust-lang/rust ./target/rust").run()?; |
15 | } | 13 | } |
16 | 14 | ||
17 | let contents = generate_descriptor("./target/rust/src/doc/unstable-book/src".into())?; | 15 | let contents = generate_descriptor("./target/rust/src/doc/unstable-book/src".into())?; |
@@ -34,7 +32,7 @@ fn generate_descriptor(src_dir: PathBuf) -> Result<String> { | |||
34 | .map(|entry| { | 32 | .map(|entry| { |
35 | let path = entry.path(); | 33 | let path = entry.path(); |
36 | let feature_ident = path.file_stem().unwrap().to_str().unwrap().replace("-", "_"); | 34 | let feature_ident = path.file_stem().unwrap().to_str().unwrap().replace("-", "_"); |
37 | let doc = fs2::read_to_string(path).unwrap(); | 35 | let doc = read_file(path).unwrap(); |
38 | 36 | ||
39 | quote! { LintCompletion { label: #feature_ident, description: #doc } } | 37 | quote! { LintCompletion { label: #feature_ident, description: #doc } } |
40 | }); | 38 | }); |
diff --git a/xtask/src/codegen/gen_lint_completions.rs b/xtask/src/codegen/gen_lint_completions.rs new file mode 100644 index 000000000..b97421217 --- /dev/null +++ b/xtask/src/codegen/gen_lint_completions.rs | |||
@@ -0,0 +1,113 @@ | |||
1 | //! Generates descriptors structure for unstable feature from Unstable Book | ||
2 | use std::path::{Path, PathBuf}; | ||
3 | |||
4 | use quote::quote; | ||
5 | use walkdir::WalkDir; | ||
6 | use xshell::{cmd, read_file}; | ||
7 | |||
8 | use crate::{ | ||
9 | codegen::{project_root, reformat, update, Mode, Result}, | ||
10 | run_rustfmt, | ||
11 | }; | ||
12 | |||
13 | pub fn generate_lint_completions(mode: Mode) -> Result<()> { | ||
14 | if !Path::new("./target/rust").exists() { | ||
15 | cmd!("git clone --depth=1 https://github.com/rust-lang/rust ./target/rust").run()?; | ||
16 | } | ||
17 | |||
18 | let ts_features = generate_descriptor("./target/rust/src/doc/unstable-book/src".into())?; | ||
19 | cmd!("curl http://rust-lang.github.io/rust-clippy/master/lints.json --output ./target/clippy_lints.json").run()?; | ||
20 | |||
21 | let ts_clippy = generate_descriptor_clippy(&Path::new("./target/clippy_lints.json"))?; | ||
22 | let ts = quote! { | ||
23 | use crate::completions::attribute::LintCompletion; | ||
24 | #ts_features | ||
25 | #ts_clippy | ||
26 | }; | ||
27 | let contents = reformat(ts.to_string().as_str())?; | ||
28 | |||
29 | let destination = project_root().join("crates/completion/src/generated_lint_completions.rs"); | ||
30 | update(destination.as_path(), &contents, mode)?; | ||
31 | run_rustfmt(mode)?; | ||
32 | |||
33 | Ok(()) | ||
34 | } | ||
35 | |||
36 | fn generate_descriptor(src_dir: PathBuf) -> Result<proc_macro2::TokenStream> { | ||
37 | let definitions = ["language-features", "library-features"] | ||
38 | .iter() | ||
39 | .flat_map(|it| WalkDir::new(src_dir.join(it))) | ||
40 | .filter_map(|e| e.ok()) | ||
41 | .filter(|entry| { | ||
42 | // Get all `.md ` files | ||
43 | entry.file_type().is_file() && entry.path().extension().unwrap_or_default() == "md" | ||
44 | }) | ||
45 | .map(|entry| { | ||
46 | let path = entry.path(); | ||
47 | let feature_ident = path.file_stem().unwrap().to_str().unwrap().replace("-", "_"); | ||
48 | let doc = read_file(path).unwrap(); | ||
49 | |||
50 | quote! { LintCompletion { label: #feature_ident, description: #doc } } | ||
51 | }); | ||
52 | |||
53 | let ts = quote! { | ||
54 | pub(super) const FEATURES: &[LintCompletion] = &[ | ||
55 | #(#definitions),* | ||
56 | ]; | ||
57 | }; | ||
58 | |||
59 | Ok(ts) | ||
60 | } | ||
61 | |||
62 | #[derive(Default)] | ||
63 | struct ClippyLint { | ||
64 | help: String, | ||
65 | id: String, | ||
66 | } | ||
67 | |||
68 | fn generate_descriptor_clippy(path: &Path) -> Result<proc_macro2::TokenStream> { | ||
69 | let file_content = read_file(path)?; | ||
70 | let mut clippy_lints: Vec<ClippyLint> = vec![]; | ||
71 | |||
72 | for line in file_content.lines().map(|line| line.trim()) { | ||
73 | if line.starts_with(r#""id":"#) { | ||
74 | let clippy_lint = ClippyLint { | ||
75 | id: line | ||
76 | .strip_prefix(r#""id": ""#) | ||
77 | .expect("should be prefixed by id") | ||
78 | .strip_suffix(r#"","#) | ||
79 | .expect("should be suffixed by comma") | ||
80 | .into(), | ||
81 | help: String::new(), | ||
82 | }; | ||
83 | clippy_lints.push(clippy_lint) | ||
84 | } else if line.starts_with(r#""What it does":"#) { | ||
85 | // Typical line to strip: "What is doest": "Here is my useful content", | ||
86 | let prefix_to_strip = r#""What it does": ""#; | ||
87 | let suffix_to_strip = r#"","#; | ||
88 | |||
89 | let clippy_lint = clippy_lints.last_mut().expect("clippy lint must already exist"); | ||
90 | clippy_lint.help = line | ||
91 | .strip_prefix(prefix_to_strip) | ||
92 | .expect("should be prefixed by what it does") | ||
93 | .strip_suffix(suffix_to_strip) | ||
94 | .expect("should be suffixed by comma") | ||
95 | .into(); | ||
96 | } | ||
97 | } | ||
98 | |||
99 | let definitions = clippy_lints.into_iter().map(|clippy_lint| { | ||
100 | let lint_ident = format!("clippy::{}", clippy_lint.id); | ||
101 | let doc = clippy_lint.help; | ||
102 | |||
103 | quote! { LintCompletion { label: #lint_ident, description: #doc } } | ||
104 | }); | ||
105 | |||
106 | let ts = quote! { | ||
107 | pub(super) const CLIPPY_LINTS: &[LintCompletion] = &[ | ||
108 | #(#definitions),* | ||
109 | ]; | ||
110 | }; | ||
111 | |||
112 | Ok(ts) | ||
113 | } | ||
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); |