git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2 7/8] diff-highlight: allow module callers to pass in color config

From
Jeff King <peff@peff.net>
Date
Mar 23, 2026, 06:02 UTC
Message-ID
<20260323060215.GG10482@coredump.intra.peff.net>
In-Reply-To
<20260323060139.GA10215@coredump.intra.peff.net>
From: Scott Baker <scott@perturb.org>

Users of the module may want to pass in their own color config for a few obvious reasons:

  - they are pulling the config from different variables than
    diff-highlight itself uses
  - they are loading the config in a more efficient way (say, by parsing
    git-config --list) and don't want to incur the six (!) git-config
    calls that DiffHighlight.pm runs to check all config

Let's allow users of the module to pass in the color config, and lazy-load it when needed if they haven't.

Signed-off-by: Scott Baker <scott@perturb.org>
Signed-off-by: Jeff King <peff@peff.net>
---
 contrib/diff-highlight/DiffHighlight.pm | 41 +++++++++++++++++--------
 contrib/diff-highlight/README           |  6 ++++
 2 files changed, 35 insertions(+), 12 deletions(-)
diff --git a/contrib/diff-highlight/DiffHighlight.pm b/contrib/diff-highlight/DiffHighlight.pm
index a5e5de3b18..96369eadf9 100644
--- a/contrib/diff-highlight/DiffHighlight.pm
+++ b/contrib/diff-highlight/DiffHighlight.pm
@@ -9,18 +9,11 @@ package DiffHighlight;
 
 my $NULL = File::Spec->devnull();
 
-# Highlight by reversing foreground and background. You could do
-# other things like bold or underline if you prefer.
-my @OLD_HIGHLIGHT = (
-	color_config('color.diff-highlight.oldnormal'),
-	color_config('color.diff-highlight.oldhighlight', "\x1b[7m"),
-	color_config('color.diff-highlight.oldreset', "\x1b[27m")
-);
-my @NEW_HIGHLIGHT = (
-	color_config('color.diff-highlight.newnormal', $OLD_HIGHLIGHT[0]),
-	color_config('color.diff-highlight.newhighlight', $OLD_HIGHLIGHT[1]),
-	color_config('color.diff-highlight.newreset', $OLD_HIGHLIGHT[2])
-);
+# The color theme is initially set to nothing here to allow outside callers
+# to set the colors for their application. If nothing is sent in we use
+# colors from git config in load_color_config().
+our @OLD_HIGHLIGHT = ();
+our @NEW_HIGHLIGHT = ();
 
 my $RESET = "\x1b[m";
 my $COLOR = qr/\x1b\[[0-9;]*m/;
@@ -170,6 +163,29 @@ sub show_hunk {
 	$line_cb->(@queue);
 }
 
+sub load_color_config {
+	# If the colors were NOT set from outside this module we load them on-demand
+	# from the git config. Note that only one of elements 0 and 2 in each
+	# array is used (depending on whether you are doing set/unset on an
+	# attribute, or specifying normal vs highlighted coloring). So we use
+	# element 1 as our check for whether colors were passed in; it should
+	# always be set if you want highlighting to do anything.
+	if (!defined $OLD_HIGHLIGHT[1]) {
+		@OLD_HIGHLIGHT = (
+			color_config('color.diff-highlight.oldnormal'),
+			color_config('color.diff-highlight.oldhighlight', "\x1b[7m"),
+			color_config('color.diff-highlight.oldreset', "\x1b[27m")
+		);
+	}
+	if (!defined $NEW_HIGHLIGHT[1]) {
+		@NEW_HIGHLIGHT = (
+			color_config('color.diff-highlight.newnormal', $OLD_HIGHLIGHT[0]),
+			color_config('color.diff-highlight.newhighlight', $OLD_HIGHLIGHT[1]),
+			color_config('color.diff-highlight.newreset', $OLD_HIGHLIGHT[2])
+		);
+	};
+}
+
 sub highlight_pair {
 	my @a = split_line(shift);
 	my @b = split_line(shift);
@@ -218,6 +234,7 @@ sub highlight_pair {
 	}
 
 	if (is_pair_interesting(\@a, $pa, $sa, \@b, $pb, $sb)) {
+		load_color_config();
 		return highlight_line(\@a, $pa, $sa, \@OLD_HIGHLIGHT),
 		       highlight_line(\@b, $pb, $sb, \@NEW_HIGHLIGHT);
 	}
diff --git a/contrib/diff-highlight/README b/contrib/diff-highlight/README
index 9c89146fb0..ed8d876a18 100644
--- a/contrib/diff-highlight/README
+++ b/contrib/diff-highlight/README
@@ -138,6 +138,12 @@ Your script may set up one or more of the following variables:
     processing a logical chunk of input). The default function flushes
     stdout.
 
+  - @DiffHighlight::OLD_HIGHLIGHT and @DiffHighlight::NEW_HIGHLIGHT - these
+    arrays specify the normal, highlighted, and reset colors (in that order)
+    for old/new lines. If unset, values will be retrieved by calling `git
+    config` (see "Color Config" above). Note that these should be the literal
+    color bytes (starting with an ANSI escape code), not color names.
+
 The script may then feed lines, one at a time, to DiffHighlight::handle_line().
 When lines are done processing, they will be fed to $line_cb. Note that
 DiffHighlight may queue up many input lines (to analyze a whole hunk)
-- 
2.53.0.1051.ga14e96f895
Previous: Jeff KingNext: Jeff King
Message 25 of 28 in “some diff-highlight tweaks”
  1. 0/8 some diff-highlight tweaksJeff King, Mar 20, 2026
  2. 1/8 diff-highlight: mention build instructionsJeff King, Mar 20, 2026
  3. 2/8 diff-highlight: drop perl version dependency back to 5.8Jeff King, Mar 20, 2026
  4. 3/8 diff-highlight: check diff-highlight exit status in testsJeff King, Mar 20, 2026
  5. 4/8 t: add matching negative attributes to test_decode_colorJeff King, Mar 20, 2026
  6. 5/8 diff-highlight: use test_decode_color in testsJeff King, Mar 20, 2026
  7. Tian YuchenMar 22, 2026
  8. Jeff KingMar 22, 2026
  9. Tian YuchenMar 23, 2026
  10. Jeff KingMar 23, 2026
  11. 6/8 diff-highlight: test color configJeff King, Mar 20, 2026
  12. 7/8 diff-highlight: allow module callers to pass in color configJeff King, Mar 20, 2026
  13. 8/8 diff-highlight: fetch all config with one processJeff King, Mar 20, 2026
  14. Tian YuchenMar 22, 2026
  15. Jeff KingMar 22, 2026
  16. Tian YuchenMar 23, 2026
  17. Jeff KingMar 23, 2026
  18. 0/8 some diff-highlight tweaksJeff King, Mar 23, 2026
  19. 1/8 diff-highlight: mention build instructionsJeff King, Mar 23, 2026
  20. 2/8 diff-highlight: drop perl version dependency back to 5.8Jeff King, Mar 23, 2026
  21. 3/8 diff-highlight: check diff-highlight exit status in testsJeff King, Mar 23, 2026
  22. 4/8 t: add matching negative attributes to test_decode_colorJeff King, Mar 23, 2026
  23. 5/8 diff-highlight: use test_decode_color in testsJeff King, Mar 23, 2026
  24. 6/8 diff-highlight: test color configJeff King, Mar 23, 2026
  25. 7/8 diff-highlight: allow module callers to pass in color configJeff King, Mar 23, 2026
  26. 8/8 diff-highlight: fetch all config with one processJeff King, Mar 23, 2026
  27. Junio C HamanoMar 23, 2026
  28. Patrick SteinhardtMar 24, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.