Also use grep-highlighter for buildozer outputs.

That way it is possible to maybe only edit a subset.

Author: hzeller

bant/bant.cc

@@ -88,11 +88,12 @@ static int usage(const char *prog, const char *message, int exit_code) {
     -f <format>    : Output format, support depends on command. One of
                    : native (default), s-expr, plist, json, csv
                      Unique prefix ok, so -fs , -fp, -fj or -fc is sufficient.
-    -g <regex>     : 'grep' filter output with regular expression. Can be
+    -g <regex>     : 'grep'-filter output with regular expression. Can be
                      provided multiple times to narrow match ('and' semantics).
-                     Outputs are highlit with different colors (also see '-O')
-    -O             : 'or' smentics for for `-g`. Instead of requiring all
-                     regexs to match for a record, require one of them.
+                     Matches are highlit with different colors (also see '-O').
+    -i             : (with `-g`): Treat regex case insensitively.
+    -O             : (with `-g`): 'or' match smentics. Instead of requiring all
+                     regexs to match for a record, require at least one of them.
     -r             : Follow dependencies recursively starting from pattern.
                      Without numeric parameter, follows dependencies to the end.
                      An optional parameter allows to limit the nesting depth,
@@ -110,9 +111,7 @@ Commands (unique prefix sufficient):
                       -a : print all toplevel items in packages, not just rules.
                       -e : elaborate; light eval: expand variables, concat etc.
                       -b : elaborate including expansion of built-in macros.
-                      -g <regex> : 'grep' - only print targets where any string
-                                    matches regex.
-                      -i If '-g' is given: case insensitive
+                      -g, -i, -O work here and print the whole item on match.
     parse          : Parse all BUILD files from pattern. Follow deps with -r
                      Emit parse errors. Silent otherwise: No news are good news.
                       -v : some stats.

bant/cli-commands.cc

@@ -279,6 +279,7 @@ CliStatus RunCommand(Session &session, Command cmd,
     }
     break;
   }
+
   case Command::kExpandedLibraryHeaders:  //
     bant::PrintProvidedSources(
       session, "header", print_pattern,
@@ -316,21 +317,27 @@ CliStatus RunCommand(Session &session, Command cmd,
       ExtractGeneratedFromGenrule(project, session.info()));
     break;
 
-  case Command::kDWYU:
+  case Command::kDWYU: {
+    auto highlighter = CreateGrepHighlighterFromFlags(session);
+    if (!highlighter) return CliStatus::kExitFailure;
     if (bant::CreateDependencyEdits(
           session, project, patterns,
-          CreateBuildozerDepsEditCallback(session.out())) > 0) {
+          CreateBuildozerDepsEditCallback(session.out(), *highlighter)) > 0) {
       return CliStatus::kExitCleanupFindings;
     }
     break;
+  }
 
-  case Command::kCanonicalizeDeps:
+  case Command::kCanonicalizeDeps: {
+    auto highlighter = CreateGrepHighlighterFromFlags(session);
+    if (!highlighter) return CliStatus::kExitFailure;
     if (CreateCanonicalizeEdits(
           session, project, patterns,
-          CreateBuildozerDepsEditCallback(session.out())) > 0) {
+          CreateBuildozerDepsEditCallback(session.out(), *highlighter)) > 0) {
       return CliStatus::kExitCleanupFindings;
     }
     break;
+  }
 
   case Command::kListPackages: {
     auto highlighter = CreateGrepHighlighterFromFlags(session);
@@ -342,7 +349,8 @@ CliStatus RunCommand(Session &session, Command cmd,
       printer->AddRow({std::string(parsed->name()), package.ToString()});
     }
     printer->Finish();
-  } break;
+    break;
+  }
 
   case Command::kListLeafs:
   case Command::kListTargets: {
@@ -369,7 +377,8 @@ CliStatus RunCommand(Session &session, Command cmd,
       });
     }
     printer->Finish();
-  } break;
+    break;
+  }
 
   case Command::kListWorkkspace:
     PrintMatchingWorkspaceExternalRepos(session, project, patterns);

bant/tool/BUILD

@@ -11,6 +11,7 @@ cc_library(
     hdrs = ["edit-callback.h"],
     deps = [
         "//bant:types-bazel",
+        "//bant/util:grep-highlighter",
     ],
 )
 

bant/tool/edit-callback.cc

@@ -18,26 +18,30 @@
 #include "bant/tool/edit-callback.h"
 
 #include <ostream>
+#include <sstream>
 #include <string_view>
 
 #include "bant/types-bazel.h"
+#include "bant/util/grep-highlighter.h"
 
 namespace bant {
-EditCallback CreateBuildozerDepsEditCallback(std::ostream &out) {
-  return [&out](EditRequest edit, const BazelTarget &target,
-                std::string_view before, std::string_view after) {
+EditCallback CreateBuildozerDepsEditCallback(std::ostream &out,
+                                             const GrepHighlighter &grepper) {
+  return [&out, &grepper](EditRequest edit, const BazelTarget &target,
+                          std::string_view before, std::string_view after) {
+    std::stringstream tmp_out;
     switch (edit) {
     case EditRequest::kRemove:
-      out << "buildozer 'remove deps " << before << "' " << target << "\n";
+      tmp_out << "'remove deps " << before << "' " << target;
       break;
     case EditRequest::kAdd:
-      out << "buildozer 'add deps " << after << "' " << target << "\n";
+      tmp_out << "'add deps " << after << "' " << target;
       break;
     case EditRequest::kRename:
-      out << "buildozer 'replace deps " << before << " " << after << "' "
-          << target << "\n";
+      tmp_out << "'replace deps " << before << " " << after << "' " << target;
       break;
     }
+    grepper.EmitMatch(tmp_out.str(), out, "buildozer ", "\n");
   };
 }
 

bant/tool/edit-callback.h

@@ -23,6 +23,7 @@
 #include <string_view>
 
 #include "bant/types-bazel.h"
+#include "bant/util/grep-highlighter.h"
 
 namespace bant {
 
@@ -47,8 +48,11 @@ using EditCallback =
   std::function<void(EditRequest op, const BazelTarget &target,
                      std::string_view before, std::string_view after)>;
 
-// Create an EditCallback function that writes "buildozer" dep-edits to "out".
-EditCallback CreateBuildozerDepsEditCallback(std::ostream &out);
+// Create an EditCallback function that writes "buildozer" dep-edits to "out"
+// The GrepHighlighter needs to be alive for the duration of the use of
+// the callback.
+EditCallback CreateBuildozerDepsEditCallback(std::ostream &out,
+                                             const GrepHighlighter &grepper);
 
 }  // namespace bant
 #endif  // BANT_TOOL_EDIT_CALLBACK_