From: Elijah Newren <newren@gmail.com>
To: Lessley Dennington via GitGitGadget <gitgitgadget@gmail.com>
Cc: "Git Mailing List" <git@vger.kernel.org>,
"Derrick Stolee" <stolee@gmail.com>,
"Junio C Hamano" <gitster@pobox.com>,
johannes.schindelin@gmail.com, "Taylor Blau" <me@ttaylorr.com>,
"SZEDER Gábor" <szeder.dev@gmail.com>,
"Lessley Dennington" <lessleydennington@gmail.com>
Subject: Re: [PATCH v5 3/3] completion: handle unusual characters for sparse-checkout
Date: Thu, 3 Feb 2022 15:58:12 -0800 [thread overview]
Message-ID: <CABPp-BFD51BTsG7gQFD4BuqVLLBV2iJOKnrnya89otoGonzVvA@mail.gmail.com> (raw)
In-Reply-To: <ddf5e583dd71a729d6fb0513aed9fc4eb6ebbdd7.1643921091.git.gitgitgadget@gmail.com>
On Thu, Feb 3, 2022 at 12:44 PM Lessley Dennington via GitGitGadget
<gitgitgadget@gmail.com> wrote:
>
> From: Lessley Dennington <lessleydennington@gmail.com>
>
> Update the __gitcomp_directories method to de-quote and handle unusual
> characters in directory names. Although this initially involved an attempt
> to re-use the logic in __git_index_files, this method removed
> subdirectories (e.g. folder1/0/ became folder1/), so instead new custom
> logic was placed directly in the __gitcomp_directories method.
>
> Co-authored-by: Johannes Schindelin <johannes.schindelin@gmx.de>
> Co-authored-by: Lessley Dennington <lessleydennington@gmail.com>
> Signed-off-by: Lessley Dennington <lessleydennington@gmail.com>
> ---
> contrib/completion/git-completion.bash | 50 +++++++++++++-------------
> t/t9902-completion.sh | 28 +++++++++++++++
> 2 files changed, 52 insertions(+), 26 deletions(-)
>
> diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
> index c5c8df6b6e5..c47e9ce09b2 100644
> --- a/contrib/completion/git-completion.bash
> +++ b/contrib/completion/git-completion.bash
> @@ -2988,32 +2988,30 @@ _git_show_branch ()
>
> __gitcomp_directories ()
> {
> - local _tmp_dir _tmp_completions
> -
> - # Get the directory of the current token; this differs from dirname
> - # in that it keeps up to the final trailing slash. If no slash found
> - # that's fine too.
> - [[ "$cur" =~ .*/ ]]
> - _tmp_dir=$BASH_REMATCH
> -
> - # Find possible directory completions, adding trailing '/' characters
> - _tmp_completions="$(git ls-tree -d --name-only HEAD $_tmp_dir |
> - sed -e s%$%/%)"
> -
> - if [[ -n "$_tmp_completions" ]]; then
> - # There were some directory completions, so find ones that
> - # start with "$cur", the current token, and put those in COMPREPLY
> - local i=0 c IFS=$' \t\n'
> - for c in $_tmp_completions; do
> - if [[ $c == "$cur"* ]]; then
> - COMPREPLY+=("$c")
> - fi
> - done
> - elif [[ "$cur" =~ /$ ]]; then
> - # No possible further completions any deeper, so assume we're at
> - # a leaf directory and just consider it complete
> - __gitcomp_direct_append "$cur "
> - fi
> + local _tmp_dir _tmp_completions _found=0
> +
> + # Get the directory of the current token; this differs from dirname
> + # in that it keeps up to the final trailing slash. If no slash found
> + # that's fine too.
> + [[ "$cur" =~ .*/ ]]
> + _tmp_dir=$BASH_REMATCH
> +
> + # Find possible directory completions, adding trailing '/' characters,
> + # de-quoting, and handling unusual characters.
> + while IFS= read -r -d $'\0' c ; do
> + # If there are directory completions, find ones that start
> + # with "$cur", the current token, and put those in COMPREPLY
> + if [[ $c == "$cur"* ]]; then
> + COMPREPLY+=("$c/")
> + _found=1
> + fi
> + done < <(git ls-tree -z -d --name-only HEAD $_tmp_dir)
> +
> + if [[ $_found == 0 ]] && [[ "$cur" =~ /$ ]]; then
> + # No possible further completions any deeper, so assume we're at
> + # a leaf directory and just consider it complete
> + __gitcomp_direct_append "$cur "
> + fi
The indentation changes are distracting and make the patch harder to
review. Could you either remove those, or apply the indentation
changes to patch 2 so that it starts with the right indentation?
I'm slightly surprised that __gitcomp_direct_append handles the
quoting for us, but the testcases below seem to cover it, so that's
cool.
Anyway, looks pretty clever to me; I was worried this was going to
require a much bigger change.
> }
>
> _git_sparse_checkout ()
> diff --git a/t/t9902-completion.sh b/t/t9902-completion.sh
> index b38a7302249..7f63d6057be 100755
> --- a/t/t9902-completion.sh
> +++ b/t/t9902-completion.sh
> @@ -1508,6 +1508,34 @@ test_expect_success 'cone mode sparse-checkout completes directory names' '
> )
> '
>
> +# 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' '
> + # 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 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
> + directory with spaces/
> + directory with tabs/
> + directory\with\backslashes/
> + directory-with-áccent/
> + EOF
> + )
> +'
I'm glad you tested with lots of special characters -- spaces, tabs,
backslashes, and accents. Newlines might also be nice, but probably
makes the test hard. Anyway, looks good to me, other than the
indentation change.
> +
> 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 &&
> --
> gitgitgadget
next prev parent reply other threads:[~2022-02-03 23:58 UTC|newest]
Thread overview: 95+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-30 0:32 [PATCH 0/2] sparse checkout: custom bash completion updates Lessley Dennington via GitGitGadget
2021-12-30 0:32 ` [PATCH 1/2] sparse-checkout: custom tab completion tests Lessley Dennington via GitGitGadget
2021-12-30 13:43 ` Derrick Stolee
2021-12-30 16:19 ` Lessley Dennington
2021-12-30 17:43 ` Derrick Stolee
2021-12-31 19:27 ` Elijah Newren
2022-01-04 19:19 ` Lessley Dennington
2021-12-30 0:32 ` [PATCH 2/2] sparse-checkout: custom tab completion Lessley Dennington via GitGitGadget
2021-12-30 13:50 ` Derrick Stolee
2021-12-30 16:24 ` Lessley Dennington
2021-12-30 19:26 ` [PATCH v2 0/2] sparse checkout: custom bash completion updates Lessley Dennington via GitGitGadget
2021-12-30 19:26 ` [PATCH v2 1/2] sparse-checkout: custom tab completion tests Lessley Dennington via GitGitGadget
2021-12-31 20:03 ` Elijah Newren
2021-12-31 22:20 ` Junio C Hamano
2021-12-31 22:25 ` Elijah Newren
2022-01-04 19:25 ` Lessley Dennington
2022-01-04 20:25 ` Elijah Newren
2022-01-05 14:05 ` Lessley Dennington
2022-01-04 19:24 ` Lessley Dennington
2021-12-30 19:26 ` [PATCH v2 2/2] sparse-checkout: custom tab completion Lessley Dennington via GitGitGadget
2021-12-31 22:52 ` Elijah Newren
2022-01-04 19:41 ` Lessley Dennington
2022-01-04 20:42 ` Elijah Newren
2022-01-05 20:20 ` Lessley Dennington
2022-01-05 22:55 ` Elijah Newren
2022-01-10 18:59 ` [PATCH v3 0/3] sparse checkout: custom bash completion updates Lessley Dennington via GitGitGadget
2022-01-10 18:59 ` [PATCH v3 1/3] sparse-checkout: custom tab completion tests Lessley Dennington via GitGitGadget
2022-01-10 18:59 ` [PATCH v3 2/3] sparse-checkout: custom tab completion Lessley Dennington via GitGitGadget
2022-01-15 9:57 ` SZEDER Gábor
2022-01-16 1:03 ` Elijah Newren
2022-01-16 22:13 ` Junio C Hamano
2022-01-17 18:14 ` Elijah Newren
2022-01-17 19:40 ` Junio C Hamano
2022-01-18 17:56 ` Lessley Dennington
2022-01-22 1:07 ` Lessley Dennington
2022-01-22 1:08 ` Lessley Dennington
2022-01-22 2:11 ` Lessley Dennington
2022-01-18 21:02 ` SZEDER Gábor
2022-01-18 21:43 ` Elijah Newren
2022-01-18 17:59 ` Lessley Dennington
2022-01-18 22:22 ` SZEDER Gábor
2022-01-18 23:30 ` Elijah Newren
2022-01-10 18:59 ` [PATCH v3 3/3] sparse-checkout: limit tab completion to a single level Lessley Dennington via GitGitGadget
2022-01-12 23:43 ` Lessley Dennington
2022-01-13 0:00 ` Junio C Hamano
2022-01-13 0:38 ` Elijah Newren
2022-01-13 19:02 ` Lessley Dennington
2022-01-10 20:38 ` [PATCH v3 0/3] sparse checkout: custom bash completion updates Elijah Newren
2022-01-11 17:17 ` Lessley Dennington
2022-01-11 19:45 ` Taylor Blau
2022-01-12 18:35 ` Lessley Dennington
2022-01-27 21:21 ` [PATCH v4 0/3] completion: sparse-checkout updates Lessley Dennington via GitGitGadget
2022-01-27 21:21 ` [PATCH v4 1/3] completion: add sparse-checkout tests Lessley Dennington via GitGitGadget
2022-01-28 0:08 ` Elijah Newren
2022-01-28 1:56 ` Junio C Hamano
2022-01-28 2:04 ` Elijah Newren
2022-01-27 21:21 ` [PATCH v4 2/3] completion: sparse-checkout updates Lessley Dennington via GitGitGadget
2022-01-28 1:21 ` Elijah Newren
2022-01-31 20:03 ` Lessley Dennington
2022-01-31 21:37 ` Elijah Newren
2022-01-27 21:21 ` [PATCH v4 3/3] completion: ensure cone mode completion with multiple <TAB>s Lessley Dennington via GitGitGadget
2022-01-28 1:53 ` Elijah Newren
2022-02-03 20:44 ` [PATCH v5 0/3] completion: sparse-checkout updates Lessley Dennington via GitGitGadget
2022-02-03 20:44 ` [PATCH v5 1/3] completion: address sparse-checkout issues Lessley Dennington via GitGitGadget
2022-02-03 23:52 ` Elijah Newren
2022-02-04 0:34 ` Lessley Dennington
2022-02-03 20:44 ` [PATCH v5 2/3] completion: improve sparse-checkout cone mode directory completion Lessley Dennington via GitGitGadget
2022-02-03 20:44 ` [PATCH v5 3/3] completion: handle unusual characters for sparse-checkout Lessley Dennington via GitGitGadget
2022-02-03 23:58 ` Elijah Newren [this message]
2022-02-04 0:37 ` Lessley Dennington
2022-02-04 4:25 ` Ævar Arnfjörð Bjarmason
2022-02-04 21:55 ` Junio C Hamano
2022-02-03 21:48 ` [PATCH v5 0/3] completion: sparse-checkout updates Junio C Hamano
2022-02-03 22:17 ` Lessley Dennington
2022-02-03 23:28 ` Junio C Hamano
2022-02-03 23:59 ` Lessley Dennington
2022-02-04 2:43 ` Lessley Dennington
2022-02-04 3:28 ` Lessley Dennington
2022-02-04 4:21 ` Ævar Arnfjörð Bjarmason
2022-02-04 3:26 ` [PATCH v6 " Lessley Dennington via GitGitGadget
2022-02-04 3:26 ` [PATCH v6 1/3] completion: address sparse-checkout issues Lessley Dennington via GitGitGadget
2022-02-04 3:26 ` [PATCH v6 2/3] completion: improve sparse-checkout cone mode directory completion Lessley Dennington via GitGitGadget
2022-02-04 3:26 ` [PATCH v6 3/3] completion: handle unusual characters for sparse-checkout Lessley Dennington via GitGitGadget
2022-02-04 6:05 ` [PATCH v6 0/3] completion: sparse-checkout updates Elijah Newren
2022-02-04 17:04 ` Junio C Hamano
2022-02-04 17:55 ` Elijah Newren
2022-02-04 19:54 ` Junio C Hamano
2022-02-04 20:01 ` Elijah Newren
2022-02-04 21:47 ` Junio C Hamano
2022-02-07 17:31 ` [PATCH v7 " Lessley Dennington via GitGitGadget
2022-02-07 17:31 ` [PATCH v7 1/3] completion: address sparse-checkout issues Lessley Dennington via GitGitGadget
2022-02-07 17:31 ` [PATCH v7 2/3] completion: improve sparse-checkout cone mode directory completion Lessley Dennington via GitGitGadget
2022-02-07 17:31 ` [PATCH v7 3/3] completion: handle unusual characters for sparse-checkout Lessley Dennington via GitGitGadget
2022-04-06 9:42 ` Adam Dinwoodie
2022-02-08 4:16 ` [PATCH v7 0/3] completion: sparse-checkout updates Elijah Newren
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CABPp-BFD51BTsG7gQFD4BuqVLLBV2iJOKnrnya89otoGonzVvA@mail.gmail.com \
--to=newren@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
--cc=johannes.schindelin@gmail.com \
--cc=lessleydennington@gmail.com \
--cc=me@ttaylorr.com \
--cc=stolee@gmail.com \
--cc=szeder.dev@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).