[PATCH v4 0/8] completion: improvements for git-bisect

From: Britton Leo Kerin <britton.kerin@gmail.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>,
	Patrick Steinhardt <ps@pks.im>,
	Britton Leo Kerin <britton.kerin@gmail.com>
Subject: [PATCH v4 0/8] completion: improvements for git-bisect
Date: Sun, 28 Jan 2024 13:34:39 -0900	[thread overview]
Message-ID: <20240128223447.342493-1-britton.kerin@gmail.com> (raw)
In-Reply-To: <20240118204323.1113859-1-britton.kerin@gmail.com>

Relative to v3 this reworks the commit contents and descriptions
according to review suggestions, removes unnecessary case statements and
precondition, adds option completion for the terms subcommand, and adds
tests.

Britton Leo Kerin (8):
  completion: bisect: complete bad, new, old, and help subcommands
  completion: bisect: complete custom terms and related options
  completion: bisect: complete missing --first-parent and --no-checkout
    options
  completion: new function __git_complete_log_opts
  completion: log: use __git_complete_log_opts
  completion: bisect: complete log opts for visualize subcommand
  completion: bisect: recognize but do not complete view subcommand
  completion: add tests for git-bisect

 contrib/completion/git-completion.bash |  65 ++++++++++--
 t/t9902-completion.sh                  | 135 +++++++++++++++++++++++++
 2 files changed, 193 insertions(+), 7 deletions(-)

Range-diff against v3:
1:  e16264bfb9 ! 1:  66153024c3 completion: complete new old actions, start opts
    @@ Metadata
     Author: Britton Leo Kerin <britton.kerin@gmail.com>

      ## Commit message ##
    -    completion: complete new old actions, start opts
    +    completion: bisect: complete bad, new, old, and help subcommands
    +
    +    The bad, new, old and help subcommands to git-bisect(1) are not
    +    completed.
    +
    +    Add the bad, new, old, and help subcommands to the appropriate lists
    +    such that the commands and their possible ref arguments are completed.

         Signed-off-by: Britton Leo Kerin <britton.kerin@gmail.com>

    @@ contrib/completion/git-completion.bash: _git_bisect ()
      	__git_has_doubledash && return

     -	local subcommands="start bad good skip reset visualize replay log run"
    -+	local subcommands="start bad new good old terms skip reset visualize replay log run help"
    ++	local subcommands="start bad new good old skip reset visualize replay log run help"
      	local subcommand="$(__git_find_on_cmdline "$subcommands")"
      	if [ -z "$subcommand" ]; then
      		__git_find_repo_path
    @@ contrib/completion/git-completion.bash: _git_bisect ()

      	case "$subcommand" in
     -	bad|good|reset|skip|start)
    -+	start)
    -+		case "$cur" in
    -+		--*)
    -+			__gitcomp "--term-new --term-bad --term-old --term-good --first-parent --no-checkout"
    -+			return
    -+			;;
    -+		*)
    -+			;;
    -+		esac
    -+		;;
    -+	esac
    -+
    -+	case "$subcommand" in
     +	bad|new|good|old|reset|skip|start)
      		__git_complete_refs
      		;;
2:  130abe3460 < -:  ---------- completion: git-log opts to bisect visualize
-:  ---------- > 2:  7eb8c842a3 completion: bisect: complete custom terms and related options
-:  ---------- > 3:  5f5076bb93 completion: bisect: complete missing --first-parent and --no-checkout options
3:  d659ace9c2 ! 4:  c8ffa0e915 completion: move to maintain define-before-use
    @@ Metadata
     Author: Britton Leo Kerin <britton.kerin@gmail.com>

      ## Commit message ##
    -    completion: move to maintain define-before-use
    +    completion: new function __git_complete_log_opts
    +
    +    The options accepted by git-log are also accepted by at least one other
    +    command (git-bisect).  Prepare to factor out the common option and
    +    option argument completion code by defining a new function.

         Signed-off-by: Britton Leo Kerin <britton.kerin@gmail.com>

      ## contrib/completion/git-completion.bash ##
    -@@ contrib/completion/git-completion.bash: _git_archive ()
    - 	__git_complete_file
    - }
    +@@ contrib/completion/git-completion.bash: __git_diff_merges_opts="off none on first-parent 1 separate m combined c dense-c
    + __git_log_pretty_formats="oneline short medium full fuller reference email raw format: tformat: mboxrd"
    + __git_log_date_formats="relative iso8601 iso8601-strict rfc2822 short local default human raw unix auto: format:"

    -+# Options that go well for log, shortlog and gitk
    -+__git_log_common_options="
    -+	--not --all
    -+	--branches --tags --remotes
    -+	--first-parent --merges --no-merges
    -+	--max-count=
    -+	--max-age= --since= --after=
    -+	--min-age= --until= --before=
    -+	--min-parents= --max-parents=
    -+	--no-min-parents --no-max-parents
    -+"
    -+# Options that go well for log and gitk (not shortlog)
    -+__git_log_gitk_options="
    -+	--dense --sparse --full-history
    -+	--simplify-merges --simplify-by-decoration
    -+	--left-right --notes --no-notes
    -+"
    -+# Options that go well for log and shortlog (not gitk)
    -+__git_log_shortlog_options="
    -+	--author= --committer= --grep=
    -+	--all-match --invert-grep
    -+"
    -+# Options accepted by log and show
    -+__git_log_show_options="
    -+	--diff-merges --diff-merges= --no-diff-merges --dd --remerge-diff
    -+"
    -+
    -+__git_diff_merges_opts="off none on first-parent 1 separate m combined c dense-combined cc remerge r"
    -+
    -+__git_log_pretty_formats="oneline short medium full fuller reference email raw format: tformat: mboxrd"
    -+__git_log_date_formats="relative iso8601 iso8601-strict rfc2822 short local default human raw unix auto: format:"
    -+
    -+# Check for only porcelain (i.e. not git-rev-list) option (not argument)
    -+# and selected option argument completions for git-log options and if any
    -+# are found put them in COMPREPLY.  COMPREPLY must be empty at the start,
    -+# and will be empty on return if no candidates are found.
    ++# Complete porcelain (i.e. not git-rev-list) options and at least some
    ++# option arguments accepted by git-log.  Note that this same set of options
    ++# are also accepted by some other git commands besides git-log.
     +__git_complete_log_opts ()
     +{
    -+	[ -z "$COMPREPLY" ] || return 1   # Precondition
    ++        COMPREPLY=""
     +
     +	local merge=""
     +	if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
    @@ contrib/completion/git-completion.bash: _git_archive ()
     +	esac
     +}
     +
    - _git_bisect ()
    - {
    - 	__git_has_doubledash && return
    -@@ contrib/completion/git-completion.bash: _git_ls_tree ()
    - 	__git_complete_file
    - }
    -
    --# Options that go well for log, shortlog and gitk
    --__git_log_common_options="
    --	--not --all
    --	--branches --tags --remotes
    --	--first-parent --merges --no-merges
    --	--max-count=
    --	--max-age= --since= --after=
    --	--min-age= --until= --before=
    --	--min-parents= --max-parents=
    --	--no-min-parents --no-max-parents
    --"
    --# Options that go well for log and gitk (not shortlog)
    --__git_log_gitk_options="
    --	--dense --sparse --full-history
    --	--simplify-merges --simplify-by-decoration
    --	--left-right --notes --no-notes
    --"
    --# Options that go well for log and shortlog (not gitk)
    --__git_log_shortlog_options="
    --	--author= --committer= --grep=
    --	--all-match --invert-grep
    --"
    --# Options accepted by log and show
    --__git_log_show_options="
    --	--diff-merges --diff-merges= --no-diff-merges --dd --remerge-diff
    --"
    --
    --__git_diff_merges_opts="off none on first-parent 1 separate m combined c dense-combined cc remerge r"
    --
    --__git_log_pretty_formats="oneline short medium full fuller reference email raw format: tformat: mboxrd"
    --__git_log_date_formats="relative iso8601 iso8601-strict rfc2822 short local default human raw unix auto: format:"
    --
    --
    --# Check for only porcelain (i.e. not git-rev-list) option (not argument)
    --# and selected option argument completions for git-log options and if any
    --# are found put them in COMPREPLY.  COMPREPLY must be empty at the start,
    --# and will be empty on return if no candidates are found.
    --__git_complete_log_opts ()
    --{
    --	[ -z "$COMPREPLY" ] || return 1   # Precondition
    --
    --	local merge=""
    --	if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
    --		merge="--merge"
    --	fi
    --	case "$prev,$cur" in
    --	-L,:*:*)
    --		return	# fall back to Bash filename completion
    --		;;
    --	-L,:*)
    --		__git_complete_symbol --cur="${cur#:}" --sfx=":"
    --		return
    --		;;
    --	-G,*|-S,*)
    --		__git_complete_symbol
    --		return
    --		;;
    --	esac
    --	case "$cur" in
    --	--pretty=*|--format=*)
    --		__gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
    --			" "" "${cur#*=}"
    --		return
    --		;;
    --	--date=*)
    --		__gitcomp "$__git_log_date_formats" "" "${cur##--date=}"
    --		return
    --		;;
    --	--decorate=*)
    --		__gitcomp "full short no" "" "${cur##--decorate=}"
    --		return
    --		;;
    --	--diff-algorithm=*)
    --		__gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
    --		return
    --		;;
    --	--submodule=*)
    --		__gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
    --		return
    --		;;
    --	--ws-error-highlight=*)
    --		__gitcomp "$__git_ws_error_highlight_opts" "" "${cur##--ws-error-highlight=}"
    --		return
    --		;;
    --	--no-walk=*)
    --		__gitcomp "sorted unsorted" "" "${cur##--no-walk=}"
    --		return
    --		;;
    --	--diff-merges=*)
    --                __gitcomp "$__git_diff_merges_opts" "" "${cur##--diff-merges=}"
    --                return
    --                ;;
    --	--*)
    --		__gitcomp "
    --			$__git_log_common_options
    --			$__git_log_shortlog_options
    --			$__git_log_gitk_options
    --			$__git_log_show_options
    --			--root --topo-order --date-order --reverse
    --			--follow --full-diff
    --			--abbrev-commit --no-abbrev-commit --abbrev=
    --			--relative-date --date=
    --			--pretty= --format= --oneline
    --			--show-signature
    --			--cherry-mark
    --			--cherry-pick
    --			--graph
    --			--decorate --decorate= --no-decorate
    --			--walk-reflogs
    --			--no-walk --no-walk= --do-walk
    --			--parents --children
    --			--expand-tabs --expand-tabs= --no-expand-tabs
    --			$merge
    --			$__git_diff_common_options
    --			"
    --		return
    --		;;
    --	-L:*:*)
    --		return	# fall back to Bash filename completion
    --		;;
    --	-L:*)
    --		__git_complete_symbol --cur="${cur#-L:}" --sfx=":"
    --		return
    --		;;
    --	-G*)
    --		__git_complete_symbol --pfx="-G" --cur="${cur#-G}"
    --		return
    --		;;
    --	-S*)
    --		__git_complete_symbol --pfx="-S" --cur="${cur#-S}"
    --		return
    --		;;
    --	esac
    --}
    --
      _git_log ()
      {
      	__git_has_doubledash && return
4:  c5bee633b2 < -:  ---------- completion: custom git-bisect terms
5:  2bd0cb26f1 < -:  ---------- completion: git-bisect view recognized but not completed
-:  ---------- > 5:  733613d1ed completion: log: use __git_complete_log_opts
-:  ---------- > 6:  06f5973b3b completion: bisect: complete log opts for visualize subcommand
-:  ---------- > 7:  1dc9323f24 completion: bisect: recognize but do not complete view subcommand
-:  ---------- > 8:  451b7a4467 completion: add tests for git-bisect
--
2.43.0