Fix zsh completion when worktree names have spaces

Author: mateusauler

completions/_wt_completion

@@ -3,22 +3,30 @@
 # AUTOCOMPLETION FOR ZSH
 # Reference: https://zsh.sourceforge.io/Doc/Release/Completion-Widgets.html
 
-# wt list: list all the available worktrees
-# | awk '{ print $1; }': grab the first column of the output
-# | tr "\n" " ": replace line break character with space to put the worktrees on single line
-# separated by space
+# `list` is populated with the names of all Git worktrees in the current directory.
+# git rev-parse --git-dir:                             Check if the current directory is a Git repository.
+# git worktree list --porcelain:                       List all worktrees in an easily parse-able way.
+# awk '/^worktree / { sub("worktree ", ""); print; }': Extract the worktree names and remove the `worktree ` prefix.
+# xargs -I{} basename {}:                              Get the base name of each worktree path, preserving whitespace.
+list="$(git rev-parse --git-dir &> /dev/null \
+	&& git worktree list --porcelain \
+	| awk '/^worktree / { sub("worktree ", ""); print; }' \
+	| xargs -I{} basename {})"
 
-list="$(wt list | awk '{ print $1; }' | tr "\n" " ")"
+# Split the output into an array, line-by-line.
+list=("${(@f)${list}}")
+
+# Declare an associative array named `opts`
 declare -A opts
 
 # Create associative array with key same as its value
 # Completion keywords are taken as keys of arrays and the possible matches are their values
-# shwordsplit: iterate over a string separated by space (like sh/bash)
-setopt shwordsplit
 for item in $list; do
-    base="$(basename -- "$item")"
-    opts+=(["$base"]="$base")
+	# Escape every element's special characters
+	item=$(printf '%q' "$item")
+	opts+=(["$item"]="$item")
 done
-unsetopt shwordsplit
-
+# Add the keys of `opts` as completion options for the `wt` command.
+# `-Q` quotes the completion options.
+# `-a` specifies that the options are taken from an associative array.
 compadd -Qa opts