Support worktree-tags and detached checkouts

Author: lu0

libs/_branch.sh

@@ -28,7 +28,7 @@ branch::_delete_worktree_and_branch() {
     local bare_dir to_dir worktree_abs_dir
 
     bare_dir="$(utils::get_bare_dir)"
-    to_dir=$(utils::branch_to_dir_name "${branch}")
+    to_dir=$(utils::branch_to_ref_name "${branch}")
 
     worktree_abs_dir="${bare_dir%%/}/${to_dir}"
 

libs/_checkout.sh

@@ -25,11 +25,10 @@ checkout::override_commands() {
     esac
 
 
-    if [[ -z "${3:-}" ]] && [[ $(utils::git branch --list "${2:-}") != "" ]]; then
+    if [[ -z "${3:-}" ]] && [[ $(utils::is_worktreable "${2:-}") == 1 ]]; then
         # If `git checkout` received only 1 argument (other than the previous
-        # cases) and is a branch, switch and cd into it ...
-        checkout::_switch_to_branch_and_worktree "${@:-}"
-
+        # cases) and is a "worktreable" reference, switch and cd into it ...
+        checkout::_switch_to_ref_and_worktree "${@:-}"
     else
         # ... otherwise, either an unsupported option was passed ...
         if echo "${@:-}" | grep -qo " -" ; then
@@ -47,11 +46,10 @@ checkout::override_commands() {
 # - `git checkout [-b|B] ${to} ${from}`
 # - Call: `checkout::_create_branch_and_worktree $opt $to $from`
 checkout::_create_branch_and_worktree() {
-
     local opt="${2:-}" to="${3:-}" from="${4:-}"
     local to_dir existing_branch
 
-    to_dir=$(utils::branch_to_dir_name "${to}")
+    to_dir=$(utils::ref_to_dir_name "${to}")
     existing_branch=$(utils::git branch --list "${to}")
 
     if [ "${existing_branch:-}" ] && [ "${opt}" == "-b" ]; then
@@ -67,7 +65,7 @@ checkout::_create_branch_and_worktree() {
         fi
 
         # Create worktree if does not exist
-        worktree_dir=$(checkout::__create_worktree_from_branch "${to}")
+        worktree_dir=$(checkout::__create_worktree_from_ref "${to}")
 
         # cd into the worktree dir
         cd "${worktree_dir}"
@@ -87,16 +85,16 @@ checkout::_create_branch_and_worktree() {
 }
 
 
-# Switch to a branch/worktree, emulates git command:
-# - `git checkout ${branch}`
-# - Call: `checkout::_switch_to_branch_and_worktree $branch`
-checkout::_switch_to_branch_and_worktree() {
+# Switch to a branch/tag/worktree, emulates git command:
+# - `git checkout ${to}`
+# - Call: `checkout::_switch_to_ref_and_worktree $to`
+checkout::_switch_to_ref_and_worktree() {
     local to="${2:-}"
     local existing_branch
     local worktree_dir
 
     # Create worktree if does not exist
-    worktree_dir=$(checkout::__create_worktree_from_branch "${to}")
+    worktree_dir=$(checkout::__create_worktree_from_ref "${to}")
 
     if [ -d "${worktree_dir:-}" ]; then
         # If successful, cd to the created worktree
@@ -107,22 +105,23 @@ checkout::_switch_to_branch_and_worktree() {
 }
 
 
-# Create worktree from a given branch if the worktree does not exist.
+# Creates worktree from a given reference if the worktree does not exist.
 # Worktree directories are created in the root of the bare repository.
-# Vanilla git handles non-existence of the given branch.
+# Vanilla git handles non-existence of the given reference.
 # Post-checkout hooks are disabled within this function.
-# - Call: `checkout::__create_worktree_from_branch "${branch}"`
-# - Returns: Path to the created or existing worktree for `branch` or
+# - Call: `checkout::__create_worktree_from_ref "${ref}"`
+# - Returns: Path to the created or existing worktree for `ref` or
 #             an empty string if the creation was not successful.
-checkout::__create_worktree_from_branch() {
+checkout::__create_worktree_from_ref() {
+    local to="${1}"
     local to_dir
     local bare_dir
 
     bare_dir=$(utils::get_bare_dir)
-    to_dir=$(utils::branch_to_dir_name "${to}")
+    to_dir=$(utils::ref_to_dir_name "${to}")
 
     # Create worktree if does not exist
-    if [ -z "$(utils::get_branch_path "${to}")" ]; then
+    if [ -z "$(utils::get_ref_path "${to}")" ]; then
         # Created in the directory of the bare repository
         cd "${bare_dir}"
 
@@ -134,13 +133,19 @@ checkout::__create_worktree_from_branch() {
         fi
     fi
 
-    utils::get_branch_path "${to}"
+    utils::get_ref_path "${to}"
 }
 
 
 # Triggers post-checkout hooks by executing a silent
-# checkout to the current branch using vanilla git.
+# checkout to the current branch or reference using vanilla git.
 # - Call: `checkout::__trigger_post_hook`
 checkout::__trigger_post_hook() {
-    utils::git checkout -q "$(utils::git branch --show-current)"
+    local branch
+    branch="$(utils::git branch --show-current)"
+    if [[ "${branch}" ]]; then
+        utils::git checkout -q "${branch}"
+    else
+        utils::git checkout -q "$(git rev-parse HEAD)"
+    fi
 }

libs/_utils.sh

@@ -17,20 +17,44 @@ utils::git() {
 }
 
 
+# Returns 1 if the specified reference is "worktreable".
+# A reference is "worktreable" if it's a branch or a tag,
+# this enables detached checkouts to commits within a worktree.
+utils::is_worktreable() {
+    local ref="${1}"
+    local is_branch is_tag
+
+    is_branch=$(utils::git show-ref --verify -q refs/heads/"${ref}" && echo 1)
+    is_tag=$(utils::git show-ref --verify -q refs/tags/"${ref}" && echo 1)
+
+    if [[ "${is_tag}" == 1 ]] || [[ "${is_branch}" == 1 ]]; then
+        echo 1
+    fi
+}
+
+
+
 # Non intrusive messages
 utils::info() {
     echo -e >&2 "\ngit-worktree-wrapper:\n\t${1}\n"
 }
 
 
 # Use `.` instead of `/` to name worktree directories
-utils::branch_to_dir_name() {
+utils::ref_to_dir_name() {
     echo "${1//'/'/'.'}"
 }
 
 
-utils::get_branch_path() {
-    utils::git worktree list | grep -w "\[${1}\]" | cut -d" " -f1
+# Returns the absolute path to the worktree of a given reference,
+# the result is empty if the reference does not have a worktree.
+utils::get_ref_path() {
+    local ref="${1}"
+    local bare_dir ref_dirname ref_path_to_check
+    bare_dir=$(utils::get_bare_dir)
+    ref_dirname=$(utils::ref_to_dir_name "${ref}")
+    ref_path_to_check="${bare_dir}/${ref_dirname}"
+    utils::git worktree list | grep -o "${ref_path_to_check} " | xargs
 }
 
 
@@ -39,21 +63,20 @@ utils::get_bare_dir() {
 }
 
 
-utils::__store_last_checkedout() {
-    local branch worktree_path info
-    branch=$(git branch --show-current)
-    worktree_path=$(utils::get_branch_path "${branch}")
-    info="${worktree_path}\t[${branch}]"
-    echo -e "${info}" > "$(utils::get_bare_dir)"/.lastcheckedout
+utils::__store_current_worktree_info() {
+    local info_file_path current_worktree_info
+    info_file_path="$(utils::get_bare_dir)/.lastcheckedout"
+    current_worktree_info=$(utils::git worktree list | grep "$PWD " | xargs)
+    echo -e "${current_worktree_info}" > "${info_file_path}"
 }
 
 
-# Open the current worktree in a enabled and set editor and
-# store a reference to the worktree directory in the repository's root
+# Opens the current worktree in a enabled and set editor and
+# stores the information of the current worktree directory in the repository's root
 utils::open_editor_and_store_reference() {
     if [[ "${EDITOR:-}" ]] && [[ "${DISABLE_GIT_WORKTREE_EDITOR:-}" != "1" ]]; then
         utils::info "Opening in editor: ${EDITOR:-}"
         ${EDITOR:-} .
     fi
-    utils::__store_last_checkedout
+    utils::__store_current_worktree_info
 }