fix(lint): avoid ANSI chars with JSON emitter (#11470)

0xrusowsky · web-flow · commit 56aadcb20c7e · 2025-08-29T13:31:18.000+02:00
diff --git a/crates/forge/tests/cli/lint.rs b/crates/forge/tests/cli/lint.rs
@@ -530,6 +530,94 @@ Compiler run successful!
 "#]]);
 });
 
+// <https://github.com/foundry-rs/foundry/issues/11460>
+forgetest!(lint_json_output_no_ansi_escape_codes, |prj, cmd| {
+    prj.wipe_contracts();
+    prj.add_source(
+        "UnwrappedModifierTest",
+        r#"
+        // SPDX-License-Identifier: MIT
+        pragma solidity ^0.8.0;
+
+        contract UnwrappedModifierTest {
+            mapping(address => bool) isOwner;
+
+            modifier onlyOwner() {
+                require(isOwner[msg.sender], "Not owner");
+                require(msg.sender != address(0), "Zero address");
+                _;
+            }
+
+            function doSomething() public onlyOwner {}
+        }
+            "#,
+    );
+
+    prj.update_config(|config| {
+        config.lint = LinterConfig {
+            severity: vec![LintSeverity::CodeSize],
+            exclude_lints: vec![],
+            ignore: vec![],
+            lint_on_build: true,
+            ..Default::default()
+        };
+    });
+
+    // should produce clean JSON without ANSI escape sequences (for the url nor the snippets)
+    cmd.arg("lint").arg("--json").assert_json_stderr(true,
+        str![[r#"
+            {
+              "$message_type": "diag",
+              "message": "wrap modifier logic to reduce code size",
+              "code": {
+                "code": "unwrapped-modifier-logic",
+                "explanation": null
+              },
+              "level": "note",
+              "spans": [
+                {
+                  "file_name": "[..]",
+                  "byte_start": 183,
+                  "byte_end": 192,
+                  "line_start": 8,
+                  "line_end": 8,
+                  "column_start": 22,
+                  "column_end": 31,
+                  "is_primary": true,
+                  "text": [
+                    {
+                      "text": "            modifier onlyOwner() {",
+                      "highlight_start": 22,
+                      "highlight_end": 31
+                    }
+                  ],
+                  "label": null
+                }
+              ],
+              "children": [
+                {
+                  "message": "wrap modifier logic to reduce code size\n\n- modifier onlyOwner() {\n-     require(isOwner[msg.sender], \"Not owner\");\n-     require(msg.sender != address(0), \"Zero address\");\n-     _;\n- }\n+ modifier onlyOwner() {\n+     _onlyOwner();\n+     _;\n+ }\n+ \n+ function _onlyOwner() internal {\n+     require(isOwner[msg.sender], \"Not owner\");\n+     require(msg.sender != address(0), \"Zero address\");\n+ }\n\n",
+                  "code": null,
+                  "level": "note",
+                  "spans": [],
+                  "children": [],
+                  "rendered": null
+                },
+                {
+                  "message": "https://book.getfoundry.sh/reference/forge/forge-lint#unwrapped-modifier-logic",
+                  "code": null,
+                  "level": "help",
+                  "spans": [],
+                  "children": [],
+                  "rendered": null
+                }
+              ],
+              "rendered": "note[unwrapped-modifier-logic]: wrap modifier logic to reduce code size\n  |\n8 |             modifier onlyOwner() {\n  |                      ---------\n  |\n  = note: wrap modifier logic to reduce code size\n          \n          - modifier onlyOwner() {\n          -     require(isOwner[msg.sender], \"Not owner\");\n          -     require(msg.sender != address(0), \"Zero address\");\n          -     _;\n          - }\n          + modifier onlyOwner() {\n          +     _onlyOwner();\n          +     _;\n          + }\n          + \n          + function _onlyOwner() internal {\n          +     require(isOwner[msg.sender], \"Not owner\");\n          +     require(msg.sender != address(0), \"Zero address\");\n          + }\n          \n  = help: https://book.getfoundry.sh/reference/forge/forge-lint#unwrapped-modifier-logic\n\n --> [..]\n"
+            }
+"#]],
+);
+});
+
 // ------------------------------------------------------------------------------------------------
 
 #[tokio::test]
diff --git a/crates/lint/src/linter/mod.rs b/crates/lint/src/linter/mod.rs
@@ -54,6 +54,7 @@ pub trait Lint {
 pub struct LintContext<'s, 'c> {
     sess: &'s Session,
     with_description: bool,
+    with_json_emitter: bool,
     pub config: LinterConfig<'c>,
     active_lints: Vec<&'static str>,
 }
@@ -67,10 +68,11 @@ impl<'s, 'c> LintContext<'s, 'c> {
     pub fn new(
         sess: &'s Session,
         with_description: bool,
+        with_json_emitter: bool,
         config: LinterConfig<'c>,
         active_lints: Vec<&'static str>,
     ) -> Self {
-        Self { sess, with_description, config, active_lints }
+        Self { sess, with_description, with_json_emitter, config, active_lints }
     }
 
     pub fn session(&self) -> &'s Session {
@@ -92,13 +94,19 @@ impl<'s, 'c> LintContext<'s, 'c> {
         }
 
         let desc = if self.with_description { lint.description() } else { "" };
-        let diag: DiagBuilder<'_, ()> = self
+        let mut diag: DiagBuilder<'_, ()> = self
             .sess
             .dcx
             .diag(lint.severity().into(), desc)
             .code(DiagId::new_str(lint.id()))
-            .span(MultiSpan::from_span(span))
-            .help(lint.help());
+            .span(MultiSpan::from_span(span));
+
+        // Avoid ANSI characters when using a JSON emitter
+        if self.with_json_emitter {
+            diag = diag.help(lint.help());
+        } else {
+            diag = diag.help(hyperlink(lint.help()));
+        }
 
         diag.emit();
     }
@@ -131,14 +139,21 @@ impl<'s, 'c> LintContext<'s, 'c> {
         };
 
         let desc = if self.with_description { lint.description() } else { "" };
-        let diag: DiagBuilder<'_, ()> = self
+        let mut diag: DiagBuilder<'_, ()> = self
             .sess
             .dcx
             .diag(lint.severity().into(), desc)
             .code(DiagId::new_str(lint.id()))
-            .span(MultiSpan::from_span(span))
-            .highlighted_note(snippet.to_note(self))
-            .help(lint.help());
+            .span(MultiSpan::from_span(span));
+
+        // Avoid ANSI characters when using a JSON emitter
+        if self.with_json_emitter {
+            diag = diag
+                .note(snippet.to_note(self).iter().map(|l| l.0.as_str()).collect::<String>())
+                .help(lint.help());
+        } else {
+            diag = diag.highlighted_note(snippet.to_note(self)).help(hyperlink(lint.help()));
+        }
 
         diag.emit();
     }
@@ -253,3 +268,8 @@ impl Snippet {
         &s[byte_offset..]
     }
 }
+
+/// Creates a hyperlink of the input url.
+fn hyperlink(url: &'static str) -> String {
+    format!("\x1b]8;;{url}\x1b\\{url}\x1b]8;;\x1b\\")
+}
diff --git a/crates/lint/src/sol/macros.rs b/crates/lint/src/sol/macros.rs
@@ -1,10 +1,3 @@
-#[macro_export]
-macro_rules! link {
-    ($url:expr) => {
-        concat!("\x1b]8;;", $url, "\x1b\\", $url, "\x1b]8;;\x1b\\")
-    };
-}
-
 /// Macro for defining lints and relevant metadata for the Solidity linter.
 ///
 /// # Parameters
@@ -27,7 +20,7 @@ macro_rules! declare_forge_lint {
             id: $str_id,
             severity: $severity,
             description: $desc,
-            help: link!(concat!("https://book.getfoundry.sh/reference/forge/forge-lint#", $str_id)),
+            help: concat!("https://book.getfoundry.sh/reference/forge/forge-lint#", $str_id),
         };
     };
 
diff --git a/crates/lint/src/sol/mod.rs b/crates/lint/src/sol/mod.rs
@@ -153,7 +153,13 @@ impl<'a> SolidityLinter<'a> {
         let inline_config = parse_inline_config(sess, &comments, InlineConfigSource::Ast(ast));
 
         // Initialize and run the early lint visitor
-        let ctx = LintContext::new(sess, self.with_description, self.config(inline_config), lints);
+        let ctx = LintContext::new(
+            sess,
+            self.with_description,
+            self.with_json_emitter,
+            self.config(inline_config),
+            lints,
+        );
         let mut early_visitor = EarlyLintVisitor::new(&ctx, &mut passes);
         _ = early_visitor.visit_source_unit(ast);
         early_visitor.post_source_unit(ast);
@@ -207,8 +213,13 @@ impl<'a> SolidityLinter<'a> {
         );
 
         // Run late lint visitor
-        let ctx =
-            LintContext::new(gcx.sess, self.with_description, self.config(inline_config), lints);
+        let ctx = LintContext::new(
+            gcx.sess,
+            self.with_description,
+            self.with_json_emitter,
+            self.config(inline_config),
+            lints,
+        );
         let mut late_visitor = LateLintVisitor::new(&ctx, &mut passes, &gcx.hir);
 
         // Visit this specific source
diff --git a/crates/test-utils/src/util.rs b/crates/test-utils/src/util.rs
@@ -962,6 +962,18 @@ impl TestCommand {
         assert_data_eq!(actual, expected);
     }
 
+    /// Runs the command and asserts that it resulted in the expected outcome and JSON data.
+    #[track_caller]
+    pub fn assert_json_stderr(&mut self, success: bool, expected: impl IntoData) {
+        let expected = expected.is(snapbox::data::DataFormat::Json).unordered();
+        let stderr = if success { self.assert_success() } else { self.assert_failure() }
+            .get_output()
+            .stderr
+            .clone();
+        let actual = stderr.into_data().is(snapbox::data::DataFormat::Json).unordered();
+        assert_data_eq!(actual, expected);
+    }
+
     /// Runs the command and asserts that it **succeeded** nothing was printed to stdout.
     #[track_caller]
     pub fn assert_empty_stdout(&mut self) {
