builtin/config: special-case retrieving colors without a key

Our documentation for git-config(1) has a section where it explains how
to parse and use colors as Git would configure them. In order to get the
ANSI color escape sequence to reset the colors to normal we recommend
the following command:

    $ git config get --type=color --default="reset" ""

This command is not supposed to parse any configuration keys. Instead,
it is expected to parse the "reset" default value and turn it into a
proper ANSI color escape sequence.

It was reported though [1] that this command doesn't work:

    $ git config get --type=color --default="reset" ""
    error: key does not contain a section:

This error was introduced in 4e51389000 (builtin/config: introduce "get"
subcommand, 2024-05-06), where we introduced the "get" subcommand to
retrieve configuration values. The preimage of that commit used `git
config --get-color "" "reset"` instead, which still works.

This use case is really quite specific to parsing colors, as it wouldn't
make sense to give git-config(1) a default value and an empty config key
only to return that default value unmodified. But with `--type=color` we
don't return the value directly; we instead parse the value into an ANSI
escape sequence.

As such, we can easily special-case this one use case:

    - If the provided config key is empty;

    - the user is asking for a color code; and

    - the user has provided a default value,

then we call `get_color()` directly. Do so to make the documented
command work as expected.

[1]: <aI+oQvQgnNtC6DVw@szeder.dev>

Reported-by: SZEDER Gábor <szeder.dev@gmail.com>
Signed-off-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/builtin/config.c b/builtin/config.c
index 65e79c76735e4493afc16815ce680062375dd285..cfd89a4186bdd1ccb3f54d42614f9562421e00a4 100644 (file)
--- a/builtin/config.c
+++ b/builtin/config.c
@@ -923,6 +923,8 @@ static int cmd_config_get(int argc, const char **argv, const char *prefix,
 
        if (url)
                ret = get_urlmatch(&location_opts, &display_opts, argv[0], url);
+       else if (display_opts.type == TYPE_COLOR && !strlen(argv[0]) && display_opts.default_value)
+               ret = get_color(&location_opts, "", display_opts.default_value);
        else
                ret = get_value(&location_opts, &display_opts, argv[0], value_pattern,
                                get_value_flags, flags);

diff --git a/t/t1300-config.sh b/t/t1300-config.sh
index 6d1015acfd822aeb742355b6dd60202102ba5e14..3cf5d17abab0bc5c8b901f8770d422595f0e9d96 100755 (executable)
--- a/t/t1300-config.sh
+++ b/t/t1300-config.sh
@@ -1083,11 +1083,22 @@ test_expect_success 'get --type=color' '
        rm .git/config &&
        git config ${mode_set} foo.color "red" &&
        git config --get --type=color foo.color >actual.raw &&
+       git config get --type=color foo.color >actual-subcommand.raw &&
+       test_cmp actual.raw actual-subcommand.raw &&
        test_decode_color <actual.raw >actual &&
        echo "<RED>" >expect &&
        test_cmp expect actual
 '
 
+test_expect_success 'get --type=color with default value only' '
+       git config --get-color "" "red" >actual.raw &&
+       test_decode_color <actual.raw >actual &&
+       echo "<RED>" >expect &&
+       test_cmp expect actual &&
+       git config get --type=color --default="red" "" >actual-subcommand.raw &&
+       test_cmp actual.raw actual-subcommand.raw
+'
+
 test_expect_success 'set --type=color' '
        cat >expect <<\EOF &&
 [foo]