Merge #859

859: Add cargo-style output diagnostics. r=Emilgardis a=Alexhuszagh

Adds the quiet and color command-line flags, where color supports `auto`, always`, and `never`. These command-line flags are parsed to a verbosity which can be quiet, normal, or verbose.

With these, we then have the stderr message formatters:
- `fatal_usage`: print a fatal error message with the failing argument, and add a help context menu for how to use cross.
- `fatal`: print red 'error' message and exit with an error code
- `error`: print red 'error' message
- `warn`: print amber 'warning' message
- `note`: print cyan 'note' message
- `status`: print an uncolored and unprefixed 'status' message

We have the stdout message formatters:
- `print`: always print the message
- `info`: print the message as long as the verbosity is not quiet
- `debug`: only print the message if the output is not quiet

We also have a few specialized error handlers, and methods to help ensure we can have flexible error reporting in the future:
- `status_stderr`
- `status_stdout`

The command extensions now have, `print`, `info`, and `debug`, which formats the command and sends it to the shell. This allows us to avoid using `print_verbose` where we sometimes manually override the default setting.

A few of these settings aren't currently used (such as `info` and `status`, but they're a very common pattern), so we can ensure we have the necessary utilities to ensure we can properly format messages in the future. A few like `shell::print` are practically identical to `println!`, but this allows us to customize it if need be in the future.

Solves parts of #797.

Co-authored-by: Alex Huszagh <[email protected]>

Author: bors[bot]

CHANGELOG.md

@@ -10,6 +10,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Changed
 
 - #869 - ensure cargo configuration environment variable flags are passed to the docker container.
+- #859 - added color diagnostic output and error messages.
 
 ### Fixed
 

Cargo.lock

@@ -47,6 +47,7 @@ ctrlc = { version = "3.2.2", features = ["termination"] }
 directories = "4.0.1"
 walkdir = { version = "2", optional = true }
 tempfile = "3.3.0"
+owo-colors = { version = "3.4.0", features = ["supports-colors"] }
 
 [target.'cfg(not(windows))'.dependencies]
 nix = { version = "0.24", default-features = false, features = ["user"] }

Cargo.toml

@@ -24,11 +24,22 @@ unknown-git = "deny"
 allow-git = []
 
 [licenses]
+# need this since to suppress errors in case we add crates with these allowed licenses
+unused-allowed-license = "allow"
 unlicensed = "deny"
 allow-osi-fsf-free = "neither"
 copyleft = "deny"
 confidence-threshold = 0.93
-allow = ["Apache-2.0", "MIT", "CC0-1.0"]
+allow = [
+  "Apache-2.0",
+  "MIT",
+  "CC0-1.0",
+  "ISC",
+  "0BSD",
+  "BSD-2-Clause",
+  "BSD-3-Clause",
+  "Unlicense"
+]
 
 [licenses.private]
 ignore = true

deny.toml

@@ -3,12 +3,19 @@ use std::fs;
 use super::containers::*;
 use super::images::*;
 use clap::Args;
+use cross::shell::{self, MessageInfo};
 
 #[derive(Args, Debug)]
 pub struct Clean {
     /// Provide verbose diagnostic output.
     #[clap(short, long)]
     pub verbose: bool,
+    /// Do not print cross log messages.
+    #[clap(short, long)]
+    pub quiet: bool,
+    /// Whether messages should use color output.
+    #[clap(long)]
+    pub color: Option<String>,
     /// Force removal of images.
     #[clap(short, long)]
     pub force: bool,
@@ -25,22 +32,28 @@ pub struct Clean {
 
 impl Clean {
     pub fn run(self, engine: cross::docker::Engine) -> cross::Result<()> {
+        let msg_info = MessageInfo::create(self.verbose, self.quiet, self.color.as_deref())?;
         let tempdir = cross::temp::dir()?;
         match self.execute {
             true => {
                 if tempdir.exists() {
                     fs::remove_dir_all(tempdir)?;
                 }
             }
-            false => println!(
-                "fs::remove_dir_all({})",
-                cross::pretty_path(&tempdir, |_| false)
-            ),
+            false => shell::print(
+                format!(
+                    "fs::remove_dir_all({})",
+                    cross::pretty_path(&tempdir, |_| false)
+                ),
+                msg_info,
+            )?,
         }
 
         // containers -> images -> volumes -> prune to ensure no conflicts.
         let remove_containers = RemoveAllContainers {
             verbose: self.verbose,
+            quiet: self.quiet,
+            color: self.color.clone(),
             force: self.force,
             execute: self.execute,
             engine: None,
@@ -50,6 +63,8 @@ impl Clean {
         let remove_images = RemoveImages {
             targets: vec![],
             verbose: self.verbose,
+            quiet: self.quiet,
+            color: self.color.clone(),
             force: self.force,
             local: self.local,
             execute: self.execute,
@@ -59,6 +74,8 @@ impl Clean {
 
         let remove_volumes = RemoveAllVolumes {
             verbose: self.verbose,
+            quiet: self.quiet,
+            color: self.color.clone(),
             force: self.force,
             execute: self.execute,
             engine: None,
@@ -67,6 +84,8 @@ impl Clean {
 
         let prune_volumes = PruneVolumes {
             verbose: self.verbose,
+            quiet: self.quiet,
+            color: self.color.clone(),
             execute: self.execute,
             engine: None,
         };