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

[PATCH 1/2] Added basic color support to git add --interactive

From
DZDan Zwell <dzwell@zwell.net>
Date
Nov 3, 2007, 03:41 UTC
Message-ID
<20071102224100.71665182@paradox.zwell.net>
In-Reply-To
<20071023035221.66ea537f@danzwell.com>
From 29b34bb32846921c9432bf1b74c93d06a0667a44 Mon Sep 17 00:00:00 2001
From: Dan Zwell <dzwell@zwell.net>
Date: Mon, 22 Oct 2007 15:55:20 -0500
Subject: [PATCH] Added basic color support to git add --interactive

Added function "print_colored" that prints text with a color that is passed in. Converted many calls to "print" to being calls to "print_colored".

The prompt, the header, and the help output are the 3 types of colorized output, and each has its own color.

Colorization is done through Term::ANSIColor, which is included with modern versions of perl. This is optional, and should not need to be present if color.interactive is not turned on.

Signed-off-by: Dan Zwell <dzwell@zwell.net>
---
I believe this version takes care of the complaints people had
with this patch. I hope this is helpful.
 Documentation/config.txt  |    6 ++++++
 git-add--interactive.perl |   42 ++++++++++++++++++++++++++++++++++++------
 2 files changed, 42 insertions(+), 6 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index edf50cd..2fd783f 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -382,6 +382,12 @@ color.diff.<slot>::
 	whitespace).  The values of these variables may be specified as
 	in color.branch.<slot>.
 
+color.interactive::
+	When true (or `always`), always use colors in `git add
+	--interactive`.  When false (or `never`), never.  When set to
+	`auto`, use colors only when the output is to the
+	terminal. Defaults to false.
+
 color.pager::
 	A boolean to enable/disable colored output when the pager is in
 	use (default is true).
diff --git a/git-add--interactive.perl b/git-add--interactive.perl
index ac598f8..16dc7b0 100755
--- a/git-add--interactive.perl
+++ b/git-add--interactive.perl
@@ -2,6 +2,36 @@
 
 use strict;
 
+my ($use_color, $prompt_color, $header_color, $help_color, $normal_color);
+my $color_config = qx(git config --get color.interactive);
+if ($color_config=~/true|always/ || -t STDOUT && $color_config=~/auto/) {
+	require Term::ANSIColor;
+
+	$use_color = "true";
+	# Sane (visible) defaults:
+	$prompt_color = Term::ANSIColor::color("blue bold");
+	$header_color = Term::ANSIColor::color("bold");
+	$help_color   = Term::ANSIColor::color("red bold");
+	$normal_color = Term::ANSIColor::color("reset");
+}
+
+sub print_colored {
+	my $color = shift;
+	my $string = join("", @_);
+
+	if ($use_color) {
+		# Put a color code at the beginning of each line, a reset at the end
+		# color after newlines that are not at the end of the string
+		$string =~ s/(\n+)(.)/$1$color$2/g;
+		# reset before newlines
+		$string =~ s/(\n+)/$normal_color$1/g;
+		# codes at beginning and end (if necessary):
+		$string =~ s/^/$color/;
+		$string =~ s/$/$normal_color/ unless $string =~ /\n$/;
+	}
+	print $string;
+}
+
 sub run_cmd_pipe {
 	if ($^O eq 'MSWin32') {
 		my @invalid = grep {m/[":*]/} @_;
@@ -175,7 +205,7 @@ sub list_and_choose {
 			if (!$opts->{LIST_FLAT}) {
 				print "     ";
 			}
-			print "$opts->{HEADER}\n";
+			print_colored $header_color, "$opts->{HEADER}\n";
 		}
 		for ($i = 0; $i < @stuff; $i++) {
 			my $chosen = $chosen[$i] ? '*' : ' ';
@@ -205,7 +235,7 @@ sub list_and_choose {
 
 		return if ($opts->{LIST_ONLY});
 
-		print $opts->{PROMPT};
+		print_colored $prompt_color, $opts->{PROMPT};
 		if ($opts->{SINGLETON}) {
 			print "> ";
 		}
@@ -544,7 +574,7 @@ sub coalesce_overlapping_hunks {
 }
 
 sub help_patch_cmd {
-	print <<\EOF ;
+	print_colored $help_color, <<\EOF ;
 y - stage this hunk
 n - do not stage this hunk
 a - stage this and all the remaining hunks
@@ -619,7 +649,7 @@ sub patch_update_cmd {
 		for (@{$hunk[$ix]{TEXT}}) {
 			print;
 		}
-		print "Stage this hunk [y/n/a/d$other/?]? ";
+		print_colored $prompt_color, "Stage this hunk [y/n/a/d$other/?]? ";
 		my $line = <STDIN>;
 		if ($line) {
 			if ($line =~ /^y/i) {
@@ -673,7 +703,7 @@ sub patch_update_cmd {
 			elsif ($other =~ /s/ && $line =~ /^s/) {
 				my @split = split_hunk($hunk[$ix]{TEXT});
 				if (1 < @split) {
-					print "Split into ",
+					print_colored $header_color, "Split into ",
 					scalar(@split), " hunks.\n";
 				}
 				splice(@hunk, $ix, 1,
@@ -766,7 +796,7 @@ sub quit_cmd {
 }
 
 sub help_cmd {
-	print <<\EOF ;
+	print_colored $help_color, <<\EOF ;
 status        - show paths with changes
 update        - add working tree state to the staged set of changes
 revert        - revert staged set of changes back to the HEAD version

-- 
1.5.3.5.474.g3e4bb



>From 29b34bb32846921c9432bf1b74c93d06a0667a44 Mon Sep 17 00:00:00 2001
From: Dan Zwell <dzwell@zwell.net>
Date: Mon, 22 Oct 2007 15:55:20 -0500
Subject: [PATCH] Added basic color support to git add --interactive

Added function "print_colored" that prints text with a color that
is passed in. Converted many calls to "print" to being calls to
"print_colored".

The prompt, the header, and the help output are the 3 types of
colorized output, and each has its own color.

Colorization is done through Term::ANSIColor, which is included
with modern versions of perl. This is optional, and should not
need to be present if color.interactive is not turned on.

Signed-off-by: Dan Zwell <dzwell@zwell.net>
---
 Documentation/config.txt  |    6 ++++++
 git-add--interactive.perl |   42 ++++++++++++++++++++++++++++++++++++------
 2 files changed, 42 insertions(+), 6 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index edf50cd..2fd783f 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -382,6 +382,12 @@ color.diff.<slot>::
 	whitespace).  The values of these variables may be specified as
 	in color.branch.<slot>.
 
+color.interactive::
+	When true (or `always`), always use colors in `git add
+	--interactive`.  When false (or `never`), never.  When set to
+	`auto`, use colors only when the output is to the
+	terminal. Defaults to false.
+
 color.pager::
 	A boolean to enable/disable colored output when the pager is in
 	use (default is true).
diff --git a/git-add--interactive.perl b/git-add--interactive.perl
index ac598f8..16dc7b0 100755
--- a/git-add--interactive.perl
+++ b/git-add--interactive.perl
@@ -2,6 +2,36 @@
 
 use strict;
 
+my ($use_color, $prompt_color, $header_color, $help_color, $normal_color);
+my $color_config = qx(git config --get color.interactive);
+if ($color_config=~/true|always/ || -t STDOUT && $color_config=~/auto/) {
+	require Term::ANSIColor;
+
+	$use_color = "true";
+	# Sane (visible) defaults:
+	$prompt_color = Term::ANSIColor::color("blue bold");
+	$header_color = Term::ANSIColor::color("bold");
+	$help_color   = Term::ANSIColor::color("red bold");
+	$normal_color = Term::ANSIColor::color("reset");
+}
+
+sub print_colored {
+	my $color = shift;
+	my $string = join("", @_);
+
+	if ($use_color) {
+		# Put a color code at the beginning of each line, a reset at the end
+		# color after newlines that are not at the end of the string
+		$string =~ s/(\n+)(.)/$1$color$2/g;
+		# reset before newlines
+		$string =~ s/(\n+)/$normal_color$1/g;
+		# codes at beginning and end (if necessary):
+		$string =~ s/^/$color/;
+		$string =~ s/$/$normal_color/ unless $string =~ /\n$/;
+	}
+	print $string;
+}
+
 sub run_cmd_pipe {
 	if ($^O eq 'MSWin32') {
 		my @invalid = grep {m/[":*]/} @_;
@@ -175,7 +205,7 @@ sub list_and_choose {
 			if (!$opts->{LIST_FLAT}) {
 				print "     ";
 			}
-			print "$opts->{HEADER}\n";
+			print_colored $header_color, "$opts->{HEADER}\n";
 		}
 		for ($i = 0; $i < @stuff; $i++) {
 			my $chosen = $chosen[$i] ? '*' : ' ';
@@ -205,7 +235,7 @@ sub list_and_choose {
 
 		return if ($opts->{LIST_ONLY});
 
-		print $opts->{PROMPT};
+		print_colored $prompt_color, $opts->{PROMPT};
 		if ($opts->{SINGLETON}) {
 			print "> ";
 		}
@@ -544,7 +574,7 @@ sub coalesce_overlapping_hunks {
 }
 
 sub help_patch_cmd {
-	print <<\EOF ;
+	print_colored $help_color, <<\EOF ;
 y - stage this hunk
 n - do not stage this hunk
 a - stage this and all the remaining hunks
@@ -619,7 +649,7 @@ sub patch_update_cmd {
 		for (@{$hunk[$ix]{TEXT}}) {
 			print;
 		}
-		print "Stage this hunk [y/n/a/d$other/?]? ";
+		print_colored $prompt_color, "Stage this hunk [y/n/a/d$other/?]? ";
 		my $line = <STDIN>;
 		if ($line) {
 			if ($line =~ /^y/i) {
@@ -673,7 +703,7 @@ sub patch_update_cmd {
 			elsif ($other =~ /s/ && $line =~ /^s/) {
 				my @split = split_hunk($hunk[$ix]{TEXT});
 				if (1 < @split) {
-					print "Split into ",
+					print_colored $header_color, "Split into ",
 					scalar(@split), " hunks.\n";
 				}
 				splice(@hunk, $ix, 1,
@@ -766,7 +796,7 @@ sub quit_cmd {
 }
 
 sub help_cmd {
-	print <<\EOF ;
+	print_colored $help_color, <<\EOF ;
 status        - show paths with changes
 update        - add working tree state to the staged set of changes
 revert        - revert staged set of changes back to the HEAD version
-- 
1.5.3.5.474.g3e4bb
Previous: Dan ZwellNext: Jeff King
Message 33 of 86 in “Color support added to git-add--interactive.”
  1. Color support added to git-add--interactive.Dan Zwell, Oct 13, 2007
  2. Jeff KingOct 13, 2007
  3. Frank LichtenheldOct 13, 2007
  4. Johannes SchindelinOct 13, 2007
  5. Wincent ColaiutaOct 13, 2007
  6. Jean-Luc HerrenOct 13, 2007
  7. Wincent ColaiutaOct 13, 2007
  8. Andreas EricssonOct 13, 2007
  9. Johannes SchindelinOct 13, 2007
  10. Jeff KingOct 13, 2007
  11. Jeff KingOct 13, 2007
  12. Dan ZwellOct 13, 2007
  13. Wincent ColaiutaOct 13, 2007
  14. Dan ZOct 13, 2007
  15. Jean-Luc HerrenOct 13, 2007
  16. Jeff KingOct 15, 2007
  17. Dan ZwellOct 17, 2007
  18. Shawn O. PearceOct 17, 2007
  19. Dan ZwellOct 17, 2007
  20. Shawn O. PearceOct 17, 2007
  21. 1/2 Added basic color support to git add --interactiveDan Zwell, Oct 22, 2007
  22. Dan ZwellOct 23, 2007
  23. Let git-add--interactive read "git colors" from git-configDan Zwell, Oct 23, 2007
  24. Jeff KingOct 23, 2007
  25. Shawn O. PearceOct 23, 2007
  26. Jeff KingOct 23, 2007
  27. Wincent ColaiutaOct 23, 2007
  28. Jeff KingOct 23, 2007
  29. Wincent ColaiutaOct 23, 2007
  30. 2/2 Let git-add--interactive read colors from git-configDan Zwell, Oct 22, 2007
  31. Jeff KingOct 23, 2007
  32. Dan ZwellOct 23, 2007
  33. 1/2 Added basic color support to git add --interactiveDan Zwell, Nov 3, 2007
  34. Jeff KingNov 4, 2007
  35. Junio C HamanoNov 4, 2007
  36. Jeff KingNov 4, 2007
  37. 0/3 Adding colors to git-add--interactiveDan Zwell, Nov 11, 2007
  38. Jeff KingNov 11, 2007
  39. Junio C HamanoNov 11, 2007
  40. Dan ZwellNov 11, 2007
  41. 0/5 Colors for git-add--interactiveDan Zwell, Nov 22, 2007
  42. Jeff KingNov 22, 2007
  43. Junio C HamanoNov 22, 2007
  44. 1/5 Added basic color support to git add --interactiveDan Zwell, Nov 22, 2007
  45. 2/5 Don't return 'undef' in case called in a vector context.Dan Zwell, Nov 22, 2007
  46. Jeff KingNov 22, 2007
  47. Junio C HamanoNov 22, 2007
  48. Dan ZwellNov 23, 2007
  49. 3/5 Added config_default($key, $default) to Git.pmDan Zwell, Nov 22, 2007
  50. Jeff KingNov 22, 2007
  51. 4/5 Let git-add--interactive read colors from configurationDan Zwell, Nov 22, 2007
  52. Jeff KingNov 22, 2007
  53. Junio C HamanoNov 22, 2007
  54. Jeff KingNov 22, 2007
  55. Dan ZwellNov 23, 2007
  56. Jeff KingNov 23, 2007
  57. Junio C HamanoNov 23, 2007
  58. 5/5 Added diff hunk coloring to git-add--interactiveDan Zwell, Nov 22, 2007
  59. Jeff KingNov 22, 2007
  60. Junio C HamanoNov 22, 2007
  61. Jeff KingNov 23, 2007
  62. Junio C HamanoNov 22, 2007
  63. 1/3 Added basic color support to git add --interactiveDan Zwell, Nov 11, 2007
  64. 2/3 Let git-add--interactive read colors from .gitconfigDan Zwell, Nov 11, 2007
  65. 3/3 Added diff hunk coloring to git-add--interactiveDan Zwell, Nov 11, 2007
  66. Junio C HamanoNov 11, 2007
  67. 0/3 Adding colors to git-add--interactiveDan Zwell, Nov 11, 2007
  68. Subject: [PATCH 1/3] Added basic color support to git add --interactiveDan Zwell, Nov 11, 2007
  69. Junio C HamanoNov 11, 2007
  70. Subject: [PATCH 2/3] Let git-add--interactive read colors from .gitconfigDan Zwell, Nov 11, 2007
  71. Junio C HamanoNov 11, 2007
  72. Junio C HamanoNov 11, 2007
  73. Dan ZwellNov 13, 2007
  74. Junio C HamanoNov 13, 2007
  75. Dan ZwellNov 13, 2007
  76. Jeff KingNov 13, 2007
  77. Junio C HamanoNov 13, 2007
  78. Dan ZwellNov 13, 2007
  79. Jakub NarebskiNov 13, 2007
  80. 2/2 Let git-add--interactive read colors from .gitconfigDan Zwell, Nov 3, 2007
  81. Junio C HamanoNov 3, 2007
  82. Dan ZwellNov 3, 2007
  83. Junio C HamanoNov 3, 2007
  84. Jeff KingOct 15, 2007
  85. Tom TobinOct 13, 2007
  86. Tom TobinOct 13, 2007

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.