fix(inspect): add flag to strip ir comments (foundry-rs#9825)

* fix(inspect): do not strip comments when yul print

* Update crates/forge/bin/cmd/inspect.rs

Co-authored-by: DaniPopes <[email protected]>

---------

Co-authored-by: DaniPopes <[email protected]>

Author: grandizzy

crates/forge/bin/cmd/inspect.rs

@@ -36,11 +36,15 @@ pub struct InspectArgs {
     /// All build arguments are supported
     #[command(flatten)]
     build: BuildOpts,
+
+    /// Whether to remove comments when inspecting `ir` and `irOptimized` artifact fields.
+    #[arg(long, short, help_heading = "Display options")]
+    pub strip_yul_comments: bool,
 }
 
 impl InspectArgs {
     pub fn run(self) -> Result<()> {
-        let Self { contract, field, build } = self;
+        let Self { contract, field, build, strip_yul_comments } = self;
 
         trace!(target: "forge", ?field, ?contract, "running forge inspect");
 
@@ -106,10 +110,10 @@ impl InspectArgs {
                 print_json(&artifact.devdoc)?;
             }
             ContractArtifactField::Ir => {
-                print_yul(artifact.ir.as_deref())?;
+                print_yul(artifact.ir.as_deref(), strip_yul_comments)?;
             }
             ContractArtifactField::IrOptimized => {
-                print_yul(artifact.ir_optimized.as_deref())?;
+                print_yul(artifact.ir_optimized.as_deref(), strip_yul_comments)?;
             }
             ContractArtifactField::Metadata => {
                 print_json(&artifact.metadata)?;
@@ -532,15 +536,19 @@ fn print_json_str(obj: &impl serde::Serialize, key: Option<&str>) -> Result<()>
     Ok(())
 }
 
-fn print_yul(yul: Option<&str>) -> Result<()> {
+fn print_yul(yul: Option<&str>, strip_comments: bool) -> Result<()> {
     let Some(yul) = yul else {
         eyre::bail!("Could not get IR output");
     };
 
     static YUL_COMMENTS: LazyLock<Regex> =
-        LazyLock::new(|| Regex::new(r"(///.*\n\s*)|(\s*/\*\*.*\*/)").unwrap());
+        LazyLock::new(|| Regex::new(r"(///.*\n\s*)|(\s*/\*\*.*?\*/)").unwrap());
 
-    sh_println!("{}", YUL_COMMENTS.replace_all(yul, ""))?;
+    if strip_comments {
+        sh_println!("{}", YUL_COMMENTS.replace_all(yul, ""))?;
+    } else {
+        sh_println!("{yul}")?;
+    }
 
     Ok(())
 }

crates/forge/tests/cli/cmd.rs

@@ -3062,7 +3062,51 @@ Compiler run successful!
 // checks `forge inspect <contract> irOptimized works
 forgetest_init!(can_inspect_ir_optimized, |_prj, cmd| {
     cmd.args(["inspect", TEMPLATE_CONTRACT, "irOptimized"]);
-    cmd.assert_success();
+    cmd.assert_success().stdout_eq(str![[r#"
+/// @use-src 0:"src/Counter.sol"
+object "Counter_21" {
+    code {
+        {
+            /// @src 0:65:257  "contract Counter {..."
+            mstore(64, memoryguard(0x80))
+...
+"#]]);
+
+    // check inspect with strip comments
+    cmd.forge_fuse().args(["inspect", TEMPLATE_CONTRACT, "irOptimized", "-s"]);
+    cmd.assert_success().stdout_eq(str![[r#"
+object "Counter_21" {
+    code {
+        {
+            mstore(64, memoryguard(0x80))
+            if callvalue()
+...
+"#]]);
+});
+
+// checks `forge inspect <contract> irOptimized works
+forgetest_init!(can_inspect_ir, |_prj, cmd| {
+    cmd.args(["inspect", TEMPLATE_CONTRACT, "ir"]);
+    cmd.assert_success().stdout_eq(str![[r#"
+
+/// @use-src 0:"src/Counter.sol"
+object "Counter_21" {
+    code {
+        /// @src 0:65:257  "contract Counter {..."
+        mstore(64, memoryguard(128))
+...
+"#]]);
+
+    // check inspect with strip comments
+    cmd.forge_fuse().args(["inspect", TEMPLATE_CONTRACT, "ir", "-s"]);
+    cmd.assert_success().stdout_eq(str![[r#"
+
+object "Counter_21" {
+    code {
+        mstore(64, memoryguard(128))
+        if callvalue() { revert_error_ca66f745a3ce8ff40e2ccaf1ad45db7774001b90d25810abd9040049be7bf4bb() }
+...
+"#]]);
 });
 
 // checks forge bind works correctly on the default project