foundry_cli/opts/
global.rs
1use clap::{ArgAction, Parser};
2use foundry_common::{
3 shell::{ColorChoice, OutputFormat, OutputMode, Shell, Verbosity},
4 version::{IS_NIGHTLY_VERSION, NIGHTLY_VERSION_WARNING_MESSAGE},
5};
6use serde::{Deserialize, Serialize};
7
8#[derive(Clone, Debug, Default, Serialize, Deserialize, Parser)]
10pub struct GlobalArgs {
11 #[arg(help_heading = "Display options", global = true, short, long, verbatim_doc_comment, conflicts_with = "quiet", action = ArgAction::Count)]
23 verbosity: Verbosity,
24
25 #[arg(help_heading = "Display options", global = true, short, long, alias = "silent")]
27 quiet: bool,
28
29 #[arg(help_heading = "Display options", global = true, long, alias = "format-json", conflicts_with_all = &["quiet", "color"])]
31 json: bool,
32
33 #[arg(help_heading = "Display options", global = true, long, value_enum)]
35 color: Option<ColorChoice>,
36
37 #[arg(global = true, long, short = 'j', visible_alias = "jobs")]
39 threads: Option<usize>,
40}
41
42impl GlobalArgs {
43 pub fn init(&self) -> eyre::Result<()> {
45 self.shell().set();
47
48 if self.threads.is_some() {
50 self.force_init_thread_pool()?;
51 }
52
53 if std::env::var("FOUNDRY_DISABLE_NIGHTLY_WARNING").is_err()
55 && !self.json
56 && IS_NIGHTLY_VERSION
57 {
58 let _ = sh_warn!("{}", NIGHTLY_VERSION_WARNING_MESSAGE);
59 }
60
61 Ok(())
62 }
63
64 pub fn shell(&self) -> Shell {
66 let mode = match self.quiet {
67 true => OutputMode::Quiet,
68 false => OutputMode::Normal,
69 };
70 let color = self.json.then_some(ColorChoice::Never).or(self.color).unwrap_or_default();
71 let format = match self.json {
72 true => OutputFormat::Json,
73 false => OutputFormat::Text,
74 };
75
76 Shell::new_with(format, mode, color, self.verbosity)
77 }
78
79 pub fn force_init_thread_pool(&self) -> eyre::Result<()> {
81 init_thread_pool(self.threads.unwrap_or(0))
82 }
83
84 #[track_caller]
86 pub fn tokio_runtime(&self) -> tokio::runtime::Runtime {
87 let mut builder = tokio::runtime::Builder::new_multi_thread();
88 if let Some(threads) = self.threads
89 && threads > 0
90 {
91 builder.worker_threads(threads);
92 }
93 builder.enable_all().build().expect("failed to create tokio runtime")
94 }
95
96 #[track_caller]
98 pub fn block_on<F: std::future::Future>(&self, future: F) -> F::Output {
99 self.tokio_runtime().block_on(future)
100 }
101}
102
103pub fn init_thread_pool(threads: usize) -> eyre::Result<()> {
105 rayon::ThreadPoolBuilder::new()
106 .thread_name(|i| format!("foundry-{i}"))
107 .num_threads(threads)
108 .build_global()?;
109 Ok(())
110}