new: Add debug env command. (#359)

CHANGELOG.md

@@ -14,6 +14,7 @@
 
 #### 🚀 Updates
 
+- Added a `proto debug env` command, for debugging basic env/store information.
 - Updated version resolve errors to include the tool that failed.
 
 #### ⚙️ Internal

Cargo.toml

@@ -4,7 +4,7 @@ members = ["crates/*"]
 default-members = ["crates/cli"]
 
 [workspace.dependencies]
-anyhow = "1.0.75"
+anyhow = "1.0.76"
 cached = "0.46.1"
 clap = "4.4.11"
 clap_complete = "4.4.4"

crates/cli/src/app.rs

@@ -232,6 +232,9 @@ pub enum DebugCommands {
         about = "Debug all loaded .prototools config's for the current directory."
     )]
     Config(DebugConfigArgs),
+
+    #[command(name = "env", about = "Debug the current proto environment and store.")]
+    Env,
 }
 
 #[derive(Clone, Debug, Subcommand)]

crates/cli/src/commands/debug/env.rs

@@ -0,0 +1,84 @@
+use crate::helpers::ProtoResource;
+use crate::printer::Printer;
+use proto_pdk_api::{HostArch, HostOS};
+use starbase::system;
+use starbase_styles::color;
+use std::env;
+
+#[system]
+pub async fn env(proto: ResourceRef<ProtoResource>) {
+    let manager = proto.env.load_config_manager()?;
+    let mut printer = Printer::new();
+
+    // STORE
+
+    printer.named_section("Store", |p| {
+        p.entry("Root", color::path(&proto.env.root));
+        p.entry("Bins", color::path(&proto.env.bin_dir));
+        p.entry("Shims", color::path(&proto.env.shims_dir));
+        p.entry("Plugins", color::path(&proto.env.plugins_dir));
+        p.entry("Tools", color::path(&proto.env.tools_dir));
+        p.entry("Temp", color::path(&proto.env.temp_dir));
+        p.entry_map(
+            "Virtual",
+            proto
+                .env
+                .get_virtual_paths()
+                .iter()
+                .map(|(h, g)| (color::file(g.to_string_lossy()), color::path(h))),
+            None,
+        );
+        p.entry_list(
+            "Configs",
+            manager.files.iter().filter_map(|f| {
+                if f.exists {
+                    Some(color::path(&f.path))
+                } else {
+                    None
+                }
+            }),
+            None,
+        );
+
+        Ok(())
+    })?;
+
+    // ENV
+
+    printer.named_section("Environment", |p| {
+        p.entry(
+            "Proto version",
+            color::muted_light(env!("CARGO_PKG_VERSION")),
+        );
+        p.entry(
+            "Operating system",
+            color::muted_light(HostOS::from_env().to_string()),
+        );
+        p.entry(
+            "Architecture",
+            color::muted_light(HostArch::from_env().to_string()),
+        );
+        p.entry_map(
+            "Variables",
+            env::vars().filter_map(|(k, v)| {
+                if k.starts_with("PROTO_") {
+                    Some((
+                        color::id(k),
+                        if v.contains('/') || v.contains('\\') {
+                            color::path(v)
+                        } else {
+                            color::muted_light(v)
+                        },
+                    ))
+                } else {
+                    None
+                }
+            }),
+            None,
+        );
+
+        Ok(())
+    })?;
+
+    printer.flush();
+}

crates/cli/src/commands/debug/mod.rs

@@ -1,3 +1,5 @@
 mod config;
+mod env;
 
 pub use config::*;
+pub use env::*;

crates/cli/src/main.rs

@@ -67,6 +67,7 @@ async fn main() -> MainResult {
         Commands::Completions(args) => app.execute_with_args(commands::completions, args),
         Commands::Debug { command } => match command {
             DebugCommands::Config(args) => app.execute_with_args(commands::debug::config, args),
+            DebugCommands::Env => app.execute(commands::debug::env),
         },
         Commands::Install(args) => app.execute_with_args(commands::install, args),
         Commands::InstallGlobal(args) => app.execute_with_args(commands::install_global, args),