add NO_COLOR

Author: myfreess

SKILL.md

@@ -45,7 +45,9 @@ before warnings and match results.
 
 Each match result prints the source line covered by the finding plus up to two
 lines of surrounding source context. Surrounding context lines are rendered in
-gray; matched source lines are rendered without gray styling.
+gray; matched source lines are rendered without gray styling. Set `NO_COLOR=1`
+to disable gray context styling and render matched source lines with `>` instead
+of `|`.
 
 If `scan-root` is omitted, `moongrep` scans the current directory:
 

cli_args.mbt

@@ -14,6 +14,7 @@ priv struct CliOptions {
   exclude_dirs : Array[String]
   verbose : Bool
   enable_builtin_rules : Bool
+  no_color : Bool
 }
 
 ///|
@@ -161,6 +162,14 @@ fn cli_flag_enabled(flags : Map[String, Bool], name : String) -> Bool {
   }
 }
 
+///|
+fn no_color_enabled(env : Map[String, String]) -> Bool {
+  match env.get("NO_COLOR") {
+    Some(value) if value == "1" => true
+    _ => false
+  }
+}
+
 ///|
 fn docs_cli_command(
   docs_matches : @argparse.Matches,
@@ -206,12 +215,16 @@ fn dump_cli_command(
 }
 
 ///|
-fn scan_cli_options(scan_matches : @argparse.Matches) -> CliOptions raise {
+fn scan_cli_options(
+  scan_matches : @argparse.Matches,
+  env : Map[String, String],
+) -> CliOptions raise {
   let verbose = cli_flag_enabled(scan_matches.flags, "verbose")
   let enable_builtin_rules = cli_flag_enabled(
     scan_matches.flags,
     "enable-builtin-rules",
   )
+  let no_color = no_color_enabled(env)
   let rules_root = last_cli_value(scan_matches.values, "rules")
   let rule_file = last_cli_value(scan_matches.values, "rule")
   let patterns = all_cli_values(scan_matches.values, "pattern")
@@ -241,6 +254,7 @@ fn scan_cli_options(scan_matches : @argparse.Matches) -> CliOptions raise {
     exclude_dirs,
     verbose,
     enable_builtin_rules,
+    no_color,
   }
 }
 
@@ -304,7 +318,7 @@ fn parse_cli_command(
   }
   match matches.subcommand {
     Some(("scan", scan_matches)) =>
-      ("scan", Some(scan_cli_options(scan_matches)), None)
+      ("scan", Some(scan_cli_options(scan_matches, env)), None)
     Some(("docs", docs_matches)) => docs_cli_command(docs_matches)
     Some(("dump", dump_matches)) => dump_cli_command(dump_matches)
     _ => raise CliError::Usage(message="missing required command", exit_code=2)

cli_wbtest.mbt

@@ -90,11 +90,41 @@ test "cli args parse rules root and default scan root" {
       inspect(options.scan_root, content=".")
       assert_false(options.verbose)
       assert_false(options.enable_builtin_rules)
+      assert_false(options.no_color)
     }
     _ => fail("unexpected command")
   }
 }
 
+///|
+test "cli args enable no color only when NO_COLOR is 1" {
+  match parse_cli_command(["scan", "--rules", "custom-rules"]) {
+    ("scan", Some(options), None) => assert_false(options.no_color)
+    _ => fail("unexpected command")
+  }
+  match
+    parse_cli_command(["scan", "--rules", "custom-rules"], env={
+      "NO_COLOR": "",
+    }) {
+    ("scan", Some(options), None) => assert_false(options.no_color)
+    _ => fail("unexpected command")
+  }
+  match
+    parse_cli_command(["scan", "--rules", "custom-rules"], env={
+      "NO_COLOR": "true",
+    }) {
+    ("scan", Some(options), None) => assert_false(options.no_color)
+    _ => fail("unexpected command")
+  }
+  match
+    parse_cli_command(["scan", "--rules", "custom-rules"], env={
+      "NO_COLOR": "1",
+    }) {
+    ("scan", Some(options), None) => assert_true(options.no_color)
+    _ => fail("unexpected command")
+  }
+}
+
 ///|
 test "cli args parse single rule file and default scan root" {
   match parse_cli_command(["scan", "--rule", "custom-rules/example.yaml"]) {

e2etests/BASIC.md

@@ -47,26 +47,26 @@ description:
   Found inspect() snapshots whose expected value is a plain number.
   Prefer numeric assertions for numeric checks.
 source:
-\x1b[90m1 | ///|\x1b[39m (escaped)
-\x1b[90m2 | fn has_builtin_hits(value : Int?) -> Unit {\x1b[39m (escaped)
-3 |   inspect(1, content="1")
-\x1b[90m4 |   assert_true(\x1b[39m (escaped)
-\x1b[90m5 |     match value {\x1b[39m (escaped)
+1 | ///|
+2 | fn has_builtin_hits(value : Int?) -> Unit {
+3 >   inspect(1, content="1")
+4 |   assert_true(
+5 |     match value {
 
 testdata/builtin-rules/hit.mbt:5:5-8:6
 rule: moonbitlang/match_option
 description:
   Found an Option value handled with match over Some and None.
   Prefer if + is for simple Option checks.
 source:
-\x1b[90m3 |   inspect(1, content="1")\x1b[39m (escaped)
-\x1b[90m4 |   assert_true(\x1b[39m (escaped)
-5 |     match value {
-6 |       Some(inner) => inner > 0
-7 |       None => false
-8 |     },
-\x1b[90m9 |   )\x1b[39m (escaped)
-\x1b[90m10 | }\x1b[39m (escaped)
+3 |   inspect(1, content="1")
+4 |   assert_true(
+5 >     match value {
+6 >       Some(inner) => inner > 0
+7 >       None => false
+8 >     },
+9 |   )
+10 | }
 ```
 
 ## moongrep dump --help

e2etests/INTEGRATION.md

@@ -8,10 +8,10 @@ outer_loc: testdata/inside-expr-target/src/hit.mbt:2:3-3:15
 description:
   Local println shadows the builtin.
 source:
-\x1b[90m1 | fn sample {\x1b[39m (escaped)
-\x1b[90m2 |   let println = custom;\x1b[39m (escaped)
-3 |   println("x")
-\x1b[90m4 | }\x1b[39m (escaped)
+1 | fn sample {
+2 |   let println = custom;
+3 >   println("x")
+4 | }
 ```
 
 ```mooncram
@@ -21,10 +21,10 @@ rule: example
 description:
   Attrs built with `inner_html(...)` carry raw DOM content.
 source:
-\x1b[90m1 | fn hit(raw, child) {\x1b[39m (escaped)
-\x1b[90m2 |   let attrs = @html.Attrs::build().inner_html(raw);\x1b[39m (escaped)
-3 |   @html.div(class="x", attrs=attrs, child)
-\x1b[90m4 | }\x1b[39m (escaped)
+1 | fn hit(raw, child) {
+2 |   let attrs = @html.Attrs::build().inner_html(raw);
+3 >   @html.div(class="x", attrs=attrs, child)
+4 | }
 ```
 
 ```mooncram
@@ -34,21 +34,21 @@ rule: example
 description:
   Sink call where positive match wins over patterns-not.
 source:
-\x1b[90m1 | fn sample {\x1b[39m (escaped)
-2 |   sink(raw);
-\x1b[90m3 |   sink(safe(raw))\x1b[39m (escaped)
-\x1b[90m4 | }\x1b[39m (escaped)
+1 | fn sample {
+2 >   sink(raw);
+3 |   sink(safe(raw))
+4 | }
 
 testdata/patterns-not-structural/src/hit.mbt:3:3-3:18
 rule: example
 description:
   Sink call where positive match wins over patterns-not.
 source:
-\x1b[90m1 | fn sample {\x1b[39m (escaped)
-\x1b[90m2 |   sink(raw);\x1b[39m (escaped)
-3 |   sink(safe(raw))
-\x1b[90m4 | }\x1b[39m (escaped)
-\x1b[90m5 | \x1b[39m (escaped)
+1 | fn sample {
+2 |   sink(raw);
+3 >   sink(safe(raw))
+4 | }
+5 | 
 ```
 
 ```mooncram
@@ -59,8 +59,8 @@ outer_loc: testdata/patterns-not-inside/src/hit.mbt:2:3-2:18
 description:
   Wrapper payload without danger.
 source:
-\x1b[90m1 | fn sample {\x1b[39m (escaped)
-2 |   wrapper(safe());
-\x1b[90m3 |   wrapper(danger());\x1b[39m (escaped)
-\x1b[90m4 |   wrapper(holder(danger()))\x1b[39m (escaped)
+1 | fn sample {
+2 >   wrapper(safe());
+3 |   wrapper(danger());
+4 |   wrapper(holder(danger()))
 ```

e2etests/LOAD.md

@@ -7,20 +7,20 @@ rule: example
 description:
   Repeated equality.
 source:
-\x1b[90m1 | fn sample {\x1b[39m (escaped)
-2 |   let same = value == value
-\x1b[90m3 |   let x = get_user_input()\x1b[39m (escaped)
-\x1b[90m4 |   sink(x)\x1b[39m (escaped)
+1 | fn sample {
+2 >   let same = value == value
+3 |   let x = get_user_input()
+4 |   sink(x)
 
 testdata/recursive-rule-discovery-src/hits.mbt:4:8-4:9
 rule: nested/example
 description:
   User input reaches sink.
 source:
-\x1b[90m2 |   let same = value == value\x1b[39m (escaped)
-\x1b[90m3 |   let x = get_user_input()\x1b[39m (escaped)
-4 |   sink(x)
-\x1b[90m5 | }\x1b[39m (escaped)
+2 |   let same = value == value
+3 |   let x = get_user_input()
+4 >   sink(x)
+5 | }
 ```
 
 ```mooncram
@@ -30,10 +30,10 @@ rule: example
 description:
   User input reaches sink.
 source:
-\x1b[90m2 |   let same = value == value\x1b[39m (escaped)
-\x1b[90m3 |   let x = get_user_input()\x1b[39m (escaped)
-4 |   sink(x)
-\x1b[90m5 | }\x1b[39m (escaped)
+2 |   let same = value == value
+3 |   let x = get_user_input()
+4 >   sink(x)
+5 | }
 ```
 
 ```mooncram