Skip to content

Add worktree subcommand #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pjbgf wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add worktree subcommand #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
190 changes: 190 additions & 0 deletions cmd/gogit/worktree.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
package main

import (
"errors"
"fmt"
"os"
"path/filepath"

"github.com/go-git/go-billy/v6/memfs"
"github.com/go-git/go-billy/v6/osfs"
"github.com/go-git/go-git/v6"
"github.com/go-git/go-git/v6/plumbing"
"github.com/go-git/go-git/v6/x/plumbing/worktree"
xstorage "github.com/go-git/go-git/v6/x/storage"
"github.com/spf13/cobra"
)

var (
worktreeAddCommit string
worktreeAddDetach bool
)

func init() {
worktreeAddCmd.Flags().StringVarP(&worktreeAddCommit, "commit", "c", "", "Commit hash to checkout in the new worktree")
worktreeAddCmd.Flags().BoolVarP(&worktreeAddDetach, "detach", "d", false, "Create a detached HEAD worktree")
worktreeCmd.AddCommand(worktreeAddCmd)
worktreeCmd.AddCommand(worktreeListCmd)
worktreeCmd.AddCommand(worktreeRemoveCmd)
rootCmd.AddCommand(worktreeCmd)
}

var worktreeCmd = &cobra.Command{
Use: "worktree <command>",
Short: "Manage repository worktrees",
RunE: func(cmd *cobra.Command, _ []string) error {
return cmd.Usage()
},
DisableFlagsInUseLine: true,
}

var worktreeAddCmd = &cobra.Command{
Use: "add <path>",
Short: "Add a new linked worktree",
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
path := args[0]
name := filepath.Base(path)

r, err := git.PlainOpen(".")
if err != nil {
return fmt.Errorf("failed to open repository: %w", err)
}

w, err := worktree.New(r.Storer)
if err != nil {
return fmt.Errorf("failed to create worktree manager: %w", err)
}

wt := osfs.New(path)

var opts []worktree.Option
if worktreeAddDetach {
opts = append(opts, worktree.WithDetachedHead())
}
if worktreeAddCommit != "" {
hash := plumbing.NewHash(worktreeAddCommit)
if !hash.IsZero() {
opts = append(opts, worktree.WithCommit(hash))
}
Comment on lines +65 to +69
Copy link

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No validation is performed on the commit hash provided by the user. If the user provides an invalid hash string, plumbing.NewHash() will silently return a zero hash, and the WithCommit option won't be added. This could lead to unexpected behavior where the user thinks they're checking out a specific commit but they're not.

Copilot uses AI. Check for mistakes.
}

err = w.Add(wt, name, opts...)
if err != nil {
return fmt.Errorf("failed to add worktree: %w", err)
}

fmt.Fprintf(cmd.OutOrStdout(), "Worktree '%s' created at '%s'\n", name, path)

return nil
},
DisableFlagsInUseLine: true,
}

var worktreeListCmd = &cobra.Command{
Use: "list",
Short: "List all linked worktrees",
Args: cobra.NoArgs,
RunE: func(cmd *cobra.Command, _ []string) error {
r, err := git.PlainOpen(".")
if err != nil {
return fmt.Errorf("failed to open repository: %w", err)
}

w, err := worktree.New(r.Storer)
if err != nil {
return fmt.Errorf("failed to create worktree manager: %w", err)
}

cwd, err := os.Getwd()
if err != nil {
return fmt.Errorf("failed to get current directory: %w", err)
}

ref, err := r.Head()
if err != nil {
return fmt.Errorf("failed to get HEAD: %w", err)
}

fmt.Fprintf(cmd.OutOrStdout(), "%-30s %s %s\n", cwd, ref.Hash().String()[:7], refName(ref))

worktrees, err := w.List()
if err != nil {
return fmt.Errorf("failed to list worktrees: %w", err)
}

wts, ok := r.Storer.(xstorage.WorktreeStorer)
if !ok {
return errors.New("storer does not implement WorktreeStorer")
}

commonDir := wts.Filesystem()
for _, name := range worktrees {
gitdirPath := filepath.Join(commonDir.Root(), "worktrees", name, "gitdir")
gitdirData, err := os.ReadFile(gitdirPath)
if err != nil {
continue
}

wtPath := filepath.Dir(string(gitdirData[:len(gitdirData)-1]))
Copy link

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Potential index out of bounds error when gitdirData is empty. The code subtracts 1 from the length without checking if the data has at least one byte. This could panic if the gitdir file is empty or only contains a newline character.

Copilot uses AI. Check for mistakes.
wt := memfs.New()
err = w.Init(wt, name)
if err != nil {
continue
}

r, err := w.Open(wt)
if err != nil {
continue
}

ref, err := r.Head()
Comment on lines +136 to +141
Copy link

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Variable shadowing issue: the variable 'r' is being redeclared here, shadowing the repository variable 'r' from line 89. This makes the outer 'r' variable inaccessible within this scope and could lead to confusion about which repository is being used.

Suggested change
r, err := w.Open(wt)
if err != nil {
continue
}
ref, err := r.Head()
wtRepo, err := w.Open(wt)
if err != nil {
continue
}
ref, err := wtRepo.Head()

Copilot uses AI. Check for mistakes.
if err != nil {
return fmt.Errorf("failed to get HEAD: %w", err)
Copy link

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent error handling in the loop. While errors from os.ReadFile, w.Init, and w.Open are silently ignored with 'continue', an error from r.Head() returns immediately with an error. This inconsistency could make the command fail unexpectedly instead of just skipping problematic worktrees like the earlier error cases.

Suggested change
return fmt.Errorf("failed to get HEAD: %w", err)
continue

Copilot uses AI. Check for mistakes.
}

fmt.Fprintf(cmd.OutOrStdout(), "%-30s %s %s\n", wtPath, ref.Hash().String()[:7], refName(ref))
Comment on lines +141 to +146
Copy link

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Variable shadowing issue: the variable 'ref' is being redeclared here, shadowing the HEAD reference 'ref' from line 104. This makes the outer 'ref' variable inaccessible within this scope and could lead to confusion.

Suggested change
ref, err := r.Head()
if err != nil {
return fmt.Errorf("failed to get HEAD: %w", err)
}
fmt.Fprintf(cmd.OutOrStdout(), "%-30s %s %s\n", wtPath, ref.Hash().String()[:7], refName(ref))
wtRef, err := r.Head()
if err != nil {
return fmt.Errorf("failed to get HEAD: %w", err)
}
fmt.Fprintf(cmd.OutOrStdout(), "%-30s %s %s\n", wtPath, wtRef.Hash().String()[:7], refName(wtRef))

Copilot uses AI. Check for mistakes.
}

return nil
},
DisableFlagsInUseLine: true,
}

func refName(ref *plumbing.Reference) string {
name := ref.Name()
if name.IsBranch() {
return fmt.Sprint("[", name.Short(), "]")
}

return fmt.Sprint("(detached ", string(ref.Name()), ")")
Comment on lines +157 to +160
Copy link

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The fmt.Sprint call is unnecessarily verbose. Using fmt.Sprintf with proper formatting would be more idiomatic and clearer.

Suggested change
return fmt.Sprint("[", name.Short(), "]")
}
return fmt.Sprint("(detached ", string(ref.Name()), ")")
return fmt.Sprintf("[%s]", name.Short())
}
return fmt.Sprintf("(detached %s)", string(ref.Name()))

Copilot uses AI. Check for mistakes.
Comment on lines +157 to +160
Copy link

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The fmt.Sprint call is unnecessarily verbose. Using fmt.Sprintf with proper formatting would be more idiomatic and clearer.

Suggested change
return fmt.Sprint("[", name.Short(), "]")
}
return fmt.Sprint("(detached ", string(ref.Name()), ")")
return fmt.Sprintf("[%s]", name.Short())
}
return fmt.Sprintf("(detached %s)", ref.Name())

Copilot uses AI. Check for mistakes.
}

var worktreeRemoveCmd = &cobra.Command{
Use: "remove <name>",
Short: "Remove a linked worktree",
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
name := args[0]

r, err := git.PlainOpen(".")
if err != nil {
return fmt.Errorf("failed to open repository: %w", err)
}

wt, err := worktree.New(r.Storer)
if err != nil {
return fmt.Errorf("failed to create worktree manager: %w", err)
}

err = wt.Remove(name)
if err != nil {
return fmt.Errorf("failed to remove worktree: %w", err)
}

fmt.Fprintf(cmd.OutOrStdout(), "Worktree '%s' removed\n", name)

return nil
},
DisableFlagsInUseLine: true,
}
8 changes: 4 additions & 4 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ go 1.24.0
toolchain go1.25.4

require (
github.com/go-git/go-billy/v6 v6.0.0-20251209065551-8afc3eb64e4d
github.com/go-git/go-git-fixtures/v5 v5.1.1
github.com/go-git/go-git/v6 v6.0.0-20251123162143-36fa81975a20
github.com/go-git/go-billy/v6 v6.0.0-20251215223226-9a435375010d
github.com/go-git/go-git-fixtures/v5 v5.1.2-0.20251217024734-e267099c9ed5
github.com/go-git/go-git/v6 v6.0.0-20251218224324-ede584db67a4
github.com/spf13/cobra v1.10.2
golang.org/x/crypto v0.46.0
golang.org/x/term v0.38.0
Expand All @@ -27,6 +27,6 @@ require (
github.com/pjbgf/sha1cd v0.5.0 // indirect
github.com/sergi/go-diff v1.4.0 // indirect
github.com/spf13/pflag v1.0.9 // indirect
golang.org/x/net v0.47.0 // indirect
golang.org/x/net v0.48.0 // indirect
golang.org/x/sys v0.39.0 // indirect
)
16 changes: 8 additions & 8 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ github.com/gliderlabs/ssh v0.3.8 h1:a4YXD1V7xMF9g5nTkdfnja3Sxy1PVDCj1Zg4Wb8vY6c=
github.com/gliderlabs/ssh v0.3.8/go.mod h1:xYoytBv1sV0aL3CavoDuJIQNURXkkfPA/wxQ1pL1fAU=
github.com/go-git/gcfg/v2 v2.0.2 h1:MY5SIIfTGGEMhdA7d7JePuVVxtKL7Hp+ApGDJAJ7dpo=
github.com/go-git/gcfg/v2 v2.0.2/go.mod h1:/lv2NsxvhepuMrldsFilrgct6pxzpGdSRC13ydTLSLs=
github.com/go-git/go-billy/v6 v6.0.0-20251209065551-8afc3eb64e4d h1:nfZPVEha54DwXl8twSNxi9J8edIiqfpSvnq/mGPfgc4=
github.com/go-git/go-billy/v6 v6.0.0-20251209065551-8afc3eb64e4d/go.mod h1:d3XQcsHu1idnquxt48kAv+h+1MUiYKLH/e7LAzjP+pI=
github.com/go-git/go-git-fixtures/v5 v5.1.1 h1:OH8i1ojV9bWfr0ZfasfpgtUXQHQyVS8HXik/V1C099w=
github.com/go-git/go-git-fixtures/v5 v5.1.1/go.mod h1:Altk43lx3b1ks+dVoAG2300o5WWUnktvfY3VI6bcaXU=
github.com/go-git/go-git/v6 v6.0.0-20251123162143-36fa81975a20 h1:T1iYBFBFcB5Kjpq5BjCET47+Xc+blVhFDJ4cM7SJImw=
github.com/go-git/go-git/v6 v6.0.0-20251123162143-36fa81975a20/go.mod h1:82JGB4xCU6W8toVHjEcv4KH4GSiB+MhjFTCGQxPOLdM=
github.com/go-git/go-billy/v6 v6.0.0-20251215223226-9a435375010d h1:/18mhRKvhulzdxqNuyhaEVtJgfl+hrYBJ/yl2v4lCKg=
github.com/go-git/go-billy/v6 v6.0.0-20251215223226-9a435375010d/go.mod h1:d3XQcsHu1idnquxt48kAv+h+1MUiYKLH/e7LAzjP+pI=
github.com/go-git/go-git-fixtures/v5 v5.1.2-0.20251217024734-e267099c9ed5 h1:3PN91izCLX3c2mMqXDHpF9ift/yVticGUTPu/eGfX0M=
github.com/go-git/go-git-fixtures/v5 v5.1.2-0.20251217024734-e267099c9ed5/go.mod h1:0mL/38Gupl98cI/OAAF+inDRhyKM9ic5FLuIY+zCTCE=
github.com/go-git/go-git/v6 v6.0.0-20251218224324-ede584db67a4 h1:M8aO2/N4F0dLkFRhEK+SN/kdxEQr0tD5UlCMiXxlFqc=
github.com/go-git/go-git/v6 v6.0.0-20251218224324-ede584db67a4/go.mod h1:JpR+9QlEMKtBgshm5dybpsz1cjmXU8u7ZnMnI3glMIo=
github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 h1:f+oWsMOmNPc8JmEHVZIycC7hBoQxHH9pNKQORJNozsQ=
github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8/go.mod h1:wcDNUvekVysuuOpQKo3191zZyTpiI6se1N1ULghS0sw=
github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
Expand Down Expand Up @@ -57,8 +57,8 @@ github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD
go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
golang.org/x/crypto v0.46.0 h1:cKRW/pmt1pKAfetfu+RCEvjvZkA9RimPbh7bhFjGVBU=
golang.org/x/crypto v0.46.0/go.mod h1:Evb/oLKmMraqjZ2iQTwDwvCtJkczlDuTmdJXoZVzqU0=
golang.org/x/net v0.47.0 h1:Mx+4dIFzqraBXUugkia1OOvlD6LemFo1ALMHjrXDOhY=
golang.org/x/net v0.47.0/go.mod h1:/jNxtkgq5yWUGYkaZGqo27cfGZ1c5Nen03aYrrKpVRU=
golang.org/x/net v0.48.0 h1:zyQRTTrjc33Lhh0fBgT/H3oZq9WuvRR5gPC70xpDiQU=
golang.org/x/net v0.48.0/go.mod h1:+ndRgGjkh8FGtu1w1FGbEC31if4VrNVMuKTgcAAnQRY=
golang.org/x/sys v0.39.0 h1:CvCKL8MeisomCi6qNZ+wbb0DN9E5AATixKsvNtMoMFk=
golang.org/x/sys v0.39.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
golang.org/x/term v0.38.0 h1:PQ5pkm/rLO6HnxFR7N2lJHOZX6Kez5Y1gDSJla6jo7Q=
Expand Down