feat: add common::shell implementation

Cargo.toml

@@ -222,6 +222,11 @@ alloy-trie = "0.6.0"
 ## op-alloy for tests in anvil
 op-alloy-rpc-types = "0.2.9"
 
+## cli
+anstream = "0.6.15"
+anstyle = "1.0.8"
+terminal_size = "0.3.0"
+
 ## misc
 async-trait = "0.1"
 auto_impl = "1"

clippy.toml

@@ -2,3 +2,11 @@ msrv = "1.80"
 # bytes::Bytes is included by default and alloy_primitives::Bytes is a wrapper around it,
 # so it is safe to ignore it as well
 ignore-interior-mutability = ["bytes::Bytes", "alloy_primitives::Bytes"]
+
+# disallowed-macros = [
+#     # See `foundry_common::shell`
+#     { path = "std::print", reason = "use `sh_print` or similar macros instead" },
+#     { path = "std::eprint", reason = "use `sh_eprint` or similar macros instead" },
+#     { path = "std::println", reason = "use `sh_println` or similar macros instead" },
+#     { path = "std::eprintln", reason = "use `sh_eprintln` or similar macros instead" },
+# ]

crates/cast/bin/args.rs

@@ -8,7 +8,7 @@ use alloy_primitives::{Address, B256, U256};
 use alloy_rpc_types::BlockId;
 use clap::{Parser, Subcommand, ValueHint};
 use eyre::Result;
-use foundry_cli::opts::{EtherscanOpts, RpcOpts};
+use foundry_cli::opts::{EtherscanOpts, RpcOpts, ShellOpts};
 use foundry_common::ens::NameOrAddress;
 use std::{path::PathBuf, str::FromStr};
 
@@ -32,6 +32,8 @@ const VERSION_MESSAGE: &str = concat!(
 pub struct Cast {
     #[command(subcommand)]
     pub cmd: CastSubcommand,
+    #[clap(flatten)]
+    pub shell: ShellOpts,
 }
 
 #[derive(Subcommand)]

crates/cast/bin/main.rs

@@ -1,14 +1,11 @@
-#[macro_use]
-extern crate tracing;
-
 use alloy_primitives::{eip191_hash_message, hex, keccak256, Address, B256};
 use alloy_provider::Provider;
 use alloy_rpc_types::{BlockId, BlockNumberOrTag::Latest};
 use cast::{Cast, SimpleCast};
 use clap::{CommandFactory, Parser};
 use clap_complete::generate;
 use eyre::Result;
-use foundry_cli::{handler, prompt, stdin, utils};
+use foundry_cli::{handler, utils};
 use foundry_common::{
     abi::get_event,
     ens::{namehash, ProviderEnsExt},
@@ -19,10 +16,17 @@ use foundry_common::{
         import_selectors, parse_signatures, pretty_calldata, ParsedSignatures, SelectorImportData,
         SelectorType,
     },
+    stdin,
 };
 use foundry_config::Config;
 use std::time::Instant;
 
+#[macro_use]
+extern crate tracing;
+
+#[macro_use]
+extern crate foundry_common;
+
 pub mod args;
 pub mod cmd;
 pub mod tx;
@@ -33,12 +37,21 @@ use args::{Cast as CastArgs, CastSubcommand, ToBaseArgs};
 #[global_allocator]
 static ALLOC: tikv_jemallocator::Jemalloc = tikv_jemallocator::Jemalloc;
 
-fn main() -> Result<()> {
+#[tokio::main]
+async fn main() {
+    if let Err(err) = run().await {
+        let _ = foundry_common::Shell::get().error(&err);
+        std::process::exit(1);
+    }
+}
+
+async fn run() -> Result<()> {
     handler::install();
     utils::load_dotenv();
     utils::subscriber();
     utils::enable_paint();
     let args = CastArgs::parse();
+    args.shell.shell().set();
     main_args(args)
 }
 

crates/cli/src/lib.rs

@@ -10,5 +10,4 @@ extern crate tracing;
 
 pub mod handler;
 pub mod opts;
-pub mod stdin;
 pub mod utils;

crates/cli/src/opts/build/core.rs

@@ -105,11 +105,6 @@ pub struct CoreBuildArgs {
     #[serde(skip)]
     pub revert_strings: Option<RevertStrings>,
 
-    /// Don't print anything on startup.
-    #[arg(long, help_heading = "Compiler options")]
-    #[serde(skip)]
-    pub silent: bool,
-
     /// Generate build info files.
     #[arg(long, help_heading = "Project options")]
     #[serde(skip)]

crates/cli/src/opts/dependency.rs

@@ -2,7 +2,7 @@
 
 use eyre::Result;
 use regex::Regex;
-use std::{str::FromStr, sync::LazyLock};
+use std::{fmt, str::FromStr, sync::LazyLock};
 
 static GH_REPO_REGEX: LazyLock<Regex> = LazyLock::new(|| Regex::new(r"[\w-]+/[\w.-]+").unwrap());
 
@@ -46,6 +46,19 @@ pub struct Dependency {
     pub alias: Option<String>,
 }
 
+impl fmt::Display for Dependency {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        f.write_str(self.name())?;
+        if let Some(tag) = &self.tag {
+            write!(f, "{VERSION_SEPARATOR}{tag}")?;
+        }
+        if let Some(url) = &self.url {
+            write!(f, " ({url})")?;
+        }
+        Ok(())
+    }
+}
+
 impl FromStr for Dependency {
     type Err = eyre::Error;
     fn from_str(dependency: &str) -> Result<Self, Self::Err> {

crates/cli/src/opts/mod.rs

@@ -2,10 +2,12 @@ mod build;
 mod chain;
 mod dependency;
 mod ethereum;
+mod shell;
 mod transaction;
 
 pub use build::*;
 pub use chain::*;
 pub use dependency::*;
 pub use ethereum::*;
+pub use shell::*;
 pub use transaction::*;

crates/cli/src/opts/shell.rs

@@ -0,0 +1,32 @@
+use clap::Parser;
+use foundry_common::shell::{ColorChoice, Shell, Verbosity};
+
+// note: `verbose` and `quiet` cannot have `short` because of conflicts with multiple commands.
+
+/// Global shell options.
+#[derive(Clone, Copy, Debug, Parser)]
+pub struct ShellOpts {
+    /// Use verbose output.
+    #[clap(long, global = true, conflicts_with = "quiet")]
+    pub verbose: bool,
+
+    /// Do not print log messages.
+    #[clap(long, global = true, alias = "silent", conflicts_with = "verbose")]
+    pub quiet: bool,
+
+    /// Log messages coloring.
+    #[clap(long, global = true, value_enum)]
+    pub color: Option<ColorChoice>,
+}
+
+impl ShellOpts {
+    pub fn shell(self) -> Shell {
+        let verbosity = match (self.verbose, self.quiet) {
+            (true, false) => Verbosity::Verbose,
+            (false, true) => Verbosity::Quiet,
+            (false, false) => Verbosity::Normal,
+            (true, true) => unreachable!(),
+        };
+        Shell::new_with(self.color.unwrap_or_default(), verbosity)
+    }
+}

crates/cli/src/utils/mod.rs

@@ -161,23 +161,6 @@ pub fn block_on<F: Future>(future: F) -> F::Output {
     rt.block_on(future)
 }
 
-/// Conditionally print a message
-///
-/// This macro accepts a predicate and the message to print if the predicate is true
-///
-/// ```ignore
-/// let quiet = true;
-/// p_println!(!quiet => "message");
-/// ```
-#[macro_export]
-macro_rules! p_println {
-    ($p:expr => $($arg:tt)*) => {{
-        if $p {
-            println!($($arg)*)
-        }
-    }}
-}
-
 /// Loads a dotenv file, from the cwd and the project root, ignoring potential failure.
 ///
 /// We could use `warn!` here, but that would imply that the dotenv file can't configure

crates/common/Cargo.toml

@@ -63,6 +63,10 @@ url.workspace = true
 walkdir.workspace = true
 yansi.workspace = true
 
+anstream.workspace = true
+anstyle.workspace = true
+terminal_size.workspace = true
+
 [dev-dependencies]
 foundry-macros.workspace = true
 similar-asserts.workspace = true

crates/common/src/compile.rs

@@ -63,7 +63,7 @@ impl ProjectCompiler {
             verify: None,
             print_names: None,
             print_sizes: None,
-            quiet: Some(crate::shell::verbosity().is_silent()),
+            quiet: Some(crate::shell::verbosity().is_quiet()),
             bail: None,
             files: Vec::new(),
         }