From 5376c769f0cb6076c4862e728af042bb563a5051 Mon Sep 17 00:00:00 2001 From: Aleksey Kladov Date: Thu, 17 Oct 2019 23:01:53 +0300 Subject: rename tools -> xtask --- .cargo/config | 2 +- Cargo.lock | 7 ----- Cargo.toml | 2 +- crates/ra_syntax/src/grammar.ron | 2 +- docs/dev/README.md | 10 +++---- docs/dev/architecture.md | 2 +- xtask/src/bin/pre-commit.rs | 2 +- xtask/src/lib.rs | 2 +- xtask/tests/cli.rs | 45 ---------------------------- xtask/tests/docs.rs | 63 ---------------------------------------- xtask/tests/main.rs | 2 -- xtask/tests/tidy-tests/cli.rs | 45 ++++++++++++++++++++++++++++ xtask/tests/tidy-tests/docs.rs | 63 ++++++++++++++++++++++++++++++++++++++++ xtask/tests/tidy-tests/main.rs | 2 ++ 14 files changed, 121 insertions(+), 128 deletions(-) delete mode 100644 xtask/tests/cli.rs delete mode 100644 xtask/tests/docs.rs delete mode 100644 xtask/tests/main.rs create mode 100644 xtask/tests/tidy-tests/cli.rs create mode 100644 xtask/tests/tidy-tests/docs.rs create mode 100644 xtask/tests/tidy-tests/main.rs diff --git a/.cargo/config b/.cargo/config index 67d0d1885..3812e1e2d 100644 --- a/.cargo/config +++ b/.cargo/config @@ -1,4 +1,4 @@ [alias] xtask = "run --package xtask --bin xtask --" -install-ra = "run --package xtask -- install" # for backwards compat +install-ra = "run --package xtask --bin xtask -- install" # for backwards compat diff --git a/Cargo.lock b/Cargo.lock index d2fe8e216..ea6521333 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1718,13 +1718,6 @@ name = "wasi" version = "0.7.0" source = "registry+https://github.com/rust-lang/crates.io-index" -[[package]] -name = "website-gen" -version = "0.0.0" -dependencies = [ - "walkdir 2.2.9 (registry+https://github.com/rust-lang/crates.io-index)", -] - [[package]] name = "winapi" version = "0.2.8" diff --git a/Cargo.toml b/Cargo.toml index e8f6c4267..97c02b40f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,5 +1,5 @@ [workspace] -members = [ "crates/*", "xtask/", "website/website-gen" ] +members = [ "crates/*", "xtask/" ] [profile.dev] debug = 1 # only line info diff --git a/crates/ra_syntax/src/grammar.ron b/crates/ra_syntax/src/grammar.ron index 25e6f64ce..0a8fd0612 100644 --- a/crates/ra_syntax/src/grammar.ron +++ b/crates/ra_syntax/src/grammar.ron @@ -1,5 +1,5 @@ // Stores definitions which must be used in multiple places -// See `cargo gen-syntax` (defined in crates/ra_tools/src/main.rs) +// See `cargo xtask codegen` (defined in xtasks/src/main.rs) Grammar( punct: [ (";", "SEMI"), diff --git a/docs/dev/README.md b/docs/dev/README.md index 5e18e4ffe..e5a7ea5f6 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md @@ -65,8 +65,8 @@ integrating with editors. Currently, it contains plugins for VS Code (in typescript) and Emacs (in elisp). The `docs` top-level directory contains both developer and user documentation. -We have some automation infra in Rust in the `crates/tool` package. It contains -stuff like formatting checking, code generation and powers `cargo install-ra`. +We have some automation infra in Rust in the `xtask` package. It contains +stuff like formatting checking, code generation and powers `cargo xtask install`. The latter syntax is achieved with the help of cargo aliases (see `.cargo` directory). @@ -84,7 +84,7 @@ However, launching a VS Code instance with locally build language server is possible. There's even a VS Code task for this, so just F5 should work (thanks, [@andrew-w-ross](https://github.com/andrew-w-ross)!). -I often just install development version with `cargo install-ra --server --jemalloc` and +I often just install development version with `cargo xtask install --server --jemalloc` and restart the host VS Code. See [./debugging.md](./debugging.md) for how to attach to rust-analyzer with @@ -116,7 +116,7 @@ Due to the requirements of running the tests inside VS Code they are **not run on CI**. When making changes to the extension please ensure the tests are not broken locally before opening a Pull Request. -To install **only** the VS Code extension, use `cargo install-ra --client-code`. +To install **only** the VS Code extension, use `cargo xtask install --client-code`. # Logging @@ -153,7 +153,7 @@ There's also two VS Code commands which might be of interest: $ cargo install --path crates/ra_lsp_server --force --features jemalloc ``` - There's an alias for this: `cargo install-ra --server --jemalloc`. + There's an alias for this: `cargo xtask install --server --jemalloc`. * `Rust Analyzer: Syntax Tree` shows syntax tree of the current file/selection. diff --git a/docs/dev/architecture.md b/docs/dev/architecture.md index 28f2a37e5..5ec5352e7 100644 --- a/docs/dev/architecture.md +++ b/docs/dev/architecture.md @@ -71,7 +71,7 @@ Rust syntax tree structure and parser. See This is the thing that turns a flat list of events into a tree (see `EventProcessor`) - `ast` provides a type safe API on top of the raw `rowan` tree. - `grammar.ron` RON description of the grammar, which is used to - generate `syntax_kinds` and `ast` modules, using `cargo gen-syntax` command. + generate `syntax_kinds` and `ast` modules, using `cargo xtask codegen` command. - `algo`: generic tree algorithms, including `walk` for O(1) stack space tree traversal (this is cool). diff --git a/xtask/src/bin/pre-commit.rs b/xtask/src/bin/pre-commit.rs index 16bbf9cb2..4ee864756 100644 --- a/xtask/src/bin/pre-commit.rs +++ b/xtask/src/bin/pre-commit.rs @@ -2,7 +2,7 @@ use std::process::Command; -use ra_tools::{project_root, run, run_rustfmt, Overwrite, Result}; +use xtask::{project_root, run, run_rustfmt, Overwrite, Result}; fn main() -> Result<()> { run_rustfmt(Overwrite)?; diff --git a/xtask/src/lib.rs b/xtask/src/lib.rs index 761592e85..a8685f567 100644 --- a/xtask/src/lib.rs +++ b/xtask/src/lib.rs @@ -146,7 +146,7 @@ pub fn install_format_hook() -> Result<()> { "./.git/hooks/pre-commit" }); if !result_path.exists() { - run("cargo build --package ra_tools --bin pre-commit", ".")?; + run("cargo build --package xtask --bin pre-commit", ".")?; if cfg!(windows) { fs::copy("./target/debug/pre-commit.exe", result_path)?; } else { diff --git a/xtask/tests/cli.rs b/xtask/tests/cli.rs deleted file mode 100644 index 609fd4d8b..000000000 --- a/xtask/tests/cli.rs +++ /dev/null @@ -1,45 +0,0 @@ -use ra_tools::{gen_tests, generate_boilerplate, project_root, run_rustfmt, Verify}; -use walkdir::WalkDir; - -#[test] -fn generated_grammar_is_fresh() { - if let Err(error) = generate_boilerplate(Verify) { - panic!("{}. Please update it by running `cargo gen-syntax`", error); - } -} - -#[test] -fn generated_tests_are_fresh() { - if let Err(error) = gen_tests(Verify) { - panic!("{}. Please update tests by running `cargo gen-tests`", error); - } -} - -#[test] -fn check_code_formatting() { - if let Err(error) = run_rustfmt(Verify) { - panic!("{}. Please format the code by running `cargo format`", error); - } -} - -#[test] -fn no_todo() { - WalkDir::new(project_root().join("crates")).into_iter().for_each(|e| { - let e = e.unwrap(); - if e.path().extension().map(|it| it != "rs").unwrap_or(true) { - return; - } - if e.path().ends_with("tests/cli.rs") { - return; - } - let text = std::fs::read_to_string(e.path()).unwrap(); - if text.contains("TODO") || text.contains("TOOD") { - panic!( - "\nTODO markers should not be committed to the master branch,\n\ - use FIXME instead\n\ - {}\n", - e.path().display(), - ) - } - }) -} diff --git a/xtask/tests/docs.rs b/xtask/tests/docs.rs deleted file mode 100644 index ea3330175..000000000 --- a/xtask/tests/docs.rs +++ /dev/null @@ -1,63 +0,0 @@ -use std::fs; -use std::io::prelude::*; -use std::io::BufReader; -use std::path::Path; - -use walkdir::{DirEntry, WalkDir}; - -use ra_tools::project_root; - -fn is_exclude_dir(p: &Path) -> bool { - let exclude_dirs = ["tests", "test_data"]; - let mut cur_path = p; - while let Some(path) = cur_path.parent() { - if exclude_dirs.iter().any(|dir| path.ends_with(dir)) { - return true; - } - cur_path = path; - } - - false -} - -fn is_exclude_file(d: &DirEntry) -> bool { - let file_names = ["tests.rs"]; - - d.file_name().to_str().map(|f_n| file_names.iter().any(|name| *name == f_n)).unwrap_or(false) -} - -fn is_hidden(entry: &DirEntry) -> bool { - entry.file_name().to_str().map(|s| s.starts_with(".")).unwrap_or(false) -} - -#[test] -fn no_docs_comments() { - let crates = project_root().join("crates"); - let iter = WalkDir::new(crates); - for f in iter.into_iter().filter_entry(|e| !is_hidden(e)) { - let f = f.unwrap(); - if f.file_type().is_dir() { - continue; - } - if f.path().extension().map(|it| it != "rs").unwrap_or(false) { - continue; - } - if is_exclude_dir(f.path()) { - continue; - } - if is_exclude_file(&f) { - continue; - } - let mut reader = BufReader::new(fs::File::open(f.path()).unwrap()); - let mut line = String::new(); - reader.read_line(&mut line).unwrap(); - if !line.starts_with("//!") { - panic!( - "\nMissing docs strings\n\ - module: {}\n\ - Need add doc for module\n", - f.path().display() - ) - } - } -} diff --git a/xtask/tests/main.rs b/xtask/tests/main.rs deleted file mode 100644 index 56d1318d6..000000000 --- a/xtask/tests/main.rs +++ /dev/null @@ -1,2 +0,0 @@ -mod cli; -mod docs; diff --git a/xtask/tests/tidy-tests/cli.rs b/xtask/tests/tidy-tests/cli.rs new file mode 100644 index 000000000..5d8ddea83 --- /dev/null +++ b/xtask/tests/tidy-tests/cli.rs @@ -0,0 +1,45 @@ +use walkdir::WalkDir; +use xtask::{gen_tests, generate_boilerplate, project_root, run_rustfmt, Verify}; + +#[test] +fn generated_grammar_is_fresh() { + if let Err(error) = generate_boilerplate(Verify) { + panic!("{}. Please update it by running `cargo xtask codegen`", error); + } +} + +#[test] +fn generated_tests_are_fresh() { + if let Err(error) = gen_tests(Verify) { + panic!("{}. Please update tests by running `cargo xtask gen-tests`", error); + } +} + +#[test] +fn check_code_formatting() { + if let Err(error) = run_rustfmt(Verify) { + panic!("{}. Please format the code by running `cargo format`", error); + } +} + +#[test] +fn no_todo() { + WalkDir::new(project_root().join("crates")).into_iter().for_each(|e| { + let e = e.unwrap(); + if e.path().extension().map(|it| it != "rs").unwrap_or(true) { + return; + } + if e.path().ends_with("tests/cli.rs") { + return; + } + let text = std::fs::read_to_string(e.path()).unwrap(); + if text.contains("TODO") || text.contains("TOOD") { + panic!( + "\nTODO markers should not be committed to the master branch,\n\ + use FIXME instead\n\ + {}\n", + e.path().display(), + ) + } + }) +} diff --git a/xtask/tests/tidy-tests/docs.rs b/xtask/tests/tidy-tests/docs.rs new file mode 100644 index 000000000..fe5852bc6 --- /dev/null +++ b/xtask/tests/tidy-tests/docs.rs @@ -0,0 +1,63 @@ +use std::fs; +use std::io::prelude::*; +use std::io::BufReader; +use std::path::Path; + +use walkdir::{DirEntry, WalkDir}; + +use xtask::project_root; + +fn is_exclude_dir(p: &Path) -> bool { + let exclude_dirs = ["tests", "test_data"]; + let mut cur_path = p; + while let Some(path) = cur_path.parent() { + if exclude_dirs.iter().any(|dir| path.ends_with(dir)) { + return true; + } + cur_path = path; + } + + false +} + +fn is_exclude_file(d: &DirEntry) -> bool { + let file_names = ["tests.rs"]; + + d.file_name().to_str().map(|f_n| file_names.iter().any(|name| *name == f_n)).unwrap_or(false) +} + +fn is_hidden(entry: &DirEntry) -> bool { + entry.file_name().to_str().map(|s| s.starts_with(".")).unwrap_or(false) +} + +#[test] +fn no_docs_comments() { + let crates = project_root().join("crates"); + let iter = WalkDir::new(crates); + for f in iter.into_iter().filter_entry(|e| !is_hidden(e)) { + let f = f.unwrap(); + if f.file_type().is_dir() { + continue; + } + if f.path().extension().map(|it| it != "rs").unwrap_or(false) { + continue; + } + if is_exclude_dir(f.path()) { + continue; + } + if is_exclude_file(&f) { + continue; + } + let mut reader = BufReader::new(fs::File::open(f.path()).unwrap()); + let mut line = String::new(); + reader.read_line(&mut line).unwrap(); + if !line.starts_with("//!") { + panic!( + "\nMissing docs strings\n\ + module: {}\n\ + Need add doc for module\n", + f.path().display() + ) + } + } +} diff --git a/xtask/tests/tidy-tests/main.rs b/xtask/tests/tidy-tests/main.rs new file mode 100644 index 000000000..56d1318d6 --- /dev/null +++ b/xtask/tests/tidy-tests/main.rs @@ -0,0 +1,2 @@ +mod cli; +mod docs; -- cgit v1.2.3