From a100f547cf6b622bb71fed0827f8cc864719b9ea Mon Sep 17 00:00:00 2001
From: Cesar Rodas <cesar@rodasm.com.py>
Date: Thu, 22 Feb 2024 12:24:03 -0300
Subject: [PATCH] Less magic

Call forc_util::cli::register() explicitly instead of doing some dark magic
behind through cli_examples macro
---
 Cargo.lock                                 |  1 +
 forc-plugins/forc-client/src/bin/deploy.rs |  3 +-
 forc-plugins/forc-client/src/bin/run.rs    |  3 +-
 forc-plugins/forc-client/src/bin/submit.rs |  3 +-
 forc-plugins/forc-crypto/src/main.rs       |  3 +-
 forc-plugins/forc-debug/Cargo.toml         |  1 +
 forc-plugins/forc-debug/src/main.rs        |  3 +-
 forc-plugins/forc-doc/src/main.rs          |  3 +-
 forc-plugins/forc-fmt/src/main.rs          |  6 +-
 forc-plugins/forc-tx/src/lib.rs            |  6 +-
 forc-util/src/cli.rs                       | 66 +++++-----------------
 forc/src/cli/commands/completions.rs       | 10 ++--
 12 files changed, 40 insertions(+), 68 deletions(-)

diff --git a/Cargo.lock b/Cargo.lock
index f0bedcb6e00..06769edeafb 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -2083,6 +2083,7 @@ dependencies = [
  "escargot",
  "forc-pkg",
  "forc-test",
+ "forc-util",
  "fuel-core-client",
  "fuel-types",
  "fuel-vm",
diff --git a/forc-plugins/forc-client/src/bin/deploy.rs b/forc-plugins/forc-client/src/bin/deploy.rs
index 030db172bc3..45378539e00 100644
--- a/forc-plugins/forc-client/src/bin/deploy.rs
+++ b/forc-plugins/forc-client/src/bin/deploy.rs
@@ -1,8 +1,9 @@
-use clap::Parser;
+use clap::{IntoApp, Parser};
 use forc_tracing::{init_tracing_subscriber, println_error};
 
 #[tokio::main]
 async fn main() {
+    forc_util::cli::register(forc_client::cmd::Deploy::into_app());
     init_tracing_subscriber(Default::default());
     let command = forc_client::cmd::Deploy::parse();
     if let Err(err) = forc_client::op::deploy(command).await {
diff --git a/forc-plugins/forc-client/src/bin/run.rs b/forc-plugins/forc-client/src/bin/run.rs
index 77305f90bfa..387d728d0c8 100644
--- a/forc-plugins/forc-client/src/bin/run.rs
+++ b/forc-plugins/forc-client/src/bin/run.rs
@@ -1,8 +1,9 @@
-use clap::Parser;
+use clap::{IntoApp, Parser};
 use forc_tracing::{init_tracing_subscriber, println_error};
 
 #[tokio::main]
 async fn main() {
+    forc_util::cli::register(forc_client::cmd::Run::into_app());
     init_tracing_subscriber(Default::default());
     let command = forc_client::cmd::Run::parse();
     if let Err(err) = forc_client::op::run(command).await {
diff --git a/forc-plugins/forc-client/src/bin/submit.rs b/forc-plugins/forc-client/src/bin/submit.rs
index cb0155a1c62..9f5973c963e 100644
--- a/forc-plugins/forc-client/src/bin/submit.rs
+++ b/forc-plugins/forc-client/src/bin/submit.rs
@@ -1,8 +1,9 @@
-use clap::Parser;
+use clap::{IntoApp, Parser};
 use forc_tracing::{init_tracing_subscriber, println_error};
 
 #[tokio::main]
 async fn main() {
+    forc_util::cli::register(forc_client::cmd::Submit::into_app());
     init_tracing_subscriber(Default::default());
     let command = forc_client::cmd::Submit::parse();
     if let Err(err) = forc_client::op::submit(command).await {
diff --git a/forc-plugins/forc-crypto/src/main.rs b/forc-plugins/forc-crypto/src/main.rs
index b872264d4f6..1592b194b60 100644
--- a/forc-plugins/forc-crypto/src/main.rs
+++ b/forc-plugins/forc-crypto/src/main.rs
@@ -2,7 +2,7 @@
 
 use anyhow::Result;
 use atty::Stream;
-use clap::Parser;
+use clap::{IntoApp, Parser};
 use forc_tracing::{init_tracing_subscriber, println_error};
 use std::{
     default::Default,
@@ -57,6 +57,7 @@ fn main() {
 }
 
 fn run() -> Result<()> {
+    forc_util::cli::register(Command::into_app());
     let app = Command::parse();
     let content = match app {
         Command::Keccak256(arg) => keccak256::hash(arg)?,
diff --git a/forc-plugins/forc-debug/Cargo.toml b/forc-plugins/forc-debug/Cargo.toml
index cda0f48c948..30977ea6390 100644
--- a/forc-plugins/forc-debug/Cargo.toml
+++ b/forc-plugins/forc-debug/Cargo.toml
@@ -15,6 +15,7 @@ dap = "0.4.1-alpha1"
 forc-pkg = { version = "0.50.0", path = "../../forc-pkg" }
 forc-test = { version = "0.50.0", path = "../../forc-test" }
 fuel-core-client = { workspace = true }
+forc-util = { version = "0.50.0", path = "../../forc-util" }
 fuel-types = { workspace = true, features = ["serde"] }
 fuel-vm = { workspace = true, features = ["serde"] }
 rayon = "1.7.0"
diff --git a/forc-plugins/forc-debug/src/main.rs b/forc-plugins/forc-debug/src/main.rs
index 946d3b4d285..02c49e8cbf4 100644
--- a/forc-plugins/forc-debug/src/main.rs
+++ b/forc-plugins/forc-debug/src/main.rs
@@ -1,4 +1,4 @@
-use clap::Parser;
+use clap::{IntoApp, Parser};
 use forc_debug::{
     names::{register_index, register_name},
     server::DapServer,
@@ -20,6 +20,7 @@ pub struct Opt {
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    forc_util::cli::register(Opt::into_app());
     let config = Opt::parse();
 
     if config.serve {
diff --git a/forc-plugins/forc-doc/src/main.rs b/forc-plugins/forc-doc/src/main.rs
index b9d3c79fba2..88b83e30e0f 100644
--- a/forc-plugins/forc-doc/src/main.rs
+++ b/forc-plugins/forc-doc/src/main.rs
@@ -4,7 +4,7 @@ use crate::{
     search::write_search_index,
 };
 use anyhow::{bail, Result};
-use clap::Parser;
+use clap::{IntoApp, Parser};
 use cli::Command;
 use colored::*;
 use forc_pkg as pkg;
@@ -51,6 +51,7 @@ struct ProgramInfo<'a> {
 }
 
 pub fn main() -> Result<()> {
+    forc_util::cli::register(Command::into_app());
     let build_instructions = Command::parse();
 
     let (doc_path, pkg_manifest) = compile_html(&build_instructions, &get_doc_dir)?;
diff --git a/forc-plugins/forc-fmt/src/main.rs b/forc-plugins/forc-fmt/src/main.rs
index d88a38ffd9e..a8fbbdd10e8 100644
--- a/forc-plugins/forc-fmt/src/main.rs
+++ b/forc-plugins/forc-fmt/src/main.rs
@@ -1,7 +1,7 @@
 //! A `forc` plugin for running the Sway code formatter.
 
 use anyhow::{bail, Result};
-use clap::Parser;
+use clap::{IntoApp, Parser};
 use forc_pkg::{
     manifest::{GenericManifestFile, ManifestFile},
     WorkspaceManifestFile,
@@ -51,7 +51,8 @@ pub struct App {
     pub path: Option<String>,
     #[clap(short, long)]
     /// Formats a single .sw file with the default settings.
-    /// If not specified, current working directory will be formatted using a Forc.toml configuration.
+    /// If not specified, current working directory will be formatted using a Forc.toml
+    /// configuration.
     pub file: Option<String>,
 }
 
@@ -65,6 +66,7 @@ fn main() {
 }
 
 fn run() -> Result<()> {
+    forc_util::cli::register(App::into_app());
     let app = App::parse();
 
     let dir = match app.path.as_ref() {
diff --git a/forc-plugins/forc-tx/src/lib.rs b/forc-plugins/forc-tx/src/lib.rs
index 088fe8808f8..d51ec78100f 100644
--- a/forc-plugins/forc-tx/src/lib.rs
+++ b/forc-plugins/forc-tx/src/lib.rs
@@ -13,9 +13,6 @@ use std::path::PathBuf;
 use thiserror::Error;
 
 forc_util::cli_examples! {
-    {
-        None
-    }
     {
         // This parser has a custom parser
         super::Command::try_parse_from_args
@@ -728,7 +725,8 @@ impl TryFrom<Script> for fuel_tx::Script {
             script_tx.set_script_gas_limit(script_gas_limit)
         } else {
             let consensus_params = ConsensusParameters::default();
-            // Get `max_gas` used by everything except the script execution. Add `1` because of rounding.
+            // Get `max_gas` used by everything except the script execution. Add `1` because of
+            // rounding.
             let max_gas =
                 script_tx.max_gas(consensus_params.gas_costs(), consensus_params.fee_params()) + 1;
             // Increase `script_gas_limit` to the maximum allowed value.
diff --git a/forc-util/src/cli.rs b/forc-util/src/cli.rs
index fc857ebc9d3..e87af2105ce 100644
--- a/forc-util/src/cli.rs
+++ b/forc-util/src/cli.rs
@@ -165,33 +165,20 @@ impl ArgInfo {
     }
 }
 
-pub fn dump_cli_definition<X: clap::IntoApp>(app: X) {
-    let cmd = app.into_app();
-    serde_json::to_writer_pretty(std::io::stdout(), &CommandInfo::new(&cmd)).unwrap();
-    std::process::exit(0);
-}
-
-macro_rules! clap_completions {
-    ($st:path) => {
-        use clap::IntoApp;
-        $st::into_app()
-
-        mod cli_definition {
-            /// Dump the CLI definition to the stdout
-            pub(crate) fn dump() {
-                std::env::set_var("CLI_DUMP_DEFINITION", "");
-
-                if let Some(mut cmd) = $into_app {
-                    forc_util::serde_json::to_writer_pretty(
-                        std::io::stdout(),
-                        &forc_util::cli::CommandInfo::new(&cmd)
-                    ).unwrap();
-                    std::process::exit(0);
-                }
-            }
+/// Registers the current command to print the CLI definition, if the `--cli-definition` argument is
+/// passed.
+///
+/// The existance of --cli-definition is arbitrary, a convention that is used by forc and is
+/// probably not defined inside the clap struct. Because of this, the `--cli-definition` argument,
+/// the function should be called *before* the `clap::App` is built to parse the arguments.
+pub fn register(cmd: clap::App<'_>) {
+    std::env::args().skip(1).for_each(|arg| {
+        if arg == "--cli-definition" {
+            let cmd_info = CommandInfo::new(&cmd);
+            serde_json::to_writer_pretty(std::io::stdout(), &cmd_info).unwrap();
+            std::process::exit(0);
         }
-
-    };
+    });
 }
 
 #[macro_export]
@@ -199,12 +186,7 @@ macro_rules! clap_completions {
 macro_rules! cli_examples {
     ($st:path { $( [ $($description:ident)* => $command:stmt ] )* }) => {
         forc_util::cli_examples! {
-            {
-                $crate::paste::paste! {
-                    use clap::IntoApp;
-                    Some($st::into_app())
-                }
-            } {
+           {
                 $crate::paste::paste! {
                     use clap::Parser;
                     $st::try_parse_from
@@ -214,7 +196,7 @@ macro_rules! cli_examples {
             }
         }
     };
-    ( $into_app:block $parser:block { $( [ $($description:ident)* => $command:stmt ] )* }) => {
+    ( $parser:block { $( [ $($description:ident)* => $command:stmt ] )* }) => {
         $crate::paste::paste! {
         #[cfg(test)]
         mod cli_parsing {
@@ -301,30 +283,12 @@ macro_rules! cli_examples {
         }
         }
 
-        mod cli_definition {
-            /// Dump the CLI definition to the stdout
-            pub(crate) fn dump() {
-                std::env::set_var("CLI_DUMP_DEFINITION", "");
-
-                if let Some(mut cmd) = $into_app {
-                    forc_util::serde_json::to_writer_pretty(
-                        std::io::stdout(),
-                        &forc_util::cli::CommandInfo::new(&cmd)
-                    ).unwrap();
-                    std::process::exit(0);
-                }
-            }
-        }
-
         /// Show the long help for the current app
         ///
         /// This function is being called automatically, so if CLI_DUMP_DEFINITION is set to 1, it
         /// will dump the definition of the CLI. Otherwise, it would have to be manually invoked by
         /// the developer
         fn help() -> &'static str {
-            if std::env::var("CLI_DUMP_DEFINITION") == Ok("1".to_string()) {
-                cli_definition::dump();
-            }
             Box::leak(format!("{}\n{}", forc_util::ansi_term::Colour::Yellow.paint("EXAMPLES:"), examples()).into_boxed_str())
         }
 
diff --git a/forc/src/cli/commands/completions.rs b/forc/src/cli/commands/completions.rs
index db69039b3d1..267dc51763f 100644
--- a/forc/src/cli/commands/completions.rs
+++ b/forc/src/cli/commands/completions.rs
@@ -54,18 +54,18 @@ fn generate_autocomplete_script(target: Target, writer: &mut dyn Write) {
     let mut cmd = CommandInfo::new(&super::super::Opt::command());
     let mut plugins = HashMap::new();
     find_all().for_each(|path| {
-        let mut proc = std::process::Command::new(path.clone());
-        proc.env("CLI_DUMP_DEFINITION", "1");
-        if let Ok(proc) = proc.output() {
+        if let Ok(proc) = std::process::Command::new(path.clone())
+            .arg("--cli-definition")
+            .output()
+        {
             if let Ok(mut command_info) = serde_json::from_slice::<CommandInfo>(&proc.stdout) {
                 command_info.name = if let Some(name) = path
                     .file_name()
-                    .map(|x| {
+                    .and_then(|x| {
                         x.to_string_lossy()
                             .strip_prefix("forc-")
                             .map(|x| x.to_owned())
                     })
-                    .flatten()
                 {
                     name
                 } else {