worktree-aid 1.0__tar.gz → 1.2__tar.gz

{worktree_aid-1.0/worktree_aid.egg-info → worktree_aid-1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: worktree-aid
-Version: 1.0
+Version: 1.2
 Summary: Linux command line tool to aid creating, switching, and removing git worktrees
 Author-email: Mark Blakeney <mark.blakeney@bullet-systems.net>
 License-Expression: GPL-3.0-or-later
@@ -70,8 +70,8 @@ Commands:
   {add,a,rm,r,cd,c,ls,l,init}
     add (a)             Add new worktree + branch.
     rm (r)              Remove worktree + branch.
-    cd (c)              Change directory to specified worktree.
-    ls (l)              List current worktrees.
+    cd (c)              Change worktree directory.
+    ls (l)              List worktrees.
     init                Output shell initialization code.
 ```
 
@@ -81,7 +81,7 @@ individual command:
 ### Command `add`
 
 ```
-usage: wt add [-h] [-d] [worktree]
+usage: wt add [-h] [-d] [-c] [worktree]
 
 Add new worktree + branch.
 
@@ -92,6 +92,7 @@ positional arguments:
 options:
   -h, --help    show help message and exit
   -d, --detach  add detached worktree only, i.e. without adding a new branch
+  -c, --no-cd   do not change directory to new worktree after adding it
 
 aliases: a
 ```
@@ -105,7 +106,8 @@ Remove worktree + branch.
 
 positional arguments:
   worktree           worktree + branch name to remove. If not specified then
-                     fuzzy finder will prompt with a list of worktrees.
+                     fuzzy finder will prompt with a list of worktrees, with
+                     the current worktree as the default selection.
 
 options:
   -h, --help         show help message and exit
@@ -121,11 +123,12 @@ aliases: r
 ```
 usage: wt cd [-h] [worktree]
 
-Change directory to specified worktree.
+Change worktree directory.
 
 positional arguments:
-  worktree    Worktree name to change directory to. If not specified then
-              fuzzy finder will prompt with a list of worktrees.
+  worktree    Worktree name to change directory to. "/" is a shortcut to the
+              toplevel repository. If not specified then fuzzy finder will
+              prompt with a list of worktrees.
 
 options:
   -h, --help  show help message and exit
@@ -138,7 +141,7 @@ aliases: c
 ```
 usage: wt ls [-h]
 
-List current worktrees.
+List worktrees.
 
 options:
   -h, --help  show help message and exit
@@ -185,7 +188,7 @@ $ yay -S worktree-aid  # or your preferred AUR helper
 
 You also need to install a fuzzy finder program such as [`fzf`][fzf] which is
 the default used by `worktree-aid`. See [fuzzy finder installation
-instructions](fuzzy-finder-installation) for possible alternatives.
+instructions](#fuzzy-finder-integration) for possible alternatives.
 
 ## Setup
 
@@ -253,7 +256,7 @@ The following place-markers can be used in the definition of the base directory:
 - `{user}`: Substituted with the name of the user.
 - `{home}`: Substituted with the home directory of the user (also can use `~` at start of a path).
 
-Most likely if you will want to set a custom basedir then you will set `-B` as a
+Most likely if you want to set a custom basedir then you will set `-B` as a
 [default option](#default-options).
 
 ## Display as Relative Worktree Directories

{worktree_aid-1.0 → worktree_aid-1.2}/README.md

@@ -58,8 +58,8 @@ Commands:
   {add,a,rm,r,cd,c,ls,l,init}
     add (a)             Add new worktree + branch.
     rm (r)              Remove worktree + branch.
-    cd (c)              Change directory to specified worktree.
-    ls (l)              List current worktrees.
+    cd (c)              Change worktree directory.
+    ls (l)              List worktrees.
     init                Output shell initialization code.
 ```
 
@@ -69,7 +69,7 @@ individual command:
 ### Command `add`
 
 ```
-usage: wt add [-h] [-d] [worktree]
+usage: wt add [-h] [-d] [-c] [worktree]
 
 Add new worktree + branch.
 
@@ -80,6 +80,7 @@ positional arguments:
 options:
   -h, --help    show help message and exit
   -d, --detach  add detached worktree only, i.e. without adding a new branch
+  -c, --no-cd   do not change directory to new worktree after adding it
 
 aliases: a
 ```
@@ -93,7 +94,8 @@ Remove worktree + branch.
 
 positional arguments:
   worktree           worktree + branch name to remove. If not specified then
-                     fuzzy finder will prompt with a list of worktrees.
+                     fuzzy finder will prompt with a list of worktrees, with
+                     the current worktree as the default selection.
 
 options:
   -h, --help         show help message and exit
@@ -109,11 +111,12 @@ aliases: r
 ```
 usage: wt cd [-h] [worktree]
 
-Change directory to specified worktree.
+Change worktree directory.
 
 positional arguments:
-  worktree    Worktree name to change directory to. If not specified then
-              fuzzy finder will prompt with a list of worktrees.
+  worktree    Worktree name to change directory to. "/" is a shortcut to the
+              toplevel repository. If not specified then fuzzy finder will
+              prompt with a list of worktrees.
 
 options:
   -h, --help  show help message and exit
@@ -126,7 +129,7 @@ aliases: c
 ```
 usage: wt ls [-h]
 
-List current worktrees.
+List worktrees.
 
 options:
   -h, --help  show help message and exit
@@ -173,7 +176,7 @@ $ yay -S worktree-aid  # or your preferred AUR helper
 
 You also need to install a fuzzy finder program such as [`fzf`][fzf] which is
 the default used by `worktree-aid`. See [fuzzy finder installation
-instructions](fuzzy-finder-installation) for possible alternatives.
+instructions](#fuzzy-finder-integration) for possible alternatives.
 
 ## Setup
 
@@ -241,7 +244,7 @@ The following place-markers can be used in the definition of the base directory:
 - `{user}`: Substituted with the name of the user.
 - `{home}`: Substituted with the home directory of the user (also can use `~` at start of a path).
 
-Most likely if you will want to set a custom basedir then you will set `-B` as a
+Most likely if you want to set a custom basedir then you will set `-B` as a
 [default option](#default-options).
 
 ## Display as Relative Worktree Directories

{worktree_aid-1.0 → worktree_aid-1.2}/justfile

@@ -4,7 +4,7 @@ check:
   ruff check {{PYFILES}}
   ty check {{PYFILES}}
   vermin -vv --no-tips -i {{PYFILES}}
-  #md-link-checker
+  md-link-checker
 
 build:
   rm -rf dist
@@ -14,7 +14,7 @@ upload: build
   uv-publish
 
 doc:
-  update-readme-usage -A -S "s/worktree-aid/wt/g"
+  update-readme-usage -A -S "s/worktree[-_]aid/wt/g"
 
 format:
   ruff check --select I --fix {{PYFILES}} && ruff format {{PYFILES}}

{worktree_aid-1.0 → worktree_aid-1.2/worktree_aid.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: worktree-aid
-Version: 1.0
+Version: 1.2
 Summary: Linux command line tool to aid creating, switching, and removing git worktrees
 Author-email: Mark Blakeney <mark.blakeney@bullet-systems.net>
 License-Expression: GPL-3.0-or-later
@@ -70,8 +70,8 @@ Commands:
   {add,a,rm,r,cd,c,ls,l,init}
     add (a)             Add new worktree + branch.
     rm (r)              Remove worktree + branch.
-    cd (c)              Change directory to specified worktree.
-    ls (l)              List current worktrees.
+    cd (c)              Change worktree directory.
+    ls (l)              List worktrees.
     init                Output shell initialization code.
 ```
 
@@ -81,7 +81,7 @@ individual command:
 ### Command `add`
 
 ```
-usage: wt add [-h] [-d] [worktree]
+usage: wt add [-h] [-d] [-c] [worktree]
 
 Add new worktree + branch.
 
@@ -92,6 +92,7 @@ positional arguments:
 options:
   -h, --help    show help message and exit
   -d, --detach  add detached worktree only, i.e. without adding a new branch
+  -c, --no-cd   do not change directory to new worktree after adding it
 
 aliases: a
 ```
@@ -105,7 +106,8 @@ Remove worktree + branch.
 
 positional arguments:
   worktree           worktree + branch name to remove. If not specified then
-                     fuzzy finder will prompt with a list of worktrees.
+                     fuzzy finder will prompt with a list of worktrees, with
+                     the current worktree as the default selection.
 
 options:
   -h, --help         show help message and exit
@@ -121,11 +123,12 @@ aliases: r
 ```
 usage: wt cd [-h] [worktree]
 
-Change directory to specified worktree.
+Change worktree directory.
 
 positional arguments:
-  worktree    Worktree name to change directory to. If not specified then
-              fuzzy finder will prompt with a list of worktrees.
+  worktree    Worktree name to change directory to. "/" is a shortcut to the
+              toplevel repository. If not specified then fuzzy finder will
+              prompt with a list of worktrees.
 
 options:
   -h, --help  show help message and exit
@@ -138,7 +141,7 @@ aliases: c
 ```
 usage: wt ls [-h]
 
-List current worktrees.
+List worktrees.
 
 options:
   -h, --help  show help message and exit
@@ -185,7 +188,7 @@ $ yay -S worktree-aid  # or your preferred AUR helper
 
 You also need to install a fuzzy finder program such as [`fzf`][fzf] which is
 the default used by `worktree-aid`. See [fuzzy finder installation
-instructions](fuzzy-finder-installation) for possible alternatives.
+instructions](#fuzzy-finder-integration) for possible alternatives.
 
 ## Setup
 
@@ -253,7 +256,7 @@ The following place-markers can be used in the definition of the base directory:
 - `{user}`: Substituted with the name of the user.
 - `{home}`: Substituted with the home directory of the user (also can use `~` at start of a path).
 
-Most likely if you will want to set a custom basedir then you will set `-B` as a
+Most likely if you want to set a custom basedir then you will set `-B` as a
 [default option](#default-options).
 
 ## Display as Relative Worktree Directories

worktree_aid-1.2/worktree_aid.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "1.2",
+  "distance": 0,
+  "node": "gcb78b4dc270eb62209b736dedbcf8e12ad2591ec",
+  "dirty": false,
+  "branch": "main",
+  "node_date": "2026-08-02"
+}

{worktree_aid-1.0 → worktree_aid-1.2}/worktree_aid.py

@@ -12,7 +12,7 @@ import shlex
 import subprocess
 import sys
 from argparse import SUPPRESS, ArgumentParser, Namespace
-from collections.abc import Callable, Sequence
+from collections.abc import Sequence
 from dataclasses import dataclass
 from pathlib import Path
 from typing import Any
@@ -34,9 +34,6 @@ DEFAULT_FUZZY = 'fzf'
 # directory.
 BASEDIR = '../worktrees/{repo}'
 
-# Set of worktree names that are shortcuts to the top-level worktree.
-TOPLEVEL_SHORTCUTS = {'/'}
-
 # Template for the shell code injected into user's shell session
 SHELLCODE = """
 !cmd() {
@@ -78,11 +75,11 @@ def run(
     cmd: Sequence[str],
     *,
     stdin: str | None = None,
-    capture: bool = True,
+    stdout: Any = subprocess.PIPE,
     ignore_error: bool = False,
 ) -> str:
     "Run command and return stdout"
-    stdout = subprocess.PIPE if capture else open('/dev/tty', 'w')
+    capture = stdout == subprocess.PIPE
     try:
         res = subprocess.run(cmd, stdout=stdout, text=capture, input=stdin)
     except Exception as e:
@@ -94,7 +91,6 @@ def run(
     if capture:
         return res.stdout.strip()
 
-    stdout.close()  # type: ignore
     return ''
 
 
@@ -118,18 +114,18 @@ def unexpanduser(path: Path) -> Path:
     return Path('~', *path.parts[len(HOME.parts) :])
 
 
-def generate_new_name(exists: Callable[[str], Any]) -> str:
+def generate_new_name(exists: set[str]) -> str:
     "Generate a new worktree name"
     from coolname import generate_slug
 
     for _ in range(100):
-        if not exists(name := generate_slug(2)):
+        if (name := generate_slug(2)) not in exists:
             return name
 
     sys.exit('error: failed to generate a new worktree name.')
 
 
-def print_version(args: Namespace) -> int:
+def print_version(args: Namespace) -> None:
     "Print program version"
     from importlib import metadata
 
@@ -138,25 +134,16 @@ def print_version(args: Namespace) -> int:
     except Exception:
         version = '?'
 
-    if args._:
-        with open('/dev/tty', 'w') as tty:
-            print(version, file=tty)
-
-        return 2
+    print(version, file=args._stdout)
 
-    print(version)
-    return 0
 
-
-def print_help(args: Namespace) -> int:
+def print_help(args: Namespace) -> None:
     "Print program help message"
     if 'parser' in args:
         args.parser.print_help(sys.stderr)
     else:
         args._opt.print_help(sys.stderr)
 
-    return 2 if args._ else 0
-
 
 @dataclass
 class Tree:
@@ -172,6 +159,7 @@ class Trees:
     "Class to manage the collection of worktrees"
 
     trees: list[Tree]
+    names: dict[str, Tree]
     toplevel: Tree
     current: Tree
 
@@ -179,6 +167,7 @@ class Trees:
     def fetch(cls, args: Namespace) -> None:
         "Get worktrees"
         trees = []
+        names = {}
         tree = None
         cwdparts = Path.cwd().parts
         phere = pindex = -1
@@ -207,6 +196,9 @@ class Trees:
                     pindex = len(trees)
 
                 trees.append(tree := Tree(path, path_display))
+
+                if (name := path.name) not in names or name == tree.branch:
+                    names[name] = tree
             elif tree:
                 if field == 'HEAD':
                     tree.head = value[:HASH_LEN]
@@ -224,6 +216,7 @@ class Trees:
 
         cls.current = trees[0]
         cls.trees = trees
+        cls.names = names
 
     @classmethod
     def get_trees(cls) -> list[str]:
@@ -244,25 +237,20 @@ class Trees:
         return lines
 
     @classmethod
-    def get_tree(cls, text: str) -> Tree | None:
-        "Return first tree where branch, then path name, then head matches given text"
-        for tree in cls.trees:
-            if tree.branch == text:
-                return tree
-
-        for tree in cls.trees:
-            if tree.path.name == text:
-                return tree
-
-        for tree in cls.trees:
-            if tree.head == text:
-                return tree
+    def get_tree(cls, name: str) -> Tree | None:
+        "Return worktree with given name, or None if not found"
+        return cls.current if cls.current.path.name == name else cls.names.get(name)
 
     @classmethod
     def create_worktree(cls, name: str, args: Namespace) -> Path:
         "Create a new worktree and branch with the given name"
         if not name:
-            name = generate_new_name(cls.get_tree)
+            # If no name is given, generate a new name that does not conflict
+            # with existing worktrees or branches
+            existing = {t.path.name for t in cls.trees}
+            branches = run('git --no-pager branch --list'.split()).splitlines()
+            existing.update(b.split(maxsplit=1)[1] for b in branches)
+            name = generate_new_name(existing)
 
         try:
             basedir = args.basedir.format(
@@ -272,14 +260,14 @@ class Trees:
             sys.exit(f'error: failed to format basedir: {e}')
 
         basepath = Path(basedir).expanduser()
-        basepath = cls.toplevel.path / basepath
+        basepath = (cls.toplevel.path / basepath).resolve()
         basepath.mkdir(parents=True, exist_ok=True)
         path = basepath / name
 
         cmd = 'git worktree add'.split()
         if args.detach:
             cmd.append('--detach')
-        run(cmd + [str(path)], capture=False)
+        run(cmd + [str(path)], stdout=args._stdout)
         return path
 
     @classmethod
@@ -300,15 +288,14 @@ class Trees:
         if args.force:
             cmd.append('--force')
 
-        run(cmd + [str(tree.path)], capture=False)
+        run(cmd + [str(tree.path)], stdout=args._stdout)
 
         path_display = os.path.relpath(tree.path) if args.relative else str(tree.path)
-        with open('/dev/tty', 'w') as tty:
-            print(f'Removed worktree "{path_display}"', file=tty)
+        print(f'Removed worktree "{path_display}"', file=args._stdout)
 
         if tree.branch and not args.keep_branch:
             cmd = 'git branch'.split() + ['-D' if args.force else '-d']
-            run(cmd + [tree.branch], capture=False, ignore_error=True)
+            run(cmd + [tree.branch], stdout=args._stdout, ignore_error=True)
 
         return cls.toplevel.path if tree == cls.current else None
 
@@ -402,18 +389,30 @@ def main() -> int:
 
     args = opt.parse_args()
     args._opt = opt
+    if args._:
+        try:
+            args._stdout = open('/dev/tty', 'w')
+        except Exception as e:
+            sys.exit(f'error: can not write to terminal in shell function mode: {e}')
 
-    if args.version:
-        return print_version(args)
-
-    if args.help or 'func' not in args:
-        return print_help(args)
+        shell_return = 2
+    else:
+        args._stdout = sys.stdout
+        shell_return = 0
 
-    if out := args.func(args):
+    if args.version:
+        print_version(args)
+    elif args.help or 'func' not in args:
+        print_help(args)
+    elif out := args.func(args):
         print(out)
-        return 0
+        shell_return = 0
 
-    return 2 if args._ else 0
+    # Code checkers like us to explicitly close files we open
+    if args._:
+        args._stdout.close()
+
+    return shell_return
 
 
 # COMMAND
@@ -430,6 +429,12 @@ class add_:
             action='store_true',
             help='add detached worktree only, i.e. without adding a new branch',
         )
+        parser.add_argument(
+            '-c',
+            '--no-cd',
+            action='store_true',
+            help='do not change directory to new worktree after adding it',
+        )
         parser.add_argument(
             'worktree',
             default='',
@@ -440,7 +445,8 @@ class add_:
     @staticmethod
     def run(args: Namespace) -> str | None:
         Trees.fetch(args)
-        return str(Trees.create_worktree(args.worktree, args))
+        path = Trees.create_worktree(args.worktree, args)
+        return str(path) if path and not args.no_cd else None
 
 
 # COMMAND
@@ -469,7 +475,8 @@ class rm_:
             default='',
             nargs='?',
             help='worktree + branch name to remove. If not specified then '
-            'fuzzy finder will prompt with a list of worktrees.',
+            'fuzzy finder will prompt with a list of worktrees, with the '
+            'current worktree as the default selection.',
         )
 
     @staticmethod
@@ -480,15 +487,13 @@ class rm_:
                 return None
             name = path.name
 
-        if not (path := Trees.remove_worktree(name, args)):
-            return None
-
-        return str(path)
+        path = Trees.remove_worktree(name, args)
+        return str(path) if path else None
 
 
 # COMMAND
 class cd_:
-    "Change directory to specified worktree."
+    "Change worktree directory."
 
     aliases = ('c',)
 
@@ -498,15 +503,15 @@ class cd_:
             'worktree',
             default='',
             nargs='?',
-            help='Worktree name to change directory to. If not specified then '
-            'fuzzy finder will prompt with a list of worktrees.',
+            help='Worktree name to change directory to. "/" is a shortcut to the toplevel repository. '
+            'If not specified then fuzzy finder will prompt with a list of worktrees.',
         )
 
     @staticmethod
     def run(args: Namespace) -> str | None:
         Trees.fetch(args)
         if name := args.worktree:
-            if name in TOPLEVEL_SHORTCUTS:
+            if name == '/':
                 path = Trees.toplevel.path
             elif tree := Trees.get_tree(name):
                 path = tree.path
@@ -520,7 +525,7 @@ class cd_:
 
 # COMMAND
 class ls_:
-    "List current worktrees."
+    "List worktrees."
 
     aliases = ('l',)
 
@@ -528,9 +533,8 @@ class ls_:
     def run(args: Namespace) -> str | None:
         Trees.fetch(args)
         trees = Trees.get_trees()
-        with open('/dev/tty', 'w') as tty:
-            for line in reversed(trees):
-                print(line, file=tty)
+        for line in reversed(trees):
+            print(line, file=args._stdout)
 
         return None
 

worktree_aid-1.0/worktree_aid.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "1.0",
-  "distance": 0,
-  "node": "g5fd802c5aef974791beafe1a571d4a74c6773fd1",
-  "dirty": false,
-  "branch": "main",
-  "node_date": "2026-08-01"
-}