feat: rename ShellOtps to GlobalOpts (foundry-rs#9313)

* rename ShellOpts to GlobalOpts

* prefer arg / command over clap

* add global opts

* remove redundant GlobalOpts injection, only use where access to the global variables is required

* add global thread pool

* add try_jobs method for global rayon pool

* limit unnecessary globalopts injection where shell::* is preferred

* fix tests

* port custom threads iterator to use global rayon thread pool

* remove redundant ignores

* remove leftover from merge conflict, fix clashing args with inlined global in nodeargs / anvil top level args

* leftovers

* add back global args in script args

* fix unused global opts

* ignore attempted multiple initializations of the global thread pool

* add init, default spawn with default rayon settings on forge test

* make test thread number configurable

* add back max threads back test to reduce pressure

* remove global --jobs rayon pool, revert to current implementation

* fix import

Author: zerosnacks

crates/anvil/src/anvil.rs

@@ -3,7 +3,7 @@
 use anvil::cmd::NodeArgs;
 use clap::{CommandFactory, Parser, Subcommand};
 use eyre::Result;
-use foundry_cli::{opts::ShellOpts, utils};
+use foundry_cli::{opts::GlobalOpts, utils};
 
 #[cfg(all(feature = "jemalloc", unix))]
 #[global_allocator]
@@ -13,14 +13,15 @@ static ALLOC: tikv_jemallocator::Jemalloc = tikv_jemallocator::Jemalloc;
 #[derive(Parser)]
 #[command(name = "anvil", version = anvil::VERSION_MESSAGE, next_display_order = None)]
 pub struct Anvil {
+    /// Include the global options.
+    #[command(flatten)]
+    pub global: GlobalOpts,
+
     #[command(flatten)]
     pub node: NodeArgs,
 
     #[command(subcommand)]
     pub cmd: Option<AnvilSubcommand>,
-
-    #[clap(flatten)]
-    pub shell: ShellOpts,
 }
 
 #[derive(Subcommand)]
@@ -48,7 +49,7 @@ fn run() -> Result<()> {
     utils::load_dotenv();
 
     let mut args = Anvil::parse();
-    args.shell.shell().set();
+    args.global.init()?;
     args.node.evm_opts.resolve_rpc_alias();
 
     if let Some(cmd) = &args.cmd {

crates/cast/bin/args.rs

@@ -9,7 +9,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, ShellOpts};
+use foundry_cli::opts::{EtherscanOpts, GlobalOpts, RpcOpts};
 use foundry_common::ens::NameOrAddress;
 use std::{path::PathBuf, str::FromStr};
 
@@ -31,11 +31,12 @@ const VERSION_MESSAGE: &str = concat!(
     next_display_order = None,
 )]
 pub struct Cast {
+    /// Include the global options.
+    #[command(flatten)]
+    pub global: GlobalOpts,
+
     #[command(subcommand)]
     pub cmd: CastSubcommand,
-
-    #[clap(flatten)]
-    pub shell: ShellOpts,
 }
 
 #[derive(Subcommand)]

crates/cast/bin/main.rs

@@ -50,8 +50,9 @@ fn run() -> Result<()> {
     utils::load_dotenv();
     utils::subscriber();
     utils::enable_paint();
+
     let args = CastArgs::parse();
-    args.shell.shell().set();
+    args.global.init()?;
     main_args(args)
 }
 

crates/chisel/bin/main.rs

@@ -11,7 +11,7 @@ use clap::{Parser, Subcommand};
 use eyre::Context;
 use foundry_cli::{
     handler,
-    opts::{CoreBuildArgs, ShellOpts},
+    opts::{CoreBuildArgs, GlobalOpts},
     utils::{self, LoadConfig},
 };
 use foundry_common::{evm::EvmArgs, fs};
@@ -50,12 +50,13 @@ const VERSION_MESSAGE: &str = concat!(
 #[derive(Debug, Parser)]
 #[command(name = "chisel", version = VERSION_MESSAGE)]
 pub struct Chisel {
+    /// Include the global options.
+    #[command(flatten)]
+    pub global: GlobalOpts,
+
     #[command(subcommand)]
     pub cmd: Option<ChiselSubcommand>,
 
-    #[clap(flatten)]
-    pub shell: ShellOpts,
-
     /// Path to a directory containing Solidity files to import, or path to a single Solidity file.
     ///
     /// These files will be evaluated before the top-level of the
@@ -117,8 +118,9 @@ fn run() -> eyre::Result<()> {
     handler::install();
     utils::subscriber();
     utils::load_dotenv();
+
     let args = Chisel::parse();
-    args.shell.shell().set();
+    args.global.init()?;
     main_args(args)
 }
 

crates/cli/src/opts/shell.rs renamed to crates/cli/src/opts/global.rs

@@ -1,11 +1,10 @@
 use clap::{ArgAction, Parser};
 use foundry_common::shell::{ColorChoice, OutputFormat, OutputMode, Shell, Verbosity};
+use serde::{Deserialize, Serialize};
 
-// note: `verbose` and `quiet` cannot have `short` because of conflicts with multiple commands.
-
-/// Global shell options.
-#[derive(Clone, Copy, Debug, Default, Parser)]
-pub struct ShellOpts {
+/// Global options.
+#[derive(Clone, Copy, Debug, Default, Serialize, Deserialize, Parser)]
+pub struct GlobalOpts {
     /// Verbosity level of the log messages.
     ///
     /// Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv).
@@ -22,7 +21,7 @@ pub struct ShellOpts {
 
     /// Do not print log messages.
     #[clap(short, long, global = true, alias = "silent", help_heading = "Display options")]
-    pub quiet: bool,
+    quiet: bool,
 
     /// Format log messages as JSON.
     #[clap(
@@ -32,14 +31,23 @@ pub struct ShellOpts {
         conflicts_with_all = &["quiet", "color"],
         help_heading = "Display options"
     )]
-    pub json: bool,
+    json: bool,
 
     /// The color of the log messages.
     #[clap(long, global = true, value_enum, help_heading = "Display options")]
-    pub color: Option<ColorChoice>,
+    color: Option<ColorChoice>,
 }
 
-impl ShellOpts {
+impl GlobalOpts {
+    /// Initialize the global options.
+    pub fn init(self) -> eyre::Result<()> {
+        // Set the global shell.
+        self.shell().set();
+
+        Ok(())
+    }
+
+    /// Create a new shell instance.
     pub fn shell(self) -> Shell {
         let mode = match self.quiet {
             true => OutputMode::Quiet,

crates/cli/src/opts/mod.rs

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

crates/common/src/io/shell.rs

@@ -7,6 +7,7 @@ use anstream::AutoStream;
 use anstyle::Style;
 use clap::ValueEnum;
 use eyre::Result;
+use serde::{Deserialize, Serialize};
 use std::{
     fmt,
     io::{prelude::*, IsTerminal},
@@ -34,7 +35,7 @@ pub fn is_quiet() -> bool {
 
 /// Returns whether the output format is [`OutputFormat::Json`].
 pub fn is_json() -> bool {
-    Shell::get().output_format().is_json()
+    Shell::get().is_json()
 }
 
 /// The global shell instance.
@@ -172,7 +173,7 @@ enum ShellOut {
 }
 
 /// Whether messages should use color output.
-#[derive(Debug, Default, PartialEq, Clone, Copy, ValueEnum)]
+#[derive(Debug, Default, PartialEq, Clone, Copy, Serialize, Deserialize, ValueEnum)]
 pub enum ColorChoice {
     /// Intelligently guess whether to use color output (default).
     #[default]
@@ -262,6 +263,16 @@ impl Shell {
         self.needs_clear.swap(needs_clear, Ordering::Relaxed)
     }
 
+    /// Returns `true` if the output format is JSON.
+    pub fn is_json(&self) -> bool {
+        self.output_format.is_json()
+    }
+
+    /// Returns `true` if the verbosity level is `Quiet`.
+    pub fn is_quiet(&self) -> bool {
+        self.output_mode.is_quiet()
+    }
+
     /// Returns `true` if the `needs_clear` flag is set.
     #[inline]
     pub fn needs_clear(&self) -> bool {

crates/forge/bin/cmd/create.rs

@@ -10,7 +10,7 @@ use alloy_signer::Signer;
 use alloy_transport::{Transport, TransportError};
 use clap::{Parser, ValueHint};
 use eyre::{Context, Result};
-use forge_verify::RetryArgs;
+use forge_verify::{RetryArgs, VerifierArgs, VerifyArgs};
 use foundry_cli::{
     opts::{CoreBuildArgs, EthereumOpts, EtherscanOpts, TransactionOpts},
     utils::{self, read_constructor_args_file, remove_contract, LoadConfig},
@@ -89,7 +89,7 @@ pub struct CreateArgs {
     eth: EthereumOpts,
 
     #[command(flatten)]
-    pub verifier: forge_verify::VerifierArgs,
+    pub verifier: VerifierArgs,
 
     #[command(flatten)]
     retry: RetryArgs,
@@ -201,7 +201,7 @@ impl CreateArgs {
     ) -> Result<()> {
         // NOTE: this does not represent the same `VerifyArgs` that would be sent after deployment,
         // since we don't know the address yet.
-        let mut verify = forge_verify::VerifyArgs {
+        let mut verify = VerifyArgs {
             address: Default::default(),
             contract: Some(self.contract.clone()),
             compiler_version: Some(id.version.to_string()),
@@ -359,7 +359,7 @@ impl CreateArgs {
         } else {
             None
         };
-        let verify = forge_verify::VerifyArgs {
+        let verify = VerifyArgs {
             address,
             contract: Some(self.contract),
             compiler_version: Some(id.version.to_string()),

crates/forge/bin/cmd/soldeer.rs

@@ -1,6 +1,5 @@
 use clap::Parser;
 use eyre::Result;
-
 use soldeer_commands::Command;
 
 // CLI arguments for `forge soldeer`.

crates/forge/bin/cmd/test/mod.rs

@@ -17,7 +17,7 @@ use forge::{
     MultiContractRunner, MultiContractRunnerBuilder, TestFilter, TestOptions, TestOptionsBuilder,
 };
 use foundry_cli::{
-    opts::{CoreBuildArgs, ShellOpts},
+    opts::{CoreBuildArgs, GlobalOpts},
     utils::{self, LoadConfig},
 };
 use foundry_common::{compile::ProjectCompiler, evm::EvmArgs, fs, shell, TestFunctionExt};
@@ -65,6 +65,10 @@ foundry_config::merge_impl_figment_convert!(TestArgs, opts, evm_opts);
 #[derive(Clone, Debug, Parser)]
 #[command(next_help_heading = "Test options")]
 pub struct TestArgs {
+    /// Include the global options.
+    #[command(flatten)]
+    pub global: GlobalOpts,
+
     /// The contract file you want to test, it's a shortcut for --match-path.
     #[arg(value_hint = ValueHint::FilePath)]
     pub path: Option<GlobMatcher>,
@@ -178,9 +182,6 @@ pub struct TestArgs {
     /// Print detailed test summary table.
     #[arg(long, help_heading = "Display options", requires = "summary")]
     pub detailed: bool,
-
-    #[command(flatten)]
-    shell: ShellOpts,
 }
 
 impl TestArgs {