Skip to content

Commit

Permalink
help: add prompt-yes setting for autocorrect
Browse files Browse the repository at this point in the history
The help.autocorrect functionality is really useful, saving frustration
when a dev fat-fingers a command, and git has a pretty good idea what
was originally intended. The config settings are a nice selection, with
"prompt" asking the user to confirm that they want to run the assumed
command.

However, with "prompt", the choice defaults to "No" - that is, hitting
return will _not_ run the command. For me at least, if git is confident
it knows which command I wanted, it's usually right, and the golden path
would be to run the command.

Therefore this patch adds "prompt-yes" as a counterpart config setting
for help.autocorrect, which does the same as "prompt", but defaults to
"Yes" - hitting return will run the assumed command.

I have not added any tests because the test suite doesn't have any tests
(that I could find) for the "prompt" behaviour - I'm assuming this is
because it's hard/impossible to simulate the interactive terminal prompt

Signed-off-by: Chris Howlett <[email protected]>
  • Loading branch information
asilano committed Feb 17, 2025
1 parent 0394451 commit cade4f1
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
4 changes: 3 additions & 1 deletion Documentation/config/help.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ immediately.
deciseconds (0.1 sec).
- "never": don't run or show any suggested command.
- "prompt": show the suggestion and prompt for confirmation to run
the command.
the command. The default choice at the prompt is "No"
- "prompt-yes": show the suggestion and prompt for confirmation to run
the command. The default choice at the prompt is "Yes"

help.htmlPath::
Specify the path where the HTML documentation resides. File system paths
Expand Down
15 changes: 15 additions & 0 deletions help.c
Original file line number Diff line number Diff line change
Expand Up @@ -552,6 +552,7 @@ struct help_unknown_cmd_config {
struct cmdnames aliases;
};

#define AUTOCORRECT_PROMPT_YES (-5)
#define AUTOCORRECT_SHOW (-4)
#define AUTOCORRECT_PROMPT (-3)
#define AUTOCORRECT_NEVER (-2)
Expand All @@ -570,6 +571,8 @@ static int parse_autocorrect(const char *value)

if (!strcmp(value, "prompt"))
return AUTOCORRECT_PROMPT;
if (!strcmp(value, "prompt-yes"))
return AUTOCORRECT_PROMPT_YES;
if (!strcmp(value, "never"))
return AUTOCORRECT_NEVER;
if (!strcmp(value, "immediate"))
Expand Down Expand Up @@ -650,6 +653,9 @@ char *help_unknown_cmd(const char *cmd)
if ((cfg.autocorrect == AUTOCORRECT_PROMPT) && (!isatty(0) || !isatty(2)))
cfg.autocorrect = AUTOCORRECT_NEVER;

if ((cfg.autocorrect == AUTOCORRECT_PROMPT_YES) && (!isatty(0) || !isatty(2)))
cfg.autocorrect = AUTOCORRECT_IMMEDIATELY;

if (cfg.autocorrect == AUTOCORRECT_NEVER) {
fprintf_ln(stderr, _("git: '%s' is not a git command. See 'git --help'."), cmd);
exit(1);
Expand Down Expand Up @@ -738,6 +744,15 @@ char *help_unknown_cmd(const char *cmd)
if (!(starts_with(answer, "y") ||
starts_with(answer, "Y")))
exit(1);
} else if (cfg.autocorrect == AUTOCORRECT_PROMPT_YES) {
char *answer;
struct strbuf msg = STRBUF_INIT;
strbuf_addf(&msg, _("Run '%s' instead [Y/n]? "), assumed);
answer = git_prompt(msg.buf, PROMPT_ECHO);
strbuf_release(&msg);
if (starts_with(answer, "n") ||
starts_with(answer, "N"))
exit(1);
} else {
fprintf_ln(stderr,
_("Continuing in %0.1f seconds, "
Expand Down

0 comments on commit cade4f1

Please sign in to comment.