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

From: "Lessley Dennington via GitGitGadget" <[email-masked]>
Date: Mon, 07 Feb 2022 17:31:42 +0000

This change 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 V6
================

 * Split tests for unusual characters so that spaces and accents are
   verified on Windows (in addition to macOS and Linux). Tabs and
   backslashes are still excluded on Windows (details on why are included in
   the third commit message).

Changes since V5
================

 * Fix incorrect conditional that was causing failure of non-cone mode test
   (and causing 'seen' CI to fail).
 * Remove __git_comp_directories indentation changes between the second and
   third commits.

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                  | 138 +++++++++++++++++++++++++
 2 files changed, 174 insertions(+), 8 deletions(-)

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

Range-diff vs v6:

 1:  23390000dd3 ! 1:  26422c759a0 completion: address sparse-checkout issues
     @@ Commit message
          These caveats will be fixed by subsequent commits in this series.
      
          Signed-off-by: Lessley Dennington <[email-masked]>
     +    Reviewed-by: Elijah Newren <[email-masked]>
      
       ## contrib/completion/git-completion.bash ##
      @@ contrib/completion/git-completion.bash: _git_show_branch ()
 2:  10a190ce6a1 ! 2:  2c20830b4ce completion: improve sparse-checkout cone mode directory completion
     @@ Commit message
          Co-authored-by: Elijah Newren <[email-masked]>
          Co-authored-by: Lessley Dennington <[email-masked]>
          Signed-off-by: Lessley Dennington <[email-masked]>
     +    Reviewed-by: Elijah Newren <[email-masked]>
      
       ## contrib/completion/git-completion.bash ##
      @@ contrib/completion/git-completion.bash: _git_show_branch ()
 3:  e805dbb58cc ! 3:  996cbe7dfb7 completion: handle unusual characters for sparse-checkout
     @@ Commit message
          subdirectories (e.g. folder1/0/ became folder1/), so instead new custom
          logic was placed directly in the __gitcomp_directories method.
      
     +    Note there are two tests for this new functionality - one for spaces and
     +    accents and one for backslashes and tabs. The backslashes and tabs test
     +    uses FUNNYNAMES to avoid running on Windows. This is because:
     +
     +    1. Backslashes are explicitly not allowed in Windows file paths.
     +    2. Although tabs appear to be allowed when creating a file in a Windows
     +    bash shell, they actually are not renderable (and appear as empty boxes
     +    in the shell).
     +
          Co-authored-by: Johannes Schindelin <[email-masked]>
          Co-authored-by: Lessley Dennington <[email-masked]>
     +    Helped-by: Ævar Arnfjörð Bjarmason <[email-masked]>
          Signed-off-by: Lessley Dennington <[email-masked]>
     +    Reviewed-by: Elijah Newren <[email-masked]>
      
       ## contrib/completion/git-completion.bash ##
      @@ contrib/completion/git-completion.bash: _git_show_branch ()
     @@ t/t9902-completion.sh: test_expect_success 'cone mode sparse-checkout completes
       	)
       '
       
     -+# use FUNNYNAMES to avoid running on Windows, which doesn't permit backslashes in paths
     -+test_expect_success FUNNYNAMES 'cone mode sparse-checkout completes directory names with special characters' '
     ++test_expect_success 'cone mode sparse-checkout completes directory names with spaces and accents' '
      +	# reset sparse-checkout
      +	git -C sparse-checkout sparse-checkout disable &&
      +	(
      +		cd sparse-checkout &&
      +		mkdir "directory with spaces" &&
     -+		mkdir "$(printf "directory\twith\ttabs")" &&
     -+		mkdir "directory\with\backslashes" &&
      +		mkdir "directory-with-áccent" &&
      +		>"directory with spaces/randomfile" &&
     -+		>"$(printf "directory\twith\ttabs")/randomfile" &&
     -+		>"directory\with\backslashes/randomfile" &&
      +		>"directory-with-áccent/randomfile" &&
      +		git add . &&
     -+		git commit -m "Add directories containing unusual characters" &&
     ++		git commit -m "Add directory with spaces and directory with accent" &&
      +		git sparse-checkout set --cone "directory with spaces" \
     -+			"$(printf "directory\twith\ttabs")" "directory\with\backslashes" \
      +			"directory-with-áccent" &&
     -+		test_completion "git sparse-checkout add dir" <<-\EOF
     ++		test_completion "git sparse-checkout add dir" <<-\EOF &&
      +		directory with spaces/
     -+		directory	with	tabs/
     -+		directory\with\backslashes/
      +		directory-with-áccent/
      +		EOF
     ++		rm -rf "directory with spaces" &&
     ++		rm -rf "directory-with-áccent" &&
     ++		git add . &&
     ++		git commit -m "Remove directory with spaces and directory with accent"
     ++	)
     ++'
     ++
     ++# use FUNNYNAMES to avoid running on Windows, which doesn't permit backslashes or tabs in paths
     ++test_expect_success FUNNYNAMES 'cone mode sparse-checkout completes directory names with backslashes and tabs' '
     ++	# reset sparse-checkout
     ++	git -C sparse-checkout sparse-checkout disable &&
     ++	(
     ++		cd sparse-checkout &&
     ++		mkdir "directory\with\backslashes" &&
     ++		mkdir "$(printf "directory\twith\ttabs")" &&
     ++		>"directory\with\backslashes/randomfile" &&
     ++		>"$(printf "directory\twith\ttabs")/randomfile" &&
     ++		git add . &&
     ++		git commit -m "Add directory with backslashes and directory with tabs" &&
     ++		git sparse-checkout set --cone "directory\with\backslashes" \
     ++			"$(printf "directory\twith\ttabs")" &&
     ++		test_completion "git sparse-checkout add dir" <<-\EOF &&
     ++		directory\with\backslashes/
     ++		directory	with	tabs/
     ++		EOF
     ++		rm -rf "directory\with\backslashes" &&
     ++		rm -rf "$(printf "directory\twith\ttabs")" &&
     ++		git add . &&
     ++		git commit -m "Remove directory with backslashes and directory with tabs"
      +	)
      +'
      +

-- 
gitgitgadget