Consolidate warnings, suppression and deduplication

Cargo.toml

@@ -38,6 +38,9 @@ glob = "0.3"
 walkdir = "2"
 subst = "0.3"
 tera = "1.19"
+miette = "7.6.0"
+thiserror = "2.0.17"
+owo-colors = "4.2.3"
 
 [target.'cfg(windows)'.dependencies]
 dunce = "1.0.4"

src/cli.rs

@@ -4,6 +4,7 @@
 //! Main command line tool implementation.
 
 use std;
+use std::collections::HashSet;
 use std::path::{Path, PathBuf};
 use std::process::Command as SysCommand;
 
@@ -22,6 +23,7 @@ use tokio::runtime::Runtime;
 use crate::cmd;
 use crate::cmd::fusesoc::FusesocArgs;
 use crate::config::{Config, Manifest, Merge, PartialConfig, PrefixPaths, Validate};
+use crate::diagnostic::{Diagnostics, Warnings};
 use crate::error::*;
 use crate::lockfile::*;
 use crate::sess::{Session, SessionArenas, SessionIo};
@@ -113,8 +115,9 @@ pub fn main() -> Result<()> {
     // Parse command line arguments.
     let cli = Cli::parse();
 
-    let mut suppressed_warnings: IndexSet<String> =
+    let mut suppressed_warnings: HashSet<String> =
         cli.suppress.into_iter().map(|s| s.to_owned()).collect();
+
     // split suppress strings on commas and spaces
     suppressed_warnings = suppressed_warnings
         .into_iter()
@@ -125,9 +128,8 @@ pub fn main() -> Result<()> {
         })
         .collect();
 
-    if suppressed_warnings.contains("all") || suppressed_warnings.contains("Wall") {
-        suppressed_warnings.extend((1..24).map(|i| format!("W{:02}", i)));
-    }
+    // Initialize warning and error handling with the suppression arguments.
+    Diagnostics::init(suppressed_warnings);
 
     #[cfg(debug_assertions)]
     if cli.debug {
@@ -147,7 +149,7 @@ pub fn main() -> Result<()> {
     }
 
     let force_fetch = match cli.command {
-        Commands::Update(ref args) => cmd::update::setup(args, cli.local, &suppressed_warnings)?,
+        Commands::Update(ref args) => cmd::update::setup(args, cli.local)?,
         _ => false,
     };
 
@@ -165,15 +167,11 @@ pub fn main() -> Result<()> {
 
     // Parse the manifest file of the package.
     let manifest_path = root_dir.join("Bender.yml");
-    let manifest = read_manifest(&manifest_path, &suppressed_warnings)?;
+    let manifest = read_manifest(&manifest_path)?;
     debugln!("main: {:#?}", manifest);
 
     // Gather and parse the tool configuration.
-    let config = load_config(
-        &root_dir,
-        matches!(cli.command, Commands::Update(_)) && !suppressed_warnings.contains("W02"),
-        &suppressed_warnings,
-    )?;
+    let config = load_config(&root_dir, matches!(cli.command, Commands::Update(_)))?;
     debugln!("main: {:#?}", config);
 
     // Determine git throttle. The precedence is: CLI argument, env variable, config file, default (4).
@@ -189,7 +187,6 @@ pub fn main() -> Result<()> {
         cli.local,
         force_fetch,
         git_throttle,
-        suppressed_warnings,
     );
 
     if let Commands::Clean(args) = cli.command {
@@ -252,13 +249,7 @@ pub fn main() -> Result<()> {
                     )
                 })?;
                 if !meta.file_type().is_symlink() {
-                    if !sess.suppress_warnings.contains("W01") {
-                        warnln!(
-                            "[W01] Skipping link to package {} at {:?} since there is something there",
-                            pkg_name,
-                            path
-                        );
-                    }
+                    Warnings::SkippingPackageLink(pkg_name.clone(), path.clone()).emit();
                     continue;
                 }
                 if path.read_link().map(|d| d != pkg_path).unwrap_or(true) {
@@ -398,7 +389,7 @@ fn find_package_root(from: &Path) -> Result<PathBuf> {
 }
 
 /// Read a package manifest from a file.
-pub fn read_manifest(path: &Path, suppress_warnings: &IndexSet<String>) -> Result<Manifest> {
+pub fn read_manifest(path: &Path) -> Result<Manifest> {
     use crate::config::PartialManifest;
     use std::fs::File;
     debugln!("read_manifest: {:?}", path);
@@ -409,16 +400,12 @@ pub fn read_manifest(path: &Path, suppress_warnings: &IndexSet<String>) -> Resul
     partial
         .prefix_paths(path.parent().unwrap())
         .map_err(|cause| Error::chain(format!("Error in manifest prefixing {:?}.", path), cause))?
-        .validate("", false, suppress_warnings)
+        .validate("", false)
         .map_err(|cause| Error::chain(format!("Error in manifest {:?}.", path), cause))
 }
 
 /// Load a configuration by traversing a directory hierarchy upwards.
-fn load_config(
-    from: &Path,
-    warn_config_loaded: bool,
-    suppress_warnings: &IndexSet<String>,
-) -> Result<Config> {
+fn load_config(from: &Path, warn_config_loaded: bool) -> Result<Config> {
     #[cfg(unix)]
     use std::os::unix::fs::MetadataExt;
 
@@ -491,7 +478,7 @@ fn load_config(
 
     // Validate the configuration.
     let mut out = out
-        .validate("", false, suppress_warnings)
+        .validate("", false)
         .map_err(|cause| Error::chain("Invalid configuration:", cause))?;
 
     out.overrides = out
@@ -515,8 +502,11 @@ fn maybe_load_config(path: &Path, warn_config_loaded: bool) -> Result<Option<Par
     let partial: PartialConfig = serde_yaml_ng::from_reader(file)
         .map_err(|cause| Error::chain(format!("Syntax error in config {:?}.", path), cause))?;
     if warn_config_loaded {
-        warnln!("[W02] Using config at {:?} for overrides.", path)
-    };
+        Warnings::UsingConfigForOverride {
+            path: path.to_path_buf(),
+        }
+        .emit();
+    }
     Ok(Some(partial.prefix_paths(path.parent().unwrap())?))
 }
 

src/cmd/clone.rs

@@ -12,6 +12,7 @@ use tokio::runtime::Runtime;
 
 use crate::config;
 use crate::config::{Locked, LockedSource};
+use crate::diagnostic::Warnings;
 use crate::error::*;
 use crate::sess::{DependencyRef, DependencySource, Session, SessionIo};
 
@@ -138,8 +139,8 @@ pub fn run(sess: &Session, path: &Path, args: &CloneArgs) -> Result<()> {
             {
                 Err(Error::new("git fetch failed".to_string()))?;
             }
-        } else if !sess.suppress_warnings.contains("W14") {
-            warnln!("[W14] fetch not performed due to --local argument.");
+        } else {
+            Warnings::LocalNoFetch.emit();
         }
 
         eprintln!(
@@ -263,11 +264,7 @@ pub fn run(sess: &Session, path: &Path, args: &CloneArgs) -> Result<()> {
                     )
                 })?;
                 if !meta.file_type().is_symlink() {
-                    warnln!(
-                        "[W15] Skipping link to package {} at {:?} since there is something there",
-                        pkg_name,
-                        link_path
-                    );
+                    Warnings::SkippingPackageLink(pkg_name.clone(), link_path.to_path_buf()).emit();
                     continue;
                 }
                 if link_path.read_link().map(|d| d != pkg_path).unwrap_or(true) {

src/cmd/fusesoc.rs

@@ -18,6 +18,7 @@ use itertools::Itertools;
 use tokio::runtime::Runtime;
 use walkdir::{DirEntry, WalkDir};
 
+use crate::diagnostic::Warnings;
 use crate::error::*;
 use crate::sess::{Session, SessionIo};
 use crate::src::{SourceFile, SourceGroup};
@@ -132,8 +133,8 @@ pub fn run_single(sess: &Session, args: &FusesocArgs) -> Result<()> {
         Error::chain(format!("Unable to write corefile for {:?}.", &name), cause)
     })?;
 
-    if fuse_depend_string.len() > 1 && !sess.suppress_warnings.contains("W16") {
-        warnln!("[W16] Depend strings may be wrong for the included dependencies!");
+    if fuse_depend_string.len() > 1 {
+        Warnings::DependStringMaybeWrong.emit();
     }
 
     Ok(())

src/cmd/parents.rs

@@ -5,6 +5,7 @@
 
 use std::io::Write;
 
+use crate::diagnostic::Warnings;
 use clap::Args;
 use indexmap::IndexMap;
 use tabwriter::TabWriter;
@@ -14,6 +15,7 @@ use crate::config::Dependency;
 use crate::error::*;
 use crate::sess::{DependencyConstraint, DependencySource};
 use crate::sess::{Session, SessionIo};
+use crate::{fmt_path, fmt_version};
 
 /// List packages calling this dependency
 #[derive(Args, Debug)]
@@ -96,12 +98,25 @@ pub fn run(sess: &Session, args: &ParentsArgs) -> Result<()> {
         }
     );
 
-    if sess.config.overrides.contains_key(dep) && !sess.suppress_warnings.contains("W18") {
-        warnln!(
-            "[W18] An override is configured for {} to {:?}",
-            dep,
-            sess.config.overrides[dep]
-        )
+    if sess.config.overrides.contains_key(dep) {
+        Warnings::DepOverride {
+            pkg: dep.to_string(),
+            pkg_override: match sess.config.overrides[dep] {
+                Dependency::Version(ref v, _) => format!("version {}", fmt_version!(v)),
+                Dependency::Path(ref path, _) => format!("path {}", fmt_path!(path.display())),
+                Dependency::GitRevision(ref url, ref rev, _) => {
+                    format!("git {} at revision {}", fmt_path!(url), fmt_version!(rev))
+                }
+                Dependency::GitVersion(ref url, ref version, _) => {
+                    format!(
+                        "git {} with version {}",
+                        fmt_path!(url),
+                        fmt_version!(version)
+                    )
+                }
+            },
+        }
+        .emit();
     }
 
     Ok(())
@@ -150,9 +165,10 @@ pub fn get_parent_array(
                 let dep_manifest = rt.block_on(io.dependency_manifest(pkg, false, &[]))?;
                 // Filter out dependencies without a manifest
                 if dep_manifest.is_none() {
-                    if !sess.suppress_warnings.contains("W17") {
-                        warnln!("[W17] {} is shown to include dependency, but manifest does not have this information.", pkg_name.to_string());
+                    Warnings::IncludeDepManifestMismatch {
+                        pkg: pkg_name.to_string(),
                     }
+                    .emit();
                     continue;
                 }
                 let dep_manifest = dep_manifest.unwrap();
@@ -182,9 +198,11 @@ pub fn get_parent_array(
                             ],
                         );
                     }
-                } else if !sess.suppress_warnings.contains("W17") {
-                    // Filter out dependencies with mismatching manifest
-                    warnln!("[W17] {} is shown to include dependency, but manifest does not have this information.", pkg_name.to_string());
+                } else {
+                    Warnings::IncludeDepManifestMismatch {
+                        pkg: pkg_name.to_string(),
+                    }
+                    .emit();
                 }
             }
         }

src/cmd/script.rs

@@ -283,7 +283,7 @@ pub fn run(sess: &Session, args: &ScriptArgs) -> Result<()> {
     let srcs = srcs
         .flatten()
         .into_iter()
-        .map(|f| f.validate("", false, &sess.suppress_warnings))
+        .map(|f| f.validate("", false))
         .collect::<Result<Vec<_>>>()?;
 
     let mut tera_context = Context::new();

src/cmd/snapshot.rs

@@ -12,6 +12,7 @@ use tokio::runtime::Runtime;
 
 use crate::cmd::clone::{get_path_subdeps, symlink_dir};
 use crate::config::{Dependency, Locked, LockedSource};
+use crate::diagnostic::Warnings;
 use crate::error::*;
 use crate::sess::{DependencySource, Session, SessionIo};
 
@@ -57,11 +58,7 @@ pub fn run(sess: &Session, args: &SnapshotArgs) -> Result<()> {
                             .is_empty()
                             && !args.no_skip
                         {
-                            warnln!(
-                                "Skipping dirty dependency {}\
-                                        \t use `--no-skip` to still snapshot.",
-                                name
-                            );
+                            Warnings::SkippingDirtyDep { pkg: name.clone() }.emit();
                             continue;
                         }
 
@@ -255,11 +252,7 @@ pub fn run(sess: &Session, args: &SnapshotArgs) -> Result<()> {
                     )
                 })?;
                 if !meta.file_type().is_symlink() {
-                    warnln!(
-                        "[W15] Skipping link to package {} at {:?} since there is something there",
-                        pkg_name,
-                        link_path
-                    );
+                    Warnings::SkippingPackageLink(pkg_name.clone(), link_path.to_path_buf()).emit();
                     continue;
                 }
                 if link_path.read_link().map(|d| d != pkg_path).unwrap_or(true) {

src/cmd/sources.rs

@@ -99,7 +99,7 @@ pub fn run(sess: &Session, args: &SourcesArgs) -> Result<()> {
         srcs = srcs.filter_packages(packages).unwrap_or_default();
     }
 
-    srcs = srcs.validate("", false, &sess.suppress_warnings)?;
+    srcs = srcs.validate("", false)?;
 
     let result = {
         let stdout = std::io::stdout();

src/cmd/update.rs

@@ -12,6 +12,7 @@ use tabwriter::TabWriter;
 
 use crate::cmd;
 use crate::config::{Locked, LockedPackage};
+use crate::diagnostic::Warnings;
 use crate::error::*;
 use crate::lockfile::*;
 use crate::resolver::DependencyResolver;
@@ -42,11 +43,9 @@ pub struct UpdateArgs {
 }
 
 /// Execute the `update` subcommand.
-pub fn setup(args: &UpdateArgs, local: bool, suppress_warnings: &IndexSet<String>) -> Result<bool> {
-    if local && args.fetch && !suppress_warnings.contains("W14") {
-        warnln!(
-            "[W14] As --local argument is set for bender command, no fetching will be performed."
-        );
+pub fn setup(args: &UpdateArgs, local: bool) -> Result<bool> {
+    if local && args.fetch {
+        Warnings::LocalNoFetch.emit();
     }
     Ok(args.fetch)
 }