Make env vars a shareable crate (#171)

Cargo.toml

@@ -1,14 +1,21 @@
+[workspace]
+members = ["lib/*"]
+
+[workspace.package]
+edition = "2021"
+
+[workspace.dependencies]
+constants = { path = "lib/constants" }
+
 [package]
 name = "prefligit"
 version = "0.0.8"
 authors = ["j178 <hi@j178.dev>"]
 description = "pre-commit implemented in Rust"
 repository = "https://github.com/j178/prefligit"
 homepage = "https://github.com/j178/prefligit"
-edition = "2021"
+edition.workspace = true
 license-file = "LICENSE"
-# `cargo publish` failed because of this, disabled for now.
-# include = ["licenses/.*"]
 
 [features]
 default = ["docker"]
@@ -17,6 +24,8 @@ profiler-flamegraph = ["pprof/flamegraph"]
 docker = []
 
 [dependencies]
+constants = { workspace = true }
+
 anstream = "0.6.15"
 anyhow = "1.0.86"
 assert_cmd = { version = "2.0.16", features = ["color"] }
@@ -72,10 +81,13 @@ regex = "1.11.0"
 [build-dependencies]
 fs-err = "3.1.0"
 
-[lints.rust]
+[lints]
+workspace = true
+
+[workspace.lints.rust]
 dead_code = "allow"
 
-[lints.clippy]
+[workspace.lints.clippy]
 pedantic = { level = "warn", priority = -2 }
 # Allowed pedantic lints
 char_lit_as_u8 = "allow"

lib/constants/Cargo.toml

@@ -0,0 +1,7 @@
+[package]
+name = "constants"
+version = "0.0.1"
+edition.workspace = true
+
+[lints]
+workspace = true

src/env_vars.rs → lib/constants/src/env_vars.rs

@@ -7,6 +7,7 @@ impl EnvVars {
 
     pub const PREFLIGIT_HOME: &'static str = "PREFLIGIT_HOME";
 
+    pub const PREFLIGIT_INTERNAL__TEST_DIR: &'static str = "PREFLIGIT_INTERNAL__TEST_DIR";
     pub const PREFLIGIT_INTERNAL__SORT_FILENAMES: &'static str =
         "PREFLIGIT_INTERNAL__SORT_FILENAMES";
 

lib/constants/src/lib.rs

@@ -0,0 +1 @@
+pub mod env_vars;

src/cli/hook_impl.rs

@@ -2,11 +2,13 @@ use anyhow::Result;
 use std::ffi::OsString;
 use std::path::PathBuf;
 
+use anstream::eprintln;
+
+use constants::env_vars::EnvVars;
+
 use crate::cli::{self, ExitStatus, RunArgs};
 use crate::config::HookType;
-use crate::env_vars::EnvVars;
 use crate::printer::Printer;
-use anstream::eprintln;
 
 pub(crate) async fn hook_impl(
     config: Option<PathBuf>,

src/cli/run/filter.rs

@@ -6,8 +6,9 @@ use fancy_regex::Regex;
 use rayon::iter::{IntoParallelIterator, IntoParallelRefIterator, ParallelIterator};
 use tracing::{debug, error};
 
+use constants::env_vars::EnvVars;
+
 use crate::config::Stage;
-use crate::env_vars::EnvVars;
 use crate::fs::normalize_path;
 use crate::git;
 use crate::hook::Hook;

src/cli/run/run.rs

@@ -15,12 +15,13 @@ use rand::SeedableRng;
 use tracing::{debug, trace};
 use unicode_width::UnicodeWidthStr;
 
+use constants::env_vars::EnvVars;
+
 use crate::cli::reporter::{HookInitReporter, HookInstallReporter};
 use crate::cli::run::keeper::WorkTreeKeeper;
 use crate::cli::run::{get_filenames, FileFilter, FileOptions};
 use crate::cli::{ExitStatus, RunExtraArgs};
 use crate::config::Stage;
-use crate::env_vars::EnvVars;
 use crate::fs::Simplified;
 use crate::git;
 use crate::git::{get_diff, git_cmd};

src/languages/python/impl.rs

@@ -2,8 +2,9 @@ use std::collections::HashMap;
 use std::path::{Path, PathBuf};
 use std::sync::Arc;
 
+use constants::env_vars::EnvVars;
+
 use crate::config::LanguageVersion;
-use crate::env_vars::EnvVars;
 use crate::hook::Hook;
 use crate::languages::python::uv::UvInstaller;
 use crate::languages::LanguageImpl;

src/main.rs

@@ -20,7 +20,6 @@ mod builtin;
 mod cleanup;
 mod cli;
 mod config;
-mod env_vars;
 mod fs;
 mod git;
 mod hook;

src/run.rs

@@ -5,7 +5,8 @@ use std::sync::{Arc, LazyLock};
 use futures::StreamExt;
 use tracing::trace;
 
-use crate::env_vars::EnvVars;
+use constants::env_vars::EnvVars;
+
 use crate::hook::Hook;
 
 pub static CONCURRENCY: LazyLock<usize> = LazyLock::new(|| {

src/store.rs

@@ -7,8 +7,9 @@ use rusqlite::Connection;
 use thiserror::Error;
 use tracing::debug;
 
+use constants::env_vars::EnvVars;
+
 use crate::config::RemoteRepo;
-use crate::env_vars::EnvVars;
 use crate::fs::{copy_dir_all, LockedFile};
 use crate::git::clone_repo;
 use crate::hook::{Hook, Repo};

tests/common/mod.rs

@@ -9,6 +9,8 @@ use assert_cmd::assert::OutputAssertExt;
 use assert_fs::fixture::{ChildPath, FileWriteStr, PathChild};
 use etcetera::BaseStrategy;
 
+use constants::env_vars::EnvVars;
+
 pub struct TestContext {
     temp_dir: ChildPath,
     home_dir: ChildPath,
@@ -63,7 +65,7 @@ impl TestContext {
     }
 
     pub fn test_bucket_dir() -> PathBuf {
-        env::var("PREFLIGIT_INTERNAL__TEST_DIR")
+        env::var(EnvVars::PREFLIGIT_INTERNAL__TEST_DIR)
             .map(PathBuf::from)
             .unwrap_or_else(|_| {
                 etcetera::base_strategy::choose_base_strategy()
@@ -115,8 +117,8 @@ impl TestContext {
         let bin = assert_cmd::cargo::cargo_bin("prefligit");
         let mut cmd = Command::new(bin);
         cmd.current_dir(self.workdir());
-        cmd.env("PREFLIGIT_HOME", &*self.home_dir);
-        cmd.env("PREFLIGIT_INTERNAL__SORT_FILENAMES", "1");
+        cmd.env(EnvVars::PREFLIGIT_HOME, &*self.home_dir);
+        cmd.env(EnvVars::PREFLIGIT_INTERNAL__SORT_FILENAMES, "1");
         cmd
     }