feature: adds 'highlight' option to depcruise-fmt (#676)

bin/depcruise-fmt.js

@@ -49,6 +49,10 @@ try {
       "-R, --reaches <regex>",
       "only include modules matching the regex + all modules that can reach it"
     )
+    .option(
+      "-H, --highlight <regex>",
+      "mark modules matching the regex as 'highlighted'"
+    )
     .option("-x, --exclude <regex>", "exclude all modules matching the regex")
     .option(
       "-S, --collapse <regex>",

doc/cli.md

@@ -1222,11 +1222,17 @@ depcruise-fmt -T dot --focus "^src/main" cruise_result.json | dot -T svg > main.
 depcruise-fmt -T dot --focus "^src/juggle" cruise_result.json | dot -T svg > juggle.svg
 depcruise-fmt -T dot --include-only "^src/the-law" cruise_result.json | dot -T svg > the-law.svg
 
-## or to find dependencies going into or departing from the spelunkme module
+## or to find dependencies going into or departing from the spelunk-me module
 ## and emitting them to stdout:
-depcruise-fmt -T text --focus "^src/main/spelunkme\\.ts$" cruise_result.json
+depcruise-fmt -T text --focus "^src/main/spelunk-me\\.ts$" cruise_result.json
 ```
 
+### highlight
+
+The `--highlight` option is also available in case you want to just highlight
+modules without filtering them. See the [--highlight](#highlight-highlight-modules)
+documentation of the regular depcruise command for more information.
+
 ### collapse/ summarize
 
 Summarize or collapse to either a folder depth or (if you're feeling fancy) a regular

src/cli/format.js

@@ -10,6 +10,7 @@ const KNOWN_FMT_OPTIONS = [
   "focus",
   "focusDepth",
   "help",
+  "highlight",
   "includeOnly",
   "outputTo",
   "outputType",

src/main/options/normalize.js

@@ -205,6 +205,7 @@ function normalizeFormatOptions(pFormatOptions) {
   lFormatOptions = normalizeFilterOptions(lFormatOptions, [
     "exclude",
     "focus",
+    "highlight",
     "includeOnly",
     "reaches",
   ]);