Rustisms: part 1

.github/workflows/ci.yml

@@ -29,7 +29,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.STELE_GITHUB_TOKEN }}
 
-      - name: Run just test
+      - name: Run tests
         run: just test
 
   lints:

Cargo.toml

@@ -8,6 +8,7 @@ license = "AGPL-3.0"
 keywords = ["authentication", "laws", "preservation"]
 categories = ["authentication", "web-programming::http-server"]
 repository = "https://github.com/openlawlibrary/stele"
+rust-version = "1.66"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
@@ -19,6 +20,10 @@ git2 = "0.15"
 lazy_static = "1.4.0"
 regex = "1"
 serde = "1.0"
+tracing = "0.1.37"
+tracing-subscriber = "0.3.16"
+tracing-actix-web = "0.6.2"
+derive_more = "0.99.17"
 
 [dev-dependencies]
 criterion = "0.3"

README.md

@@ -18,7 +18,6 @@ Stele is a system for distributing, preserving, and authenticating laws.
 6. We recommend using [VSCode](https://code.visualstudio.com/Download) (default settings provided in repo), but you can use any editor you like.
 
 ### Development
-
 - Lints must pass before merging into master
 - All code must have tests. Tests should conform to our testing guidelines.
 - Run `just` from within the repository to list all available just commands. Currently:
@@ -31,6 +30,11 @@ Stele is a system for distributing, preserving, and authenticating laws.
     - `test`: Run all tests
 - On windows, especially, you may wish to run just through the nu shell, which can be done by calling all commands with the `--shell` command, e.g. `just --shell nu lint`.
 
+## Logging
+
+The ENV variable `RUST_LOG` can be set with one of `trace`, `debug`, `info`, `warn`, `error`. Filters can be set based on the `target` components seen in the logs lines, for example: to use `trace` but turn down the noise from the Actix dispatcher: `RUST_LOG="trace,actix_http::h1::dispatcher=warn"`
+
+See [tracing-subscriber docs](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/fmt/index.html#filtering-events-with-environment-variables) and [env_logger syntax](https://docs.rs/env_logger/latest/env_logger/#enabling-logging]).
 
 ## Q&A
 - Why do we suggest NuShell?

benches/git_benchmark.rs

@@ -1,34 +1,20 @@
 //! benchmark for git utils
 #![allow(clippy::self_named_module_files)]
-#![allow(clippy::std_instead_of_alloc)]
 #![allow(clippy::implicit_return)]
-#![allow(clippy::multiple_crate_versions)]
 #![allow(clippy::expect_used)]
 #![allow(missing_docs)]
 
 use criterion::{criterion_group, criterion_main, Criterion};
-use std::env::current_exe;
 use std::fs::create_dir_all;
 use std::path::PathBuf;
 use std::sync::Once;
 use stele::utils::git::Repo;
 
-/// get the path to the test library at `$REPO_ROOT/test/library`.
+/// get the path to the test library at `$REPO_ROOT/tests/fixtures/library`.
 fn get_test_library_path() -> PathBuf {
-    let mut library_path = current_exe()
-        .expect("Something went wrong getting the library path")
-        .parent()
-        .expect("Something went wrong getting the library path")
-        .parent()
-        .expect("Something went wrong getting the library path")
-        .parent()
-        .expect("Something went wrong getting the library path")
-        .parent()
-        .expect("Something went wrong getting the library path")
-        .to_owned();
-    library_path.push("test");
-    library_path.push("library");
-    library_path
+    let mut path = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
+    path.push("tests/fixtures/library");
+    path
 }
 
 /// ensure `initialize` function, below, is only called once

etc/NOTES.md

@@ -0,0 +1,29 @@
+# Project Notes
+
+## Pedantic Rust Editor Settings
+If you would like to make your editor always give you the most verbose feedback in any Rust project, you can use something like this. It can be used as-is in VSCode, or converted to something similar in your editor of choice.
+
+```json
+{
+    "rust-analyzer.checkOnSave.overrideCommand": [
+        "cargo",
+        "clippy",
+        "--message-format=json",
+        "--all-targets",
+        "--all-features",
+        "--",
+        "-W",
+        "clippy::all",
+        "-W",
+        "clippy::pedantic",
+        "-W",
+        "clippy::restriction",
+        "-W",
+        "clippy::nursery",
+        "-W",
+        "clippy::cargo",
+        "-W",
+        "missing_docs"
+    ],
+}
+```

justfile

@@ -9,7 +9,7 @@ lint: format clippy
 
 # Format code
 format:
-	cargo fmt --all -- --check
+  cargo fmt --all -- --check
 
 # Run all tests
 test:
@@ -27,4 +27,4 @@ ci: lint test bench
 
 # Run all benchmarks
 bench:
-  cargo bench
+  cargo bench