Distinguish library and CLI log messages (#666)

* filter log messages from the library separately * Revert "filter log messages from the library separately" This reverts commit 23a8ddd. See discussion at #666 (review) * Rename library to "topiary-core", to distinguish log output Also moved to short-form directory structure to make it easier (for lazy people such as myself) to navigate ;) Resolves #604 * Fix tests (mostly ../queries -> ../queries/queries) Also pinned to tree-sitter-bash 1b0321ee; looks like it's moved on in the last few months and our queries don't work with the latest version * Stragglers... * Update to toml 0.8 * Fix Nix stuff * Correct symlink to languages.toml * More stragglers * Revert to `topiary-*` top-level directories * Fix formatting * Fix issues introduced by merge --------- Co-authored-by: Christopher Harrison <christopher.harrison@tweag.io>
tweag · Jan 29, 2024 · 3eaf0c5 · 3eaf0c5
1 parent a30cd32
commit 3eaf0c5
Show file tree

Hide file tree

Showing 37 changed files with 91 additions and 91 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,2 +1,2 @@
 # Hide our tests from language detection so GitHub correctly detects Topiary as a Rust project
-topiary/tests/samples/** linguist-vendored
+topiary-core/tests/samples/** linguist-vendored
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -15,7 +15,7 @@ If you do `cargo install flamegraph`, you can generate a performance flamegraph
 like this:
 
 ```bash
-CARGO_PROFILE_RELEASE_DEBUG=true cargo flamegraph -- -l ocaml < topiary/tests/samples/input/ocaml.ml > formatted.ml
+CARGO_PROFILE_RELEASE_DEBUG=true cargo flamegraph -- -l ocaml < topiary-cli/tests/samples/input/ocaml.ml > formatted.ml
 ```
 
 ## Code Coverage

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -9,8 +9,8 @@ readme = "README.md"
 license = "MIT"
 
 [workspace]
-members = ["topiary", "topiary-cli", "topiary-queries", "topiary-playground", "topiary-config", "topiary-web-tree-sitter-sys", "topiary-tree-sitter-facade"]
-default-members = [ "topiary", "topiary-cli" ]
+members = ["topiary-core", "topiary-cli", "topiary-queries", "topiary-playground", "topiary-config", "topiary-web-tree-sitter-sys", "topiary-tree-sitter-facade"]
+default-members = [ "topiary-core", "topiary-cli" ]
 exclude = ["samples"]
 resolver = "2"
 
@@ -59,7 +59,7 @@ tempfile = "3.5"
 test-log = "0.2"
 tokio = "1.32"
 tokio-test = "0.4"
-toml = "0.7"
+toml = "0.8"
 tree-sitter = "0.20"
 tree-sitter-bash = { git = "https://github.com/tree-sitter/tree-sitter-bash", rev = "1b0321ee85701d5036c334a6f04761cdc672e64c" }
 tree-sitter-json = { git = "https://github.com/tree-sitter/tree-sitter-json.git" }

diff --git a/README.md b/README.md
@@ -127,7 +127,7 @@ Topiary's language query files (`.scm`) are located**. By default, you should
 set it to `<local path of the topiary repository>/queries`, for example:
 
 ```sh
-export TOPIARY_LANGUAGE_DIR=/home/me/tools/topiary/queries
+export TOPIARY_LANGUAGE_DIR=/home/me/tools/topiary/topiary-queries/queries
 topiary fmt ./projects/helloworld/hello.ml
 ```
 
@@ -1324,9 +1324,9 @@ containing the matched nodes are is single-line (resp. multi-line).
 In order to work productively on query files, the following is one
 suggested way to work:
 
-1. Add a sample file to `topiary/tests/samples/input`.
+1. Add a sample file to `topiary-cli/tests/samples/input`.
 
-2. Copy the same file to `topiary/tests/samples/expected`, and make any changes
+2. Copy the same file to `topiary-cli/tests/samples/expected`, and make any changes
    to how you want the output to be formatted.
 
 3. If this is a new language, add its Tree-sitter grammar, extend
@@ -1337,7 +1337,7 @@ suggested way to work:
 
    ```
    RUST_LOG=debug \
-   cargo test -p topiary \
+   cargo test -p topiary-cli \
               input_output_tester \
               -- --nocapture
    ```

diff --git a/default.nix b/default.nix
@@ -24,9 +24,8 @@ let
         "Cargo.lock"
         "Cargo.toml"
         "languages.toml"
-        "queries"
         "tests"
-        "topiary"
+        "topiary-core"
         "topiary-cli"
         "topiary-config"
         "topiary-playground"
@@ -84,11 +83,11 @@ in
     cargoTestCommand = "cargo bench --profile release";
   });
 
-  topiary-lib = craneLib.buildPackage (commonArgs
+  topiary-core = craneLib.buildPackage (commonArgs
     // {
     inherit cargoArtifacts;
-    pname = "topiary-lib";
-    cargoExtraArgs = "-p topiary";
+    pname = "topiary-core";
+    cargoExtraArgs = "-p topiary-core";
   });
 
   topiary-cli = craneLib.buildPackage (commonArgs
@@ -97,7 +96,7 @@ in
     pname = "topiary";
     cargoExtraArgs = "-p topiary-cli";
     postInstall = ''
-      install -Dm444 queries/* -t $out/share/queries
+      install -Dm444 topiary-queries/queries/* -t $out/share/queries
     '';
 
     # Set TOPIARY_LANGUAGE_DIR to the Nix store
@@ -116,7 +115,7 @@ in
     pname = "topiary-queries";
     cargoExtraArgs = "-p topiary-queries";
     postInstall = ''
-      install -Dm444 queries/* -t $out/share/queries
+      install -Dm444 topiary-queries/queries/* -t $out/share/queries
     '';
   });
 

diff --git a/flake.nix b/flake.nix
@@ -50,7 +50,7 @@
         };
 
         checks = {
-          inherit (code) clippy clippy-wasm fmt topiary-lib topiary-cli topiary-playground audit benchmark;
+          inherit (code) clippy clippy-wasm fmt topiary-core topiary-cli topiary-playground audit benchmark;
 
           ## Check that the `lib.pre-commit-hook` output builds/evaluates
           ## correctly. `deepSeq e1 e2` evaluates `e1` strictly in depth before

diff --git a/languages.toml b/languages.toml
@@ -1 +1 @@
-topiary/languages.toml
+topiary-core/languages.toml
diff --git a/playground.sh b/playground.sh
@@ -31,7 +31,7 @@ get_sample_input() {
   local language="$1"
 
   # Only return the first result, presuming there is one
-  find topiary/tests/samples/input -name "${language}.*" \
+  find topiary-core/tests/samples/input -name "${language}.*" \
   | head -1
 }
 

diff --git a/queries b/queries
diff --git a/samples/client-app/Cargo.toml b/samples/client-app/Cargo.toml
@@ -5,4 +5,4 @@ edition = "2021"
 
 [dependencies]
 tokio = { version = "^1.28.1", features = ["rt-multi-thread", "macros"] }
-topiary = { path = "../../topiary" }
+topiary = { path = "../../topiary-core" }
diff --git a/samples/client-app/src/main.rs b/samples/client-app/src/main.rs
@@ -1,9 +1,10 @@
-use topiary::{formatter, Configuration, Operation, TopiaryQuery};
+use topiary_core::{formatter, Configuration, Operation, TopiaryQuery};
 
 #[tokio::main]
 async fn main() {
     let mut input =
-        "{\"name\":\"John Doe\",\"age\":43,\n\"phones\":[\"+44 1234567\",\"+44 2345678\"]}".as_bytes();
+        "{\"name\":\"John Doe\",\"age\":43,\n\"phones\":[\"+44 1234567\",\"+44 2345678\"]}"
+            .as_bytes();
 
     let mut output = Vec::new();
     let query = TopiaryQuery::json();

diff --git a/topiary-cli/Cargo.toml b/topiary-cli/Cargo.toml
@@ -38,7 +38,7 @@ serde = { workspace = true, features = ["derive"] }
 tempfile = { workspace = true }
 tokio = { workspace = true, features = ["fs", "rt-multi-thread", "sync", "macros"] }
 toml = { workspace = true }
-topiary = { path = "../topiary" }
+topiary-core = { path = "../topiary-core" }
 topiary-config = { path = "../topiary-config" }
 topiary-queries = { path = "../topiary-queries" }
 topiary-tree-sitter-facade = { workspace = true }

diff --git a/topiary-cli/src/error.rs b/topiary-cli/src/error.rs
@@ -1,6 +1,6 @@
 use std::{error, fmt, io, path::PathBuf, process::ExitCode, result};
-use topiary::FormatterError;
 use topiary_config::error::TopiaryConfigError;
+use topiary_core::FormatterError;
 
 /// A convenience wrapper around `std::result::Result<T, TopiaryError>`.
 pub type CLIResult<T> = result::Result<T, TopiaryError>;

diff --git a/topiary-cli/src/io.rs b/topiary-cli/src/io.rs
@@ -7,8 +7,8 @@ use std::{
 };
 
 use tempfile::NamedTempFile;
-use topiary::{Language, TopiaryQuery};
 use topiary_config::Configuration;
+use topiary_core::{Language, TopiaryQuery};
 
 use crate::{
     cli::{AtLeastOneInput, ExactlyOneInput, FromStdin},

diff --git a/topiary-cli/src/language.rs b/topiary-cli/src/language.rs
@@ -8,7 +8,7 @@ use std::{
 };
 
 use tokio::sync::Mutex;
-use topiary::Language;
+use topiary_core::Language;
 
 use crate::{error::CLIResult, io::InputFile};
 

diff --git a/topiary-cli/src/main.rs b/topiary-cli/src/main.rs
@@ -10,7 +10,7 @@ use std::{
     process::ExitCode,
 };
 
-use topiary::{formatter, Operation};
+use topiary_core::{formatter, Operation};
 
 use crate::{
     cli::Commands,

diff --git a/topiary-cli/src/visualisation.rs b/topiary-cli/src/visualisation.rs
@@ -1,9 +1,9 @@
 use clap::ValueEnum;
-use topiary::Visualisation;
+use topiary_core::Visualisation;
 
 /// Visualisation output formats for Tree-sitter parse trees
-// NOTE While redundant, we cannot implement clap::ValueEnum for topiary::Visualisation without
-// breaking the orphan rules. So we have to maintain a local copy for the sake of the CLI.
+// NOTE While redundant, we cannot implement clap::ValueEnum for topiary_core::Visualisation
+// without breaking the orphan rules. So we have to maintain a local copy for the sake of the CLI.
 #[derive(Clone, Debug, ValueEnum)]
 pub enum Format {
     /// GraphViz DOT serialisation
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		topiary/languages.toml
		topiary-core/languages.toml