refactor: Switch to using miette for errors instead of anyhow (#198)

Switch to a better error crate that will allow setting help texts for
any error we want.

Cargo.toml

@@ -10,7 +10,6 @@ categories = ["command-line-utilities"]
 version = "0.8.11"
 
 [workspace.dependencies]
-anyhow = "1"
 chrono = "0.4"
 clap = "4"
 colored = "2"
@@ -19,6 +18,7 @@ indexmap = { version = "2", features = ["serde"] }
 indicatif = { version = "0.17", features = ["improved_unicode"] }
 indicatif-log-bridge = "0.2"
 log = "0.4"
+miette = "7"
 once_cell = "1"
 serde = { version = "1", features = ["derive"] }
 serde_json = "1"
@@ -73,14 +73,13 @@ shadow-rs = "0.26"
 urlencoding = "2"
 users = "0.11"
 
-# Workspace dependencies
-anyhow.workspace = true
 chrono.workspace = true
 clap = { workspace = true, features = ["derive", "cargo", "unicode", "env"] }
 colored.workspace = true
 indexmap.workspace = true
 indicatif.workspace = true
 log.workspace = true
+miette = { workspace = true, features = ["fancy"] }
 once_cell.workspace = true
 serde.workspace = true
 serde_json.workspace = true

recipe/Cargo.toml

@@ -11,10 +11,10 @@ license.workspace = true
 [dependencies]
 blue-build-utils = { version = "=0.8.11", path = "../utils" }
 
-anyhow.workspace = true
 chrono.workspace = true
 colored.workspace = true
 log.workspace = true
+miette.workspace = true
 indexmap.workspace = true
 serde.workspace = true
 serde_yaml.workspace = true

recipe/src/module.rs

@@ -1,10 +1,10 @@
 use std::{borrow::Cow, path::PathBuf, process};
 
-use anyhow::{bail, Result};
 use blue_build_utils::syntax_highlighting::highlight_ser;
 use colored::Colorize;
 use indexmap::IndexMap;
 use log::{error, trace, warn};
+use miette::{bail, Result};
 use serde::{Deserialize, Serialize};
 use serde_yaml::Value;
 use typed_builder::TypedBuilder;

recipe/src/module_ext.rs

@@ -1,8 +1,8 @@
 use std::{borrow::Cow, collections::HashSet, fs, path::Path};
 
-use anyhow::{Context, Result};
 use blue_build_utils::constants::{CONFIG_PATH, RECIPE_PATH};
 use log::{trace, warn};
+use miette::{Context, IntoDiagnostic, Result};
 use serde::{Deserialize, Serialize};
 use typed_builder::TypedBuilder;
 
@@ -32,12 +32,14 @@ impl ModuleExt<'_> {
         };
 
         let file = fs::read_to_string(&file_path)
-            .context(format!("Failed to open {}", file_path.display()))?;
+            .into_diagnostic()
+            .with_context(|| format!("Failed to open {}", file_path.display()))?;
 
         serde_yaml::from_str::<Self>(&file).map_or_else(
             |_| -> Result<Self> {
                 let module = serde_yaml::from_str::<Module>(&file)
-                    .map_err(blue_build_utils::serde_yaml_err(&file))?;
+                    .map_err(blue_build_utils::serde_yaml_err(&file))
+                    .into_diagnostic()?;
                 Ok(Self::builder().modules(vec![module]).build())
             },
             Ok,

recipe/src/recipe.rs

@@ -1,13 +1,13 @@
 use std::{borrow::Cow, env, fs, path::Path};
 
-use anyhow::{Context, Result};
 use blue_build_utils::constants::{
     CI_COMMIT_REF_NAME, CI_COMMIT_SHORT_SHA, CI_DEFAULT_BRANCH, CI_MERGE_REQUEST_IID,
     CI_PIPELINE_SOURCE, GITHUB_EVENT_NAME, GITHUB_REF_NAME, GITHUB_SHA, PR_EVENT_NUMBER,
 };
 use chrono::Local;
 use indexmap::IndexMap;
 use log::{debug, trace, warn};
+use miette::{Context, IntoDiagnostic, Result};
 use serde::{Deserialize, Serialize};
 use serde_yaml::Value;
 use typed_builder::TypedBuilder;
@@ -204,16 +204,20 @@ impl<'a> Recipe<'a> {
         let file_path = if Path::new(path.as_ref()).is_absolute() {
             path.as_ref().to_path_buf()
         } else {
-            std::env::current_dir()?.join(path.as_ref())
+            std::env::current_dir()
+                .into_diagnostic()?
+                .join(path.as_ref())
         };
 
         let file = fs::read_to_string(&file_path)
-            .context(format!("Failed to read {}", file_path.display()))?;
+            .into_diagnostic()
+            .with_context(|| format!("Failed to read {}", file_path.display()))?;
 
         debug!("Recipe contents: {file}");
 
         let mut recipe = serde_yaml::from_str::<Recipe>(&file)
-            .map_err(blue_build_utils::serde_yaml_err(&file))?;
+            .map_err(blue_build_utils::serde_yaml_err(&file))
+            .into_diagnostic()?;
 
         recipe.modules_ext.modules = Module::get_modules(&recipe.modules_ext.modules, None)?.into();
 

recipe/src/stage.rs

@@ -1,8 +1,8 @@
 use std::{borrow::Cow, path::PathBuf};
 
-use anyhow::{bail, Result};
 use blue_build_utils::syntax_highlighting::highlight_ser;
 use colored::Colorize;
+use miette::{bail, Result};
 use serde::{Deserialize, Serialize};
 use typed_builder::TypedBuilder;