Better error for missing install (#51)

Better elaboration for a common error where a foreman-managed tool is being used outside of a scope in which it's been defined as a tool dependency.

Additionally, this tees up a 1.0.4 release.

Author: ZoteTheMighty

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Foreman Changelog
 
-## Unreleased Changes
+## 1.0.4 (2022-05-13)
+
+- Introduce improved error output on using uninstalled tools ([#51](https://github.com/Roblox/foreman/pull/51))
 - Add support for Apple Silicon (arm64) binaries ([#46](https://github.com/Roblox/foreman/pull/46))
 
 ## 1.0.3 (2022-02-04)

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "foreman"
 description = "Toolchain manager for simple binary tools"
-version = "1.0.3"
+version = "1.0.4"
 authors = [
   "Lucien Greathouse <[email protected]>",
   "Matt Hargett <[email protected]>",

Cargo.toml

@@ -131,6 +131,16 @@ impl ConfigFile {
     }
 }
 
+impl fmt::Display for ConfigFile {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        writeln!(f, "Available Tools:")?;
+        for (name, spec) in self.tools.iter() {
+            writeln!(f, "\t {} => {}", name, spec)?;
+        }
+        Ok(())
+    }
+}
+
 #[cfg(test)]
 mod test {
     use super::*;

src/config.rs

@@ -2,7 +2,7 @@ use std::{fmt, io, path::PathBuf};
 
 use semver::Version;
 
-use crate::config::ToolSpec;
+use crate::config::{ConfigFile, ToolSpec};
 
 pub type ForemanResult<T> = Result<T, ForemanError>;
 
@@ -63,6 +63,11 @@ pub enum ForemanError {
         version: Version,
         message: String,
     },
+    ToolNotInstalled {
+        name: String,
+        current_path: PathBuf,
+        config_file: ConfigFile,
+    },
 }
 
 impl ForemanError {
@@ -283,6 +288,20 @@ impl fmt::Display for ForemanError {
                 version,
                 message
             ),
+            Self::ToolNotInstalled {
+                name,
+                current_path,
+                config_file,
+            } => write!(
+                f,
+                "'{}' is not a known Foreman tool, but Foreman was invoked \
+                with its name.\n\nTo use this tool from {}, declare it in a \
+                'foreman.toml' file in the current directory or a parent \
+                directory.\n\n{}",
+                name,
+                current_path.display(),
+                config_file,
+            ),
         }
     }
 }

src/error.rs

@@ -72,13 +72,17 @@ impl ToolInvocation {
 
             Ok(())
         } else {
-            eprintln!(
-                "'{}' is not a known Foreman tool, but Foreman was invoked with its name.",
-                self.name
-            );
-            eprintln!("You may not have this tool installed here, or your install may be broken.");
-
-            Ok(())
+            let current_dir = env::current_dir().map_err(|err| {
+                ForemanError::io_error_with_context(
+                    err,
+                    "unable to obtain the current working directory",
+                )
+            })?;
+            Err(ForemanError::ToolNotInstalled {
+                name: self.name,
+                current_path: current_dir,
+                config_file: config,
+            })
         }
     }
 }

src/main.rs

@@ -1,10 +1,8 @@
 ---
 source: tests/cli.rs
-assertion_line: 93
 expression: content
-
 ---
-foreman 1.0.3
+foreman 1.0.4
 
 USAGE:
     foreman [FLAGS] <SUBCOMMAND>