feat: Add get_shim_paths

README.md

@@ -99,11 +99,16 @@ cached which are configured in `Cargo.toml`.
 `run-bin` can also be used as a library and paired nicely with your `build.rs` or any other scripts. The following
 example demos having `dprint` configured within `[package.metadata.bin]`, and executing `dprint --help`.
 
+```toml
+[package.metadata.bin]
+dprint = { version = "0.40.2" }
+```
+
 ```rust
 use anyhow::Result;
 use cargo_run_bin::{binary, metadata};
 
-fn run_dprint() -> Result<()> {
+fn main() -> Result<()> {
     let binary_package = metadata::get_binary_packages()?
         .iter()
         .find(|e| e.package == "dprint")
@@ -116,6 +121,34 @@ fn run_dprint() -> Result<()> {
 }
 ```
 
+Using `binary::run` is optional. You can recreate it and make changes to your liking using `std::process`, with shims included!
+
+```rust
+use std::process;
+
+use anyhow::Result;
+use cargo_run_bin::{binary, metadata, shims};
+
+fn main() -> Result<()> {
+    let binary_package = metadata::get_binary_packages()?
+        .iter()
+        .find(|e| e.package == "dprint")
+        .unwrap()
+        .to_owned();
+    let bin_path = binary::install(binary_package)?;
+
+    let mut shell_paths = shims::get_shim_paths()?;
+    shell_paths.push(env::var("PATH").unwrap_or("".to_string()));
+
+    process::Command::new(bin_path)
+        .args(["--help"])
+        .env("PATH", shell_paths.join(":"))
+        .spawn();
+
+    return Ok(());
+}
+```
+
 ## [License](./LICENSE)
 
 MIT.

src/binary.rs

@@ -13,6 +13,7 @@ use which::which;
 
 use crate::cargo_config;
 use crate::metadata;
+use crate::shims;
 
 /// INTERNAL: Install binary with cargo install.
 pub fn cargo_install(
@@ -174,30 +175,8 @@ pub fn run(bin_path: String, args: Vec<String>) -> Result<()> {
         final_args.append(&mut args.clone());
     }
 
-    let mut system_shell_paths = env::var("PATH")
-        .unwrap_or("".to_string())
-        .split(':')
-        .map(|e| return e.to_string())
-        .collect::<Vec<String>>();
-
-    let project_root = metadata::get_project_root()?;
-    let mut shell_paths = vec![];
-
-    let runbin = project_root
-        .join(".bin/.shims")
-        .to_string_lossy()
-        .to_string();
-    if !system_shell_paths.contains(&runbin) {
-        shell_paths.push(runbin);
-    }
-
-    // https://github.com/dustinblackman/cargo-gha
-    let gha = project_root.join(".gha/.shims");
-    if gha.exists() && !system_shell_paths.contains(&gha.to_string_lossy().to_string()) {
-        shell_paths.push(gha.to_string_lossy().to_string());
-    }
-
-    shell_paths.append(&mut system_shell_paths);
+    let mut shell_paths = shims::get_shim_paths()?;
+    shell_paths.push(env::var("PATH").unwrap_or("".to_string()));
 
     let spawn = process::Command::new(bin_path.clone())
         .stdout(process::Stdio::inherit())

src/lib.rs

@@ -16,11 +16,16 @@
 //! `build.rs` or any other scripts. The following example demos having `dprint`
 //! configured within `[package.metadata.bin]`, and executing `dprint --help`.
 //!
+//! ```toml
+//! [package.metadata.bin]
+//! dprint = { version = "0.40.2" }
+//! ```
+//!
 //! ```rust
 //! use anyhow::Result;
 //! use cargo_run_bin::{binary, metadata};
 //!
-//! fn run_dprint() -> Result<()> {
+//! fn main() -> Result<()> {
 //!     let binary_package = metadata::get_binary_packages()?
 //!         .iter()
 //!         .find(|e| e.package == "dprint")
@@ -32,6 +37,35 @@
 //!     return Ok(());
 //! }
 //! ```
+//!
+//! Using `binary::run` is optional. You can recreate it and make changes to
+//! your liking using `std::process`, with shims included!
+//!
+//! ```rust
+//! use std::process;
+//!
+//! use anyhow::Result;
+//! use cargo_run_bin::{binary, metadata, shims};
+//!
+//! fn main() -> Result<()> {
+//!     let binary_package = metadata::get_binary_packages()?
+//!         .iter()
+//!         .find(|e| e.package == "dprint")
+//!         .unwrap()
+//!         .to_owned();
+//!     let bin_path = binary::install(binary_package)?;
+//!
+//!     let mut shell_paths = shims::get_shim_paths()?;
+//!     shell_paths.push(env::var("PATH").unwrap_or("".to_string()));
+//!
+//!     process::Command::new(bin_path)
+//!         .args(["--help"])
+//!         .env("PATH", shell_paths.join(":"))
+//!         .spawn();
+//!
+//!     return Ok(());
+//! }
+//! ```
 
 #![deny(clippy::implicit_return)]
 #![allow(clippy::needless_return)]

src/shims.rs

@@ -93,3 +93,32 @@ pub fn sync() -> Result<()> {
 
     return Ok(());
 }
+
+/// Return an array of entries that can be added to PATH to provide shims to
+/// other configured run-bin packages. Results be empty if entries already exist
+/// in PATH.
+pub fn get_shim_paths() -> Result<Vec<String>> {
+    let mut shim_paths = vec![];
+    let system_shell_paths = env::var("PATH")
+        .unwrap_or("".to_string())
+        .split(':')
+        .map(|e| return e.to_string())
+        .collect::<Vec<String>>();
+
+    let project_root = metadata::get_project_root()?;
+    let runbin = project_root
+        .join(".bin/.shims")
+        .to_string_lossy()
+        .to_string();
+
+    if !system_shell_paths.contains(&runbin) {
+        shim_paths.push(runbin);
+    }
+
+    let gha = project_root.join(".gha/.shims");
+    if gha.exists() && !system_shell_paths.contains(&gha.to_string_lossy().to_string()) {
+        shim_paths.push(gha.to_string_lossy().to_string());
+    }
+
+    return Ok(shim_paths);
+}