Subject: [PATCH v5 0/3] completion: sparse-checkout updates

From: "Lessley Dennington via GitGitGadget" <[email-masked]>
Date: Thu, 03 Feb 2022 20:44:48 +0000

This series is based on en/sparse-checkout-set. It updates custom tab
completion for the sparse-checkout command. Specifically, it corrects the
following issues with the current method:

 1. git sparse-checkout <TAB> results in an incomplete list of subcommands
    (it is missing reapply and add).
 2. Options for subcommands are not tab-completable.
 3. git sparse-checkout set <TAB> and git sparse-checkout add <TAB> show
    both file names and directory names. While this may be a less surprising
    behavior for non-cone mode, we want to only show directories in cone
    mode.

The first commit in this series is an intermediate step that fixes issues 1
and 2 above and introduces a simple fix for issue 3 with some performance
and unusual character-related caveats. The next commit adds a new
__gitcomp_directories method that fixes the performance-related caveat from
the first commit by completing just a single level of directories. The final
commit modifies __gitcomp_directories to handle unusual characters in
directory names.

Changes since V4
================

 * Clarify that completing on files and directories is a less-surprising
   behavior in non-cone mode (rather than definitely the correct behavior)
   in commit message and cover letter.
 * Add explicit --no-cone to non-cone mode sparse-checkout completion test.
 * Replace use of __git_complete_index_file with a new version of
   __gitcomp_directories that is able to handle unusual characters.
 * Ensure that users running git sparse-checkout set --cone get cone
   mode-style completion whether or not they already have the cone mode
   config set.
 * Refactor creation of sparse-checkout test repo into a sparse-checkout
   setup test.

Changes since V3
================

 * Update commit descriptions to begin with completion instead of
   sparse-checkout.
 * Remove explicit completion of --help, as this is inconsistent with the
   rest of the completion script.
 * Use __gitcomp_builtin to auto-complete subcommand options (and remove
   option completion test from previous iterations, as it is no longer
   necessary).
 * Use __git_complete_index_file helper function in place of __gitcomp
   "$(git ls-tree -d -r HEAD --name-only).
 * If in cone-mode sparse checkout, only show directory completions. If in
   non-cone mode sparse checkout show both files and directories.

Changes since V2
================

 * Change use of $prev to $subcommand in _git_sparse_checkout() method in
   git-completion.bash.
 * State explicitly that directory completion applies in both cone and
   non-cone mode in 'sparse-checkout: custom tab completion' commit
 * Add new patch with __gitcomp_directories method to improve performance by
   only outputting directories at the current level.

Changes since V1
================

 * Rebase onto en/sparse-checkout-set.
 * Add subcommand options (including --no-cone) for set and reapply.
 * Extend 'sparse-checkout completes subcommand options' test to validate
   new set/reapply subcommand options.
 * No longer set index.sparse to false in 'sparse-checkout completes
   directory names' test.
 * Refactor creation of sparse-checkout repo into a setup test.

Thanks, Lessley

Lessley Dennington (3):
  completion: address sparse-checkout issues
  completion: improve sparse-checkout cone mode directory completion
  completion: handle unusual characters for sparse-checkout

 contrib/completion/git-completion.bash |  44 ++++++++--
 t/t9902-completion.sh                  | 117 +++++++++++++++++++++++++
 2 files changed, 153 insertions(+), 8 deletions(-)

base-commit: dfac9b609f86cd4f6ce896df9e1172d2a02cde48
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1108%2Fldennington%2Fsparse-checkout-bash-completion-v5
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1108/ldennington/sparse-checkout-bash-completion-v5
Pull-Request: https://github.com/gitgitgadget/git/pull/1108

Range-diff vs v4:

 1:  5bb598a055d ! 1:  a1c46c763fd completion: add sparse-checkout tests
     @@ Metadata
      Author: Lessley Dennington <[email-masked]>
      
       ## Commit message ##
     -    completion: add sparse-checkout tests
     +    completion: address sparse-checkout issues
      
     -    Add tests for missing/incorrect components of custom tab completion for
     -    the sparse-checkout command. These tests specifically highlight the
     -    following:
     +    Correct multiple issues with tab completion of the git sparse-checkout
     +    command. These issues were:
      
     -    1. git sparse-checkout <TAB> results in an incomplete list of subcommands
     -    (it is missing reapply and add).
     -    2. git sparse-checkout set <TAB> and git sparse-checkout add <TAB> show
     -    both file names and directory names. While this is the correct behavior
     -    for non-cone mode, cone mode sparse checkouts should complete only
     -    directory names.
     +    1. git sparse-checkout <TAB> previously resulted in an incomplete list of
     +    subcommands (it was missing reapply and add).
     +    2. Subcommand options were not tab-completable.
     +    3. git sparse-checkout set <TAB> and git sparse-checkout add <TAB> showed
     +    both file names and directory names. While this may be a less surprising
     +    behavior for non-cone mode, cone mode sparse checkouts should complete
     +    only directory names.
      
     -    Although the first two of these tests currently fail, they will succeed
     -    with the sparse-checkout modifications in git-completion.bash in the next
     -    commit in this series.
     +    Note that while the new strategy of just using git ls-tree to complete on
     +    directory names is simple and a step in the right direction, it does have
     +    some caveats. These are:
     +
     +    1. Likelihood of poor performance in large monorepos (as a result of
     +    recursively completing directory names).
     +    2. Inability to handle paths containing unusual characters.
     +
     +    These caveats will be fixed by subsequent commits in this series.
      
          Signed-off-by: Lessley Dennington <[email-masked]>
      
     + ## contrib/completion/git-completion.bash ##
     +@@ contrib/completion/git-completion.bash: _git_show_branch ()
     + 
     + _git_sparse_checkout ()
     + {
     +-	local subcommands="list init set disable"
     ++	local subcommands="list init set disable add reapply"
     + 	local subcommand="$(__git_find_on_cmdline "$subcommands")"
     + 	if [ -z "$subcommand" ]; then
     + 		__gitcomp "$subcommands"
     +@@ contrib/completion/git-completion.bash: _git_sparse_checkout ()
     + 	fi
     + 
     + 	case "$subcommand,$cur" in
     +-	init,--*)
     +-		__gitcomp "--cone"
     +-		;;
     +-	set,--*)
     +-		__gitcomp "--stdin"
     +-		;;
     +-	*)
     ++	*,--*)
     ++		__gitcomp_builtin sparse-checkout_$subcommand "" "--"
     + 		;;
     ++	set,*|add,*)
     ++		if [ $(__git config core.sparseCheckoutCone) ] ||
     ++		[ "$(__git_find_on_cmdline --cone)" ]; then
     ++			__gitcomp "$(git ls-tree -d -r HEAD --name-only)"
     ++		fi
     + 	esac
     + }
     + 
     +
       ## t/t9902-completion.sh ##
      @@ t/t9902-completion.sh: test_expect_success 'git checkout - with --detach, complete only references' '
       	EOF
       '
       
     -+test_expect_failure 'sparse-checkout completes subcommands' '
     -+	test_completion "git sparse-checkout " <<-\EOF
     -+	list Z
     -+	init Z
     -+	set Z
     -+	add Z
     -+	reapply Z
     -+	disable Z
     -+	EOF
     -+'
     -+
     -+test_expect_failure 'cone mode sparse-checkout completes directory names' '
     ++test_expect_success 'setup sparse-checkout tests' '
      +	# set up sparse-checkout repo
      +	git init sparse-checkout &&
      +	(
     @@ t/t9902-completion.sh: test_expect_success 'git checkout - with --detach, comple
      +		touch folder3/t.txt &&
      +		git add . &&
      +		git commit -am "Initial commit"
     -+	) &&
     ++	)
     ++'
     ++
     ++test_expect_success 'sparse-checkout completes subcommands' '
     ++	test_completion "git sparse-checkout " <<-\EOF
     ++	list Z
     ++	init Z
     ++	set Z
     ++	add Z
     ++	reapply Z
     ++	disable Z
     ++	EOF
     ++'
      +
     ++test_expect_success 'cone mode sparse-checkout completes directory names' '
      +	# initialize sparse-checkout definitions
      +	git -C sparse-checkout sparse-checkout set --cone folder1/0 folder3 &&
      +
     @@ t/t9902-completion.sh: test_expect_success 'git checkout - with --detach, comple
      +	(
      +		cd sparse-checkout &&
      +		test_completion "git sparse-checkout set f" <<-\EOF
     -+		folder1
     -+		folder2
     -+		folder3
     -+		EOF
     -+	) &&
     -+
     -+	(
     -+		cd sparse-checkout &&
     -+		test_completion "git sparse-checkout set folder1/" <<-\EOF
     -+		folder1/0
     -+		EOF
     -+	) &&
     -+
     -+	(
     -+		cd sparse-checkout &&
     -+		test_completion "git sparse-checkout set folder1/0/" <<-\EOF
     -+		folder1/0/1
     ++		folder1 Z
     ++		folder1/0 Z
     ++		folder1/0/1 Z
     ++		folder2 Z
     ++		folder2/0 Z
     ++		folder3 Z
      +		EOF
      +	) &&
      +
      +	(
      +		cd sparse-checkout/folder1 &&
     -+		test_completion "git sparse-checkout add 0" <<-\EOF
     -+		0
     ++		test_completion "git sparse-checkout add " <<-\EOF
     ++		./ Z
     ++		0 Z
     ++		0/1 Z
      +		EOF
      +	)
      +'
     @@ t/t9902-completion.sh: test_expect_success 'git checkout - with --detach, comple
      +test_expect_success 'non-cone mode sparse-checkout uses bash completion' '
      +	# reset sparse-checkout repo to non-cone mode
      +	git -C sparse-checkout sparse-checkout disable &&
     -+	git -C sparse-checkout sparse-checkout set &&
     ++	git -C sparse-checkout sparse-checkout set --no-cone &&
      +
     -+	# test tab completion
      +	(
      +		cd sparse-checkout &&
      +		# expected to be empty since we have not configured
     @@ t/t9902-completion.sh: test_expect_success 'git checkout - with --detach, comple
      +		EOF
      +	)
      +'
     ++
     ++test_expect_success 'git sparse-checkout set --cone completes directory names' '
     ++	git -C sparse-checkout sparse-checkout disable &&
     ++
     ++	(
     ++		cd sparse-checkout &&
     ++		test_completion "git sparse-checkout set --cone f" <<-\EOF
     ++		folder1 Z
     ++		folder1/0 Z
     ++		folder1/0/1 Z
     ++		folder2 Z
     ++		folder2/0 Z
     ++		folder3 Z
     ++		EOF
     ++	)
     ++'
      +
       test_expect_success 'git switch - with -d, complete all references' '
       	test_completion "git switch -d " <<-\EOF
 2:  7d70beb2a6b < -:  ----------- completion: sparse-checkout updates
 3:  760cae85bd4 ! 2:  5b8d53402ae completion: ensure cone mode completion with multiple <TAB>s
     @@ Metadata
      Author: Lessley Dennington <[email-masked]>
      
       ## Commit message ##
     -    completion: ensure cone mode completion with multiple <TAB>s
     +    completion: improve sparse-checkout cone mode directory completion
      
     -    Ensure users in a cone mode sparse checkout can tab-complete to
     -    directories at multiple levels with multiple <TAB>s. For example, if path
     -    a/b/c/ exists in the current directory, running a<TAB>b<TAB> will result
     -    in:
     +    Use new __gitcomp_directories method to complete directory names in cone
     +    mode sparse-checkouts. This method addresses the caveat of poor
     +    performance in monorepos from the previous commit (by completing only one
     +    level of directories).
      
     -            a/b/c/
     -
     -    The 'sparse-checkout completes directory names' test has also been
     -    updated with trailing slashes according to these changes.
     +    The unusual character caveat from the previous commit will be fixed by the
     +    final commit in this series.
      
          Co-authored-by: Elijah Newren <[email-masked]>
          Co-authored-by: Lessley Dennington <[email-masked]>
     @@ contrib/completion/git-completion.bash: _git_show_branch ()
       _git_sparse_checkout ()
       {
       	local subcommands="list init set disable add reapply"
     - 	local subcommand="$(__git_find_on_cmdline "$subcommands")"
     --
     - 	if [ -z "$subcommand" ]; then
     - 		__gitcomp "$subcommands"
     - 		return
      @@ contrib/completion/git-completion.bash: _git_sparse_checkout ()
     - 		;;
     - 		set,*|add,*)
     - 			if [ $(__git config core.sparseCheckoutCone) ]; then
     --				__git_complete_index_file "--directory"
     -+				__gitcomp_directories
     - 			fi
     - 		;;
     + 	set,*|add,*)
     + 		if [ $(__git config core.sparseCheckoutCone) ] ||
     + 		[ "$(__git_find_on_cmdline --cone)" ]; then
     +-			__gitcomp "$(git ls-tree -d -r HEAD --name-only)"
     ++			__gitcomp_directories
     + 		fi
       	esac
     + }
      
       ## t/t9902-completion.sh ##
      @@ t/t9902-completion.sh: test_expect_success 'cone mode sparse-checkout completes directory names' '
       	(
       		cd sparse-checkout &&
       		test_completion "git sparse-checkout set f" <<-\EOF
     --		folder1
     --		folder2
     --		folder3
     +-		folder1 Z
     +-		folder1/0 Z
     +-		folder1/0/1 Z
     +-		folder2 Z
     +-		folder2/0 Z
     +-		folder3 Z
      +		folder1/
      +		folder2/
      +		folder3/
     - 		EOF
     - 	) &&
     - 
     - 	(
     - 		cd sparse-checkout &&
     - 		test_completion "git sparse-checkout set folder1/" <<-\EOF
     --		folder1/0
     ++		EOF
     ++	) &&
     ++
     ++	(
     ++		cd sparse-checkout &&
     ++		test_completion "git sparse-checkout set folder1/" <<-\EOF
      +		folder1/0/
     - 		EOF
     - 	) &&
     - 
     - 	(
     - 		cd sparse-checkout &&
     - 		test_completion "git sparse-checkout set folder1/0/" <<-\EOF
     --		folder1/0/1
     ++		EOF
     ++	) &&
     ++
     ++	(
     ++		cd sparse-checkout &&
     ++		test_completion "git sparse-checkout set folder1/0/" <<-\EOF
      +		folder1/0/1/
       		EOF
       	) &&
       
       	(
       		cd sparse-checkout/folder1 &&
     - 		test_completion "git sparse-checkout add 0" <<-\EOF
     --		0
     +-		test_completion "git sparse-checkout add " <<-\EOF
     +-		./ Z
     +-		0 Z
     +-		0/1 Z
     ++		test_completion "git sparse-checkout add 0" <<-\EOF
      +		0/
       		EOF
       	)
       '
     +@@ t/t9902-completion.sh: test_expect_success 'git sparse-checkout set --cone completes directory names' '
     + 	(
     + 		cd sparse-checkout &&
     + 		test_completion "git sparse-checkout set --cone f" <<-\EOF
     +-		folder1 Z
     +-		folder1/0 Z
     +-		folder1/0/1 Z
     +-		folder2 Z
     +-		folder2/0 Z
     +-		folder3 Z
     ++		folder1/
     ++		folder2/
     ++		folder3/
     + 		EOF
     + 	)
     + '
 -:  ----------- > 3:  ddf5e583dd7 completion: handle unusual characters for sparse-checkout

-- 
gitgitgadget