beads/cmd/bd/worktree_cmd.go
Julian Knutsen ba2f0afe4a
refactor(worktree): route addToGitignore through gitignore.AppendLines (post-merge #5677) (#7006)
#5677 made addToGitignore preserve a CRLF .gitignore by consuming
gitignore.AppendLineEnding, but it re-implemented the rest of the #6343
append policy inline: the final-line completion, including the rule that a
trailing CR is completed with a bare LF. That policy already lives in
gitignore.AppendLines, which the three other project-ignore writers call.
The two copies are byte-equivalent today, and only one of them is
discoverable when the policy changes.

Derive the appended bytes from AppendLines instead. Its contract leaves the
existing bytes unchanged, so everything past len(content) is exactly the
append, and writing only that suffix keeps the O_APPEND handle: the user's
.gitignore is still appended to, never truncated and rewritten. The write
also becomes a single Write call instead of a separator write followed by an
Fprintf.

No behavior change. The call-site tests pass unmodified, byte for byte. The
doc comment on TestAddToGitignoreCompletesUnterminatedCRLFLine is reworded
because it described the removed separator variable; the arm it pins, and
why only that test reaches it, are unchanged.

Agent-Signature: claude-code-claude-opus-5-5-max on behalf of Gas City Adopt-PR

Co-authored-by: Eddie the Engineer <adopt-pr@gascity.local>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-01 05:24:11 -07:00

2395 lines
70 KiB
Go
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

package main
import (
"bytes"
"context"
"crypto/sha256"
"encoding/json"
"errors"
"fmt"
"io"
"os"
"os/exec"
"path/filepath"
"runtime"
"sort"
"strconv"
"strings"
"unicode/utf8"
"github.com/spf13/cobra"
"github.com/steveyegge/beads/internal/beads"
"github.com/steveyegge/beads/internal/config"
"github.com/steveyegge/beads/internal/execenv"
"github.com/steveyegge/beads/internal/git"
"github.com/steveyegge/beads/internal/gitenv"
"github.com/steveyegge/beads/internal/gitignore"
"github.com/steveyegge/beads/internal/metrics"
"github.com/steveyegge/beads/internal/ui"
"github.com/steveyegge/beads/internal/worktreeremove"
)
// WorktreeInfo contains information about a git worktree
type WorktreeInfo struct {
Name string `json:"name"`
Path string `json:"path"`
Branch string `json:"branch"`
IsMain bool `json:"is_main"`
BeadsState string `json:"beads_state"` // "redirect", "shared", "none"
RedirectTo string `json:"redirect_to,omitempty"`
}
var worktreeCmd = &cobra.Command{
Use: "worktree",
Short: "Manage git worktrees for parallel development",
GroupID: "maint",
Annotations: map[string]string{skipStoreAnnotation: "1"},
Long: `Manage git worktrees with proper beads configuration.
Worktrees allow multiple working directories sharing the same git repository,
enabling parallel development (e.g., multiple agents or features).
Worktrees automatically share the same beads database as the main repository
via git common directory discovery — no manual redirect configuration needed.
Examples:
bd worktree create feature-auth # Create worktree
bd worktree create bugfix --branch fix-1 # Create with specific branch name
bd worktree list # List all worktrees
bd worktree remove feature-auth # Remove worktree (with safety checks)
bd worktree info # Show info about current worktree`,
}
var worktreeCreateCmd = &cobra.Command{
Use: "create <name> [--branch=<branch>]",
Short: "Create a worktree",
Long: `Create a git worktree for parallel development.
This command:
1. Creates a git worktree at ./<name> (or specified path)
2. Adds the worktree path to .gitignore (if inside repo root)
The worktree automatically shares the same beads database as the main
repository via git common directory discovery — no redirect file needed.
Examples:
bd worktree create feature-auth # Create at ./feature-auth
bd worktree create bugfix --branch fix-1 # Create with branch name
bd worktree create ../agents/worker-1 # Create at relative path`,
Args: cobra.ExactArgs(1),
SilenceUsage: true,
SilenceErrors: true,
RunE: runWorktreeCreate,
}
var worktreeListCmd = &cobra.Command{
Use: "list",
Short: "List all git worktrees",
Long: `List all git worktrees and their beads configuration state.
Shows each worktree with:
- Name (directory name)
- Path (full path)
- Branch
- Beads state: "redirect" (uses shared db), "shared" (is main), "none" (no beads)
Examples:
bd worktree list # List all worktrees
bd worktree list --json # JSON output`,
Args: cobra.NoArgs,
SilenceUsage: true,
SilenceErrors: true,
RunE: runWorktreeList,
}
var worktreeInfoCmd = &cobra.Command{
Use: "info",
Short: "Show worktree info for current directory",
Long: `Show information about the current worktree.
If the current directory is in a git worktree, shows:
- Worktree path and name
- Branch
- Beads configuration (redirect or main)
- Main repository location
Examples:
bd worktree info # Show current worktree info
bd worktree info --json # JSON output`,
Args: cobra.NoArgs,
SilenceUsage: true,
SilenceErrors: true,
RunE: runWorktreeInfo,
}
var (
worktreeBranch string
)
func init() {
worktreeCreateCmd.Flags().StringVar(&worktreeBranch, "branch", "", "Branch name for the worktree (default: same as name)")
worktreeCmd.AddCommand(worktreeCreateCmd)
worktreeCmd.AddCommand(worktreeListCmd)
worktreeCmd.AddCommand(worktreeRemoveCmd)
worktreeCmd.AddCommand(worktreeInfoCmd)
rootCmd.AddCommand(worktreeCmd)
}
// repairWorktreeBeadsPermissions applies FixBeadsDirPermissions to worktreePath/.beads when
// the directory exists. Git worktree checkout can leave tracked .beads/ at permissive modes.
func repairWorktreeBeadsPermissions(worktreePath string) {
beadsDir := filepath.Join(worktreePath, ".beads")
if fixed, err := config.FixBeadsDirPermissions(beadsDir); err != nil {
if !jsonOutput {
fmt.Fprintf(os.Stderr, "Warning: could not fix worktree .beads permissions: %v\n", err)
}
} else if fixed && !jsonOutput {
fmt.Fprintf(os.Stderr, "Fixed .beads permissions to %04o\n", config.BeadsDirPerm)
}
}
func runWorktreeCreate(cmd *cobra.Command, args []string) error {
CheckReadonly("worktree create")
evt := metrics.NewCommandEvent("worktree-create")
defer func() {
if c := metrics.Global(); c != nil {
c.CloseEventAndAdd(evt)
}
}()
ctx := context.Background()
name := args[0]
// Determine worktree path
worktreePath, err := filepath.Abs(name)
if err != nil {
return fmt.Errorf("failed to resolve path: %w", err)
}
// Check if path already exists
if _, err := os.Stat(worktreePath); err == nil {
return fmt.Errorf("path already exists: %s", worktreePath)
}
// Get repository context (validates .beads exists and resolves paths)
rc, err := beads.GetRepoContext()
if err != nil {
return fmt.Errorf("%s; %s: %w", activeWorkspaceNotFoundError(), diagHint(), err)
}
// Worktree operations use CWD repo (where user is working), not BEADS_DIR repo
repoRoot := rc.CWDRepoRoot
if repoRoot == "" {
return fmt.Errorf("not in a git repository")
}
// Determine branch name
branch := worktreeBranch
if branch == "" {
branch = filepath.Base(name)
}
// Create the worktree using secure git command
gitCmd := gitCmdInDir(ctx, repoRoot, "worktree", "add", "-b", branch, worktreePath)
output, err := gitCmd.CombinedOutput()
if err != nil {
// Try without -b if branch already exists
gitCmd = gitCmdInDir(ctx, repoRoot, "worktree", "add", worktreePath, branch)
output, err = gitCmd.CombinedOutput()
if err != nil {
return fmt.Errorf("failed to create worktree: %w\n%s", err, string(output))
}
}
if err := checkCreatedWorktreeClean(ctx, worktreePath); err != nil {
return err
}
// Tracked .beads/ checked out by git worktree add can inherit umask defaults (0755).
// Align with bd init / GH#3391 so agent loops do not hit permission warnings (GH#3593).
repairWorktreeBeadsPermissions(worktreePath)
// Add to .gitignore if worktree is inside repo root
if strings.HasPrefix(worktreePath, repoRoot+string(os.PathSeparator)) {
// Use relative path from repo root for gitignore entry
relWorktreePath, err := filepath.Rel(repoRoot, worktreePath)
if err != nil {
relWorktreePath = filepath.Base(worktreePath)
}
relWorktreePath = filepath.ToSlash(relWorktreePath)
if err := addToGitignore(ctx, repoRoot, relWorktreePath); err != nil {
// Non-fatal, just warn
fmt.Fprintf(os.Stderr, "Warning: failed to update .gitignore: %v\n", err)
}
}
if jsonOutput {
result := map[string]interface{}{
"path": worktreePath,
"branch": branch,
}
encoder := json.NewEncoder(os.Stdout)
encoder.SetIndent("", " ")
return encoder.Encode(result)
}
fmt.Printf("%s Created worktree: %s\n", ui.RenderPass("✓"), worktreePath)
fmt.Printf(" Branch: %s\n", branch)
return nil
}
func runWorktreeList(cmd *cobra.Command, args []string) error {
evt := metrics.NewCommandEvent("worktree-list")
defer func() {
if c := metrics.Global(); c != nil {
c.CloseEventAndAdd(evt)
}
}()
ctx := context.Background()
// Get repository context
rc, err := beads.GetRepoContext()
if err != nil {
// Allow listing worktrees even without .beads (but no beads state info)
// Fall back to git.GetRepoRoot() for this case
repoRoot := git.GetRepoRoot()
if repoRoot == "" {
return fmt.Errorf("not in a git repository")
}
return listWorktreesWithoutBeads(ctx, repoRoot)
}
// Worktree operations use CWD repo (where user is working)
repoRoot := rc.CWDRepoRoot
if repoRoot == "" {
return fmt.Errorf("not in a git repository")
}
// List worktrees using secure git command
gitCmd := gitCmdInDir(ctx, repoRoot, "worktree", "list", "--porcelain")
output, err := gitCmd.CombinedOutput()
if err != nil {
return fmt.Errorf("failed to list worktrees: %w", err)
}
// Parse worktree list
worktrees := parseWorktreeList(string(output))
// Enrich with beads state (using BeadsDir from RepoContext)
mainBeadsDir := rc.BeadsDir
for i := range worktrees {
worktrees[i].BeadsState = getBeadsState(worktrees[i].Path, mainBeadsDir)
if worktrees[i].BeadsState == "redirect" {
worktrees[i].RedirectTo = getRedirectTarget(worktrees[i].Path)
}
}
if jsonOutput {
encoder := json.NewEncoder(os.Stdout)
encoder.SetIndent("", " ")
return encoder.Encode(worktrees)
}
// Human-readable output
if len(worktrees) == 0 {
fmt.Println("No worktrees found")
return nil
}
fmt.Printf("%-20s %-40s %-20s %s\n", "NAME", "PATH", "BRANCH", "BEADS")
for _, wt := range worktrees {
name := filepath.Base(wt.Path)
if wt.IsMain {
name = "(main)"
}
beadsInfo := wt.BeadsState
if wt.RedirectTo != "" {
beadsInfo = fmt.Sprintf("redirect → %s", filepath.Base(filepath.Dir(wt.RedirectTo)))
}
fmt.Printf("%-20s %-40s %-20s %s\n",
truncate(name, 20),
truncate(wt.Path, 40),
truncate(wt.Branch, 20),
beadsInfo)
}
return nil
}
func runWorktreeRemove(
cmd *cobra.Command,
args []string,
options *worktreeRemoveOptions,
hooks worktreeRemoveHooks,
) error {
CheckReadonly("worktree remove")
evt := metrics.NewCommandEvent("worktree-remove")
defer func() {
if c := metrics.Global(); c != nil {
c.CloseEventAndAdd(evt)
}
}()
mode := worktreeremove.Normal
if options.force.value {
mode = worktreeremove.Force
}
adapter := &gitWorktreeRemovalAdapter{name: args[0], options: options, hooks: hooks}
return runWorktreeRemovalOrchestration(
cmd.Context(),
worktreeRemovalRequest{mode: mode},
adapter,
adapter,
cliWorktreeRemovalPresenter{},
)
}
type worktreeRemovalPartialError struct {
path string
stage string
err error
}
func (err *worktreeRemovalPartialError) Error() string {
return fmt.Sprintf(
"worktree was removed at %s, but %s failed: %v; removal was not rolled back",
err.path,
err.stage,
err.err,
)
}
func (err *worktreeRemovalPartialError) Unwrap() error {
return err.err
}
func runWorktreeInfo(cmd *cobra.Command, args []string) error {
evt := metrics.NewCommandEvent("worktree-info")
defer func() {
if c := metrics.Global(); c != nil {
c.CloseEventAndAdd(evt)
}
}()
ctx := context.Background()
cwd, err := os.Getwd()
if err != nil {
return fmt.Errorf("failed to get current directory: %w", err)
}
// Check if we're in a worktree (use RepoContext if available, fallback to git)
var isWorktree bool
rc, rcErr := beads.GetRepoContext()
if rcErr == nil {
isWorktree = rc.IsWorktree
} else {
isWorktree = git.IsWorktree()
}
if !isWorktree {
if jsonOutput {
result := map[string]interface{}{
"is_worktree": false,
}
encoder := json.NewEncoder(os.Stdout)
encoder.SetIndent("", " ")
return encoder.Encode(result)
}
fmt.Println("Not in a git worktree (this is the main repository)")
return nil
}
// Get worktree info
mainRepoRoot, err := git.GetMainRepoRoot()
if err != nil {
mainRepoRoot = "(unknown)"
}
branch := getWorktreeCurrentBranch(ctx, cwd)
redirectInfo := beads.GetRedirectInfo()
if jsonOutput {
result := map[string]interface{}{
"is_worktree": true,
"path": cwd,
"name": filepath.Base(cwd),
"branch": branch,
"main_repo": mainRepoRoot,
"beads_redirected": redirectInfo.IsRedirected,
}
if redirectInfo.IsRedirected {
result["beads_local"] = redirectInfo.LocalDir
result["beads_target"] = redirectInfo.TargetDir
}
encoder := json.NewEncoder(os.Stdout)
encoder.SetIndent("", " ")
return encoder.Encode(result)
}
fmt.Printf("Worktree: %s\n", cwd)
fmt.Printf(" Name: %s\n", filepath.Base(cwd))
fmt.Printf(" Branch: %s\n", branch)
fmt.Printf(" Main repo: %s\n", mainRepoRoot)
if redirectInfo.IsRedirected {
fmt.Printf(" Beads: redirects to %s\n", redirectInfo.TargetDir)
} else {
fmt.Printf(" Beads: local (no redirect)\n")
}
return nil
}
// Helper functions
var checkCreatedWorktreeClean = ensureCreatedWorktreeClean
func ensureCreatedWorktreeClean(ctx context.Context, worktreePath string) error {
gitCmd := gitCmdInDir(ctx, worktreePath, "status", "--porcelain=v1", "--untracked-files=all")
output, err := gitCmd.CombinedOutput()
if err != nil {
return fmt.Errorf("failed to inspect created worktree cleanliness: %w\n%s", err, string(output))
}
if status := strings.TrimSpace(string(output)); status != "" {
return fmt.Errorf("created worktree is dirty after checkout; refusing to continue: %s\n%s", worktreePath, status)
}
return nil
}
// gitCmdInDir creates a git command that runs in the specified directory.
// This is used for worktree operations that need to run in a specific location
// (either the CWD repo root or a specific worktree path).
//
// Security: Sets core.hooksPath and GIT_TEMPLATE_DIR to disable hooks/templates
// for defense-in-depth, matching the pattern in RepoContext.GitCmd().
func gitCmdInDir(ctx context.Context, dir string, args ...string) *exec.Cmd {
gitArgs := append([]string{"-c", "core.hooksPath="}, args...)
cmd := exec.CommandContext(ctx, "git", gitArgs...)
cmd.Dir = dir
// Security: Disable git hooks and templates (SEC-001, SEC-002)
cmd.Env = append(scrubWorktreeGitRoutingEnv(os.Environ()),
"GIT_TEMPLATE_DIR=",
)
return cmd
}
// listWorktreesWithoutBeads lists worktrees when no .beads directory exists.
// This fallback allows the command to work in repos that haven't been initialized.
func listWorktreesWithoutBeads(ctx context.Context, repoRoot string) error {
gitCmd := gitCmdInDir(ctx, repoRoot, "worktree", "list", "--porcelain")
output, err := gitCmd.CombinedOutput()
if err != nil {
return fmt.Errorf("failed to list worktrees: %w", err)
}
worktrees := parseWorktreeList(string(output))
// Set beads state to "none" for all worktrees
for i := range worktrees {
worktrees[i].BeadsState = "none"
}
if jsonOutput {
encoder := json.NewEncoder(os.Stdout)
encoder.SetIndent("", " ")
return encoder.Encode(worktrees)
}
// Human-readable output
if len(worktrees) == 0 {
fmt.Println("No worktrees found")
return nil
}
fmt.Printf("%-20s %-40s %-20s %s\n", "NAME", "PATH", "BRANCH", "BEADS")
for _, wt := range worktrees {
name := filepath.Base(wt.Path)
if wt.IsMain {
name = "(main)"
}
fmt.Printf("%-20s %-40s %-20s %s\n",
truncate(name, 20),
truncate(wt.Path, 40),
truncate(wt.Branch, 20),
"none")
}
return nil
}
func parseWorktreeList(output string) []WorktreeInfo {
var worktrees []WorktreeInfo
var current WorktreeInfo
lines := strings.Split(output, "\n")
for _, line := range lines {
if strings.HasPrefix(line, "worktree ") {
if current.Path != "" {
worktrees = append(worktrees, current)
}
path := strings.TrimPrefix(line, "worktree ")
current = WorktreeInfo{
Path: path,
Name: filepath.Base(path),
}
} else if strings.HasPrefix(line, "HEAD ") {
// Skip HEAD hash
} else if strings.HasPrefix(line, "branch ") {
current.Branch = strings.TrimPrefix(line, "branch refs/heads/")
} else if line == "bare" {
current.IsMain = true
current.Branch = "(bare)"
}
}
if current.Path != "" {
worktrees = append(worktrees, current)
}
// Mark the first non-bare worktree as main
if len(worktrees) > 0 && worktrees[0].Branch != "(bare)" {
worktrees[0].IsMain = true
}
return worktrees
}
func getBeadsState(worktreePath, mainBeadsDir string) string {
beadsDir := filepath.Join(worktreePath, ".beads")
redirectFile := filepath.Join(beadsDir, beads.RedirectFileName)
if _, err := os.Stat(redirectFile); err == nil {
return "redirect"
}
if _, err := os.Stat(beadsDir); err == nil {
// Check if this is the main beads dir
absBeadsDir, _ := filepath.Abs(beadsDir)
absMainBeadsDir, _ := filepath.Abs(mainBeadsDir)
if absBeadsDir == absMainBeadsDir {
return "shared"
}
return "local"
}
return "none"
}
func getRedirectTarget(worktreePath string) string {
redirectFile := filepath.Join(worktreePath, ".beads", beads.RedirectFileName)
// #nosec G304 - path is constructed from worktreePath which comes from git worktree list
data, err := os.ReadFile(redirectFile)
if err != nil {
return ""
}
target := strings.TrimSpace(string(data))
// Resolve relative paths from the worktree root (matching FollowRedirect behavior)
if !filepath.IsAbs(target) {
target = filepath.Join(worktreePath, target)
}
target, _ = filepath.Abs(target)
return target
}
func resolveWorktreePath(ctx context.Context, repoRoot, name string) (string, error) {
// Try as absolute path first
if filepath.IsAbs(name) {
if _, err := os.Stat(name); err == nil {
return name, nil
}
}
// Try relative to cwd
absPath, _ := filepath.Abs(name)
if _, err := os.Stat(absPath); err == nil {
return absPath, nil
}
// Try relative to repo root
repoPath := filepath.Join(repoRoot, name)
if _, err := os.Stat(repoPath); err == nil {
return repoPath, nil
}
// Consult git's worktree registry - match by name (basename) or path
// This handles worktrees created in subdirectories (e.g., .worktrees/foo)
// where the name shown in "bd worktree list" doesn't match a simple path
gitCmd := gitCmdInDir(ctx, repoRoot, "worktree", "list", "--porcelain")
output, err := gitCmd.CombinedOutput()
if err == nil {
worktrees := parseWorktreeList(string(output))
for _, wt := range worktrees {
if wt.Name == name || wt.Path == name {
if _, err := os.Stat(wt.Path); err == nil {
return wt.Path, nil
}
}
}
}
return "", fmt.Errorf("worktree not found: %s", name)
}
type worktreeRemovalGit struct {
executable string
env []string
}
func newWorktreeRemovalGit() (*worktreeRemovalGit, error) {
executable, err := exec.LookPath("git")
if err != nil {
return nil, fmt.Errorf("cannot find git executable: %w", err)
}
executable, err = filepath.Abs(executable)
if err != nil {
return nil, fmt.Errorf("cannot pin git executable path: %w", err)
}
if resolved, resolveErr := filepath.EvalSymlinks(executable); resolveErr == nil {
executable = resolved
}
env := scrubWorktreeRemovalGitEnv(os.Environ())
env = append(
env,
"GIT_CONFIG_GLOBAL="+os.DevNull,
"GIT_CONFIG_SYSTEM="+os.DevNull,
"GIT_CONFIG_NOSYSTEM=1",
"GIT_NO_REPLACE_OBJECTS=1",
"GIT_OPTIONAL_LOCKS=0",
"GIT_TEMPLATE_DIR=",
)
return &worktreeRemovalGit{
executable: executable,
env: env,
}, nil
}
func scrubWorktreeGitRoutingEnv(env []string) []string {
return scrubWorktreeGitRoutingEnvForOS(env, runtime.GOOS)
}
// scrubWorktreeGitRoutingEnvForOS removes inherited Git repository, index,
// object, namespace, executable, template, and custom config routing. It keeps
// explicit null config suppression, GIT_CONFIG_NOSYSTEM and non-routing controls
// such as GIT_OPTIONAL_LOCKS; the removal runner applies its stricter policy separately.
func scrubWorktreeGitRoutingEnvForOS(env []string, goos string) []string {
return gitenv.ScrubRoutingForOS(env, goos)
}
func scrubWorktreeRemovalGitEnv(env []string) []string {
return scrubWorktreeRemovalGitEnvForOS(env, runtime.GOOS)
}
func scrubWorktreeRemovalGitEnvForOS(env []string, goos string) []string {
cleaned := scrubWorktreeGitRoutingEnvForOS(env, goos)
// ScrubRoutingForOS returns a fresh slice, so filtering it in place is safe.
result := cleaned[:0]
for _, entry := range cleaned {
// One shared subprocess key identity: execenv mirrors os/exec's fold, so
// this drops exactly the entries a child process would treat as these two
// variables -- an independent fold here would diverge from that rule.
// ToUpper is not that rule; the two disagree in both directions for
// non-ASCII keys on Windows: ToUpper leaves GİT_OPTIONAL_LOCKS unmatched
// although Git honors it, and folds GIT_OPTIONAL_LOCKſ onto the literal
// although os/exec keeps it distinct.
key := worktreeGitEnvKey(entry)
if execenv.KeyEqualForOS(key, "GIT_NO_REPLACE_OBJECTS", goos) ||
execenv.KeyEqualForOS(key, "GIT_OPTIONAL_LOCKS", goos) {
continue
}
result = append(result, entry)
}
return result
}
func worktreeGitEnvKey(entry string) string {
return gitenv.EntryKey(entry)
}
// clearWorktreeGitRoutingEnv establishes the command working directory as the
// repository-selection boundary without changing process identity or signal
// semantics. Startup config discovery applies the same boundary to its one
// pre-hook Git probe, and the .beads discovery probes that run against an
// already selected path share it too (beads.selectedBeadsGitOutput and
// ResolveBeadsDirForRepo). The generic internal/beads gitOutput probes and
// internal/git/gitdir.go still honor inherited routing, so those planes can
// still resolve a different repository than this one (bd-p4che).
//
// Unlike the child-process scrubs elsewhere in this package, ClearRouting
// unsets the variables on the bd process itself, so bd's own discovery —
// getGitContext, GetMainRepoRoot, FindBeadsDir and startup config discovery —
// runs under the cleared environment for the whole command. The boundary
// removes inherited discovery redirects, but it is not a floor: the
// discovery-scope controls go with the redirection ones, and they do not all
// move discovery the same way:
//
// - GIT_CEILING_DIRECTORIES is a stop, so clearing it widens the walk: a
// stale inherited ceiling can no longer hide the repository the command is
// standing in, but with no repository at or below the working directory the
// walk can now reach a containing parent that ceiling excluded (init's role
// probe records the same trade-off).
// - GIT_DISCOVERY_ACROSS_FILESYSTEM only ever permits — git stops at a
// filesystem boundary unless this is true — so clearing it narrows the
// walk: a repository reachable from the working directory only by crossing
// a mount point is no longer found by any bd worktree verb, and there is no
// opt-out.
// - ClearRouting matches GIT_CONFIG by prefix, so the redirecting members of
// the GIT_CONFIG* family — a custom GIT_CONFIG_GLOBAL or GIT_CONFIG_SYSTEM
// path, GIT_CONFIG_COUNT and its numbered key/value pairs — are dropped for
// the command's lifetime rather than for one child probe. The explicit
// suppression forms are the exception: ClearRouting keeps
// GIT_CONFIG_NOSYSTEM and the /dev/null spellings of GIT_CONFIG_GLOBAL and
// GIT_CONFIG_SYSTEM, which can blind a read but cannot redirect one.
func clearWorktreeGitRoutingEnv(cmd *cobra.Command) error {
if !hasWorktreeCommandAncestor(cmd) {
return nil
}
if _, err := gitenv.ClearRouting(); err != nil {
return fmt.Errorf("clear inherited Git routing for worktree command: %w", err)
}
return nil
}
func hasWorktreeCommandAncestor(cmd *cobra.Command) bool {
for current := cmd; current != nil; current = current.Parent() {
if current == worktreeCmd {
return true
}
}
return false
}
func (git *worktreeRemovalGit) command(ctx context.Context, dir string, args ...string) *exec.Cmd {
gitArgs := make([]string, 0, len(args)+4)
gitArgs = append(gitArgs, "-c", "core.hooksPath=", "-c", "core.fsmonitor=false")
gitArgs = append(gitArgs, args...)
command := exec.CommandContext(ctx, git.executable, gitArgs...)
command.Dir = dir
command.Env = append([]string(nil), git.env...)
return command
}
func (git *worktreeRemovalGit) output(ctx context.Context, dir string, args ...string) ([]byte, error) {
command := git.command(ctx, dir, args...)
output, err := command.Output()
if err == nil {
return output, nil
}
var exitError *exec.ExitError
if errors.As(err, &exitError) {
stderr := strings.TrimSpace(string(exitError.Stderr))
if stderr != "" {
return output, fmt.Errorf("%w: %s", err, stderr)
}
}
return output, err
}
func (git *worktreeRemovalGit) combinedOutput(ctx context.Context, dir string, args ...string) ([]byte, error) {
return git.command(ctx, dir, args...).CombinedOutput()
}
type registeredWorktree struct {
path string
headOID string
branch string
detached bool
bare bool
locked bool
lockReason string
prunable bool
pruneReason string
isMain bool
}
func listRegisteredWorktrees(
ctx context.Context,
git *worktreeRemovalGit,
executionRoot string,
) ([]registeredWorktree, error) {
output, err := git.output(ctx, executionRoot, "worktree", "list", "--porcelain", "-z")
if err != nil {
return nil, fmt.Errorf("failed to read git worktree registry: %w", err)
}
var worktrees []registeredWorktree
var current registeredWorktree
appendCurrent := func() {
if current.path == "" {
return
}
current.isMain = len(worktrees) == 0
worktrees = append(worktrees, current)
current = registeredWorktree{}
}
for _, field := range strings.Split(string(output), "\x00") {
if field == "" {
continue
}
switch {
case strings.HasPrefix(field, "worktree "):
appendCurrent()
current.path = strings.TrimPrefix(field, "worktree ")
case strings.HasPrefix(field, "HEAD "):
current.headOID = strings.TrimPrefix(field, "HEAD ")
case strings.HasPrefix(field, "branch "):
current.branch = strings.TrimPrefix(field, "branch ")
case field == "detached":
current.detached = true
case field == "bare":
current.bare = true
case field == "locked":
current.locked = true
case strings.HasPrefix(field, "locked "):
current.locked = true
current.lockReason = strings.TrimPrefix(field, "locked ")
case field == "prunable":
current.prunable = true
case strings.HasPrefix(field, "prunable "):
current.prunable = true
current.pruneReason = strings.TrimPrefix(field, "prunable ")
}
}
appendCurrent()
if len(worktrees) == 0 {
return nil, fmt.Errorf("git worktree registry is empty")
}
return worktrees, nil
}
func sameWorktreePath(left, right string) bool {
leftAbsolute, leftErr := filepath.Abs(left)
rightAbsolute, rightErr := filepath.Abs(right)
if leftErr != nil || rightErr != nil {
return false
}
leftAbsolute = filepath.Clean(leftAbsolute)
rightAbsolute = filepath.Clean(rightAbsolute)
// When both paths are missing, peel exact components in lockstep until
// existing ancestors can prove physical identity. This accepts equivalent
// ancestor spellings such as a Windows 8.3 alias without ever case-folding
// an unresolved component.
for {
leftInfo, leftStatErr := os.Stat(leftAbsolute)
rightInfo, rightStatErr := os.Stat(rightAbsolute)
if leftStatErr == nil || rightStatErr == nil {
return leftStatErr == nil &&
rightStatErr == nil &&
os.SameFile(leftInfo, rightInfo)
}
if !os.IsNotExist(leftStatErr) || !os.IsNotExist(rightStatErr) {
return false
}
if filepath.Base(leftAbsolute) != filepath.Base(rightAbsolute) {
return false
}
leftParent := filepath.Dir(leftAbsolute)
rightParent := filepath.Dir(rightAbsolute)
if leftParent == leftAbsolute || rightParent == rightAbsolute {
return false
}
leftAbsolute = leftParent
rightAbsolute = rightParent
}
}
func findRegisteredWorktreeByPath(
worktrees []registeredWorktree,
path string,
) (registeredWorktree, bool) {
for _, worktree := range worktrees {
if sameWorktreePath(worktree.path, path) {
return worktree, true
}
}
return registeredWorktree{}, false
}
func resolveRegisteredWorktree(
name string,
currentRoot string,
mainRoot string,
worktrees []registeredWorktree,
) (registeredWorktree, error) {
candidatePaths := make([]string, 0, 3)
if filepath.IsAbs(name) {
candidatePaths = append(candidatePaths, name)
} else {
if currentCandidate, err := filepath.Abs(name); err == nil {
candidatePaths = append(candidatePaths, currentCandidate)
}
candidatePaths = append(candidatePaths, filepath.Join(currentRoot, name))
if !sameWorktreePath(currentRoot, mainRoot) {
candidatePaths = append(candidatePaths, filepath.Join(mainRoot, name))
}
}
allowBasename := filepath.Base(name) == name
matches := make([]registeredWorktree, 0, 1)
for _, worktree := range worktrees {
matched := false
for _, candidate := range candidatePaths {
if sameWorktreePath(worktree.path, candidate) {
matched = true
break
}
}
if !matched && allowBasename && filepath.Base(worktree.path) == name {
matched = true
}
if !matched {
continue
}
duplicate := false
for _, existing := range matches {
if sameWorktreePath(existing.path, worktree.path) {
duplicate = true
break
}
}
if !duplicate {
matches = append(matches, worktree)
}
}
switch len(matches) {
case 0:
return registeredWorktree{}, fmt.Errorf("registered worktree not found: %s", name)
case 1:
return matches[0], nil
default:
paths := make([]string, 0, len(matches))
for _, match := range matches {
paths = append(paths, match.path)
}
sort.Strings(paths)
return registeredWorktree{}, fmt.Errorf(
"worktree name %q is ambiguous; use an absolute path (matches: %s)",
name,
strings.Join(paths, ", "),
)
}
}
type pinnedWorktreeTarget struct {
path string
pathInfo os.FileInfo
gitDir string
gitDirInfo os.FileInfo
gitMarkerInfo os.FileInfo
gitDirFingerprint string
gitMarkerFingerprint string
commonDir string
headOID string
branch string
detached bool
bare bool
locked bool
lockReason string
prunable bool
pruneReason string
status string
statusFingerprint string
registryID string
}
func inspectWorktreeTarget(
ctx context.Context,
git *worktreeRemovalGit,
worktree registeredWorktree,
) (pinnedWorktreeTarget, error) {
gitDirOutput, err := git.output(ctx, worktree.path, "rev-parse", "--absolute-git-dir")
if err != nil {
return pinnedWorktreeTarget{}, fmt.Errorf("failed to resolve target git directory: %w", err)
}
gitDir := filepath.Clean(strings.TrimSpace(string(gitDirOutput)))
commonDirOutput, err := git.output(
ctx,
worktree.path,
"rev-parse",
"--path-format=absolute",
"--git-common-dir",
)
if err != nil {
return pinnedWorktreeTarget{}, fmt.Errorf("failed to resolve target common git directory: %w", err)
}
headOutput, err := git.output(
ctx,
worktree.path,
"rev-parse",
"--verify",
"--quiet",
"--end-of-options",
"HEAD^{commit}",
)
if err != nil {
return pinnedWorktreeTarget{}, fmt.Errorf("target HEAD does not resolve to a commit: %w", err)
}
statusOutput, err := git.output(
ctx,
worktree.path,
"status",
"--porcelain=v1",
"-z",
"--untracked-files=all",
"--ignore-submodules=none",
"--ignored=matching",
)
if err != nil {
return pinnedWorktreeTarget{}, fmt.Errorf("failed to inspect target cleanliness: %w", err)
}
headOID := strings.TrimSpace(string(headOutput))
if headOID == "" || headOID != worktree.headOID {
return pinnedWorktreeTarget{}, fmt.Errorf(
"target HEAD disagrees with git worktree registry (registry %q, target %q)",
worktree.headOID,
headOID,
)
}
pathInfo, err := os.Lstat(worktree.path)
if err != nil {
return pinnedWorktreeTarget{}, fmt.Errorf("failed to pin target directory identity: %w", err)
}
if pathInfo.Mode()&os.ModeSymlink != 0 || !pathInfo.IsDir() {
return pinnedWorktreeTarget{}, fmt.Errorf("target path is not a real directory: %s", worktree.path)
}
gitDirInfo, err := os.Lstat(gitDir)
if err != nil {
return pinnedWorktreeTarget{}, fmt.Errorf("failed to pin target git directory identity: %w", err)
}
if gitDirInfo.Mode()&os.ModeSymlink != 0 || !gitDirInfo.IsDir() {
return pinnedWorktreeTarget{}, fmt.Errorf("target git directory is not a real directory: %s", gitDir)
}
gitMarkerPath := filepath.Join(worktree.path, ".git")
gitMarkerInfo, err := os.Lstat(gitMarkerPath)
if err != nil {
return pinnedWorktreeTarget{}, fmt.Errorf("failed to pin target git marker identity: %w", err)
}
if gitMarkerInfo.Mode()&os.ModeSymlink != 0 || !gitMarkerInfo.Mode().IsRegular() {
return pinnedWorktreeTarget{}, fmt.Errorf("target git marker is not a regular file: %s", gitMarkerPath)
}
gitDirFingerprint, err := fingerprintWorktreeFilesystem(gitDir)
if err != nil {
return pinnedWorktreeTarget{}, fmt.Errorf("failed to fingerprint target git directory: %w", err)
}
gitMarkerFingerprint, err := fingerprintWorktreeFilesystem(gitMarkerPath)
if err != nil {
return pinnedWorktreeTarget{}, fmt.Errorf("failed to fingerprint target git marker: %w", err)
}
statusFingerprint, err := fingerprintWorktreeStatusPaths(worktree.path, string(statusOutput))
if err != nil {
return pinnedWorktreeTarget{}, fmt.Errorf("failed to fingerprint target changes: %w", err)
}
return pinnedWorktreeTarget{
path: filepath.Clean(worktree.path),
pathInfo: pathInfo,
gitDir: gitDir,
gitDirInfo: gitDirInfo,
gitMarkerInfo: gitMarkerInfo,
gitDirFingerprint: gitDirFingerprint,
gitMarkerFingerprint: gitMarkerFingerprint,
commonDir: filepath.Clean(strings.TrimSpace(string(commonDirOutput))),
headOID: headOID,
branch: worktree.branch,
detached: worktree.detached,
bare: worktree.bare,
locked: worktree.locked,
lockReason: worktree.lockReason,
prunable: worktree.prunable,
pruneReason: worktree.pruneReason,
status: string(statusOutput),
statusFingerprint: statusFingerprint,
registryID: worktreeRegistryIdentity(worktree),
}, nil
}
func fingerprintWorktreeFilesystem(path string) (string, error) {
hasher := sha256.New()
root := filepath.Clean(path)
err := filepath.WalkDir(root, func(current string, entry os.DirEntry, walkErr error) error {
if walkErr != nil {
return walkErr
}
info, err := entry.Info()
if err != nil {
return err
}
relative, err := filepath.Rel(root, current)
if err != nil {
return err
}
relative = filepath.ToSlash(relative)
if _, err := fmt.Fprintf(
hasher,
"%s\x00%s\x00%d\x00%d\x00",
relative,
info.Mode().String(),
info.Size(),
info.ModTime().UTC().UnixNano(),
); err != nil {
return err
}
switch {
case info.Mode().IsRegular():
file, err := os.Open(current) //nolint:gosec // path is rooted in a registered worktree or its gitdir
if err != nil {
return err
}
_, copyErr := io.Copy(hasher, file)
closeErr := file.Close()
if copyErr != nil {
return copyErr
}
if closeErr != nil {
return closeErr
}
case info.Mode()&os.ModeSymlink != 0:
target, err := os.Readlink(current)
if err != nil {
return err
}
if _, err := io.WriteString(hasher, target); err != nil {
return err
}
}
_, err = hasher.Write([]byte{0})
return err
})
if err != nil {
return "", err
}
return fmt.Sprintf("%x", hasher.Sum(nil)), nil
}
func fingerprintWorktreeStatusPaths(worktreePath, status string) (string, error) {
records := strings.Split(status, "\x00")
pathSet := make(map[string]struct{})
for index := 0; index < len(records); index++ {
record := records[index]
if record == "" {
continue
}
if len(record) < 4 || record[2] != ' ' {
return "", fmt.Errorf("unexpected porcelain status record %q", record)
}
code := record[:2]
pathSet[record[3:]] = struct{}{}
if strings.ContainsAny(code, "RC") {
index++
if index >= len(records) || records[index] == "" {
return "", fmt.Errorf("missing source path for porcelain rename/copy record %q", record)
}
pathSet[records[index]] = struct{}{}
}
}
paths := make([]string, 0, len(pathSet))
for path := range pathSet {
paths = append(paths, path)
}
sort.Strings(paths)
hasher := sha256.New()
for _, gitPath := range paths {
cleanPath := filepath.Clean(filepath.FromSlash(gitPath))
if cleanPath == "." ||
filepath.IsAbs(cleanPath) ||
cleanPath == ".." ||
strings.HasPrefix(cleanPath, ".."+string(filepath.Separator)) {
return "", fmt.Errorf("unsafe path %q in porcelain status", gitPath)
}
if _, err := fmt.Fprintf(hasher, "%s\x00", filepath.ToSlash(cleanPath)); err != nil {
return "", err
}
fingerprint, err := fingerprintWorktreeFilesystem(filepath.Join(worktreePath, cleanPath))
if err != nil {
if os.IsNotExist(err) {
fingerprint = "<missing>"
} else {
return "", err
}
}
if _, err := fmt.Fprintf(hasher, "%s\x00", fingerprint); err != nil {
return "", err
}
}
return fmt.Sprintf("%x", hasher.Sum(nil)), nil
}
func worktreeRegistryIdentity(worktree registeredWorktree) string {
return strings.Join([]string{
filepath.Clean(worktree.path),
worktree.branch,
strconv.FormatBool(worktree.detached),
strconv.FormatBool(worktree.bare),
strconv.FormatBool(worktree.locked),
worktree.lockReason,
strconv.FormatBool(worktree.prunable),
worktree.pruneReason,
}, "\x00")
}
type pinnedWorktreeComparator struct {
selector string
explicit bool
ref string
terminalRef string
oid string
}
type worktreeRemovalPlan struct {
git *worktreeRemovalGit
executionRoot string
mainWorktree string
commonDir string
target pinnedWorktreeTarget
comparator *pinnedWorktreeComparator
force bool
gitignoreCleanup *gitignoreCleanupPlan
prepareFacts worktreeremove.PrepareFacts
prepareErr error
}
func prepareWorktreeRemoval(
ctx context.Context,
name string,
options *worktreeRemoveOptions,
afterTargetResolution func() error,
) (*worktreeRemovalPlan, error) {
gitRunner, err := newWorktreeRemovalGit()
if err != nil {
return nil, err
}
currentDirectory, err := os.Getwd()
if err != nil {
return nil, fmt.Errorf("failed to resolve current directory: %w", err)
}
currentRootOutput, err := gitRunner.output(ctx, currentDirectory, "rev-parse", "--show-toplevel")
if err != nil {
return nil, fmt.Errorf("not in a git worktree: %w", err)
}
currentRoot := filepath.Clean(strings.TrimSpace(string(currentRootOutput)))
worktrees, err := listRegisteredWorktrees(ctx, gitRunner, currentRoot)
if err != nil {
return nil, err
}
mainWorktree := worktrees[0]
if mainWorktree.bare {
return nil, fmt.Errorf("cannot remove a worktree when the primary worktree is bare")
}
targetEntry, err := resolveRegisteredWorktree(name, currentRoot, mainWorktree.path, worktrees)
if err != nil {
return nil, err
}
plan := &worktreeRemovalPlan{
force: options.force.value,
prepareFacts: worktreeremove.PrepareFacts{
Registration: worktreeremove.Present,
},
}
if targetEntry.isMain {
plan.prepareFacts.Target = worktreeremove.PrimaryWorktree
return plan, nil
}
if sameWorktreePath(targetEntry.path, currentRoot) {
plan.prepareFacts.Target = worktreeremove.CurrentWorktree
return plan, nil
}
if afterTargetResolution != nil {
if err := afterTargetResolution(); err != nil {
return nil, fmt.Errorf("worktree removal interrupted after target resolution: %w", err)
}
}
mainCommonDirOutput, err := gitRunner.output(
ctx,
mainWorktree.path,
"rev-parse",
"--path-format=absolute",
"--git-common-dir",
)
if err != nil {
return nil, fmt.Errorf("failed to resolve repository common git directory: %w", err)
}
mainCommonDir := filepath.Clean(strings.TrimSpace(string(mainCommonDirOutput)))
target, err := inspectWorktreeTarget(ctx, gitRunner, targetEntry)
if err != nil {
return nil, err
}
plan = &worktreeRemovalPlan{
git: gitRunner,
executionRoot: filepath.Clean(mainWorktree.path),
mainWorktree: filepath.Clean(mainWorktree.path),
commonDir: mainCommonDir,
target: target,
force: options.force.value,
}
status := worktreeremove.Clean
if target.status != "" {
status = worktreeremove.Dirty
}
plan.prepareFacts = worktreeremove.PrepareFacts{
Registration: worktreeremove.Present,
Target: worktreeremove.RegisteredTarget,
RegisteredPath: target.path,
TargetDir: worktreeremove.Present,
GitAdminDir: worktreeremove.Present,
GitMarker: worktreeremove.Present,
CommonDir: worktreeremove.Matched,
Head: worktreeremove.Present,
Status: status,
ManagedIgnore: worktreeremove.IgnoreAbsent,
}
if !sameWorktreePath(target.commonDir, mainCommonDir) {
plan.prepareFacts.CommonDir = worktreeremove.Unmatched
plan.prepareErr = fmt.Errorf(
"target common git directory %q does not match repository %q",
target.commonDir,
mainCommonDir,
)
return plan, nil
}
if relative, inside := relativeWorktreePath(plan.mainWorktree, target.path); inside {
plan.gitignoreCleanup, err = prepareGitignoreCleanup(plan.mainWorktree, relative)
if err != nil {
return nil, fmt.Errorf("cannot safely prepare .gitignore cleanup: %w", err)
}
if plan.gitignoreCleanup != nil {
plan.prepareFacts.ManagedIgnore = worktreeremove.IgnoreManaged
plan.prepareFacts.ManagedIgnoreEntry = plan.gitignoreCleanup.entry
}
}
if options.force.value {
plan.prepareFacts.Comparator = worktreeremove.ComparatorNotRequired
plan.prepareFacts.Containment = worktreeremove.ContainmentNotRequired
return plan, nil
}
if target.status != "" {
return plan, nil
}
var comparator pinnedWorktreeComparator
if options.mergedInto.set {
comparator, err = resolveExplicitWorktreeComparator(
ctx,
gitRunner,
plan.executionRoot,
target,
options.mergedInto.value,
)
} else {
comparator, err = resolveUpstreamWorktreeComparator(
ctx,
gitRunner,
plan.executionRoot,
target,
)
}
if err != nil {
plan.prepareFacts.Comparator = worktreeremove.ComparatorMissing
plan.prepareErr = err
return plan, nil
}
plan.prepareFacts.Comparator = worktreeremove.ComparatorAvailable
containment, err := verifyWorktreeContainment(ctx, gitRunner, plan.executionRoot, target.headOID, comparator)
plan.prepareFacts.Containment = containment
if err != nil {
if containment == worktreeremove.ContainmentUnknown {
return nil, err
}
plan.prepareErr = err
return plan, nil
}
plan.comparator = &comparator
return plan, nil
}
func relativeWorktreePath(root, target string) (string, bool) {
relative, err := filepath.Rel(root, target)
if err != nil || relative == "." || filepath.IsAbs(relative) {
return "", false
}
if relative == ".." || strings.HasPrefix(relative, ".."+string(filepath.Separator)) {
return "", false
}
return filepath.ToSlash(relative), true
}
type worktreeRevalidationObservation struct {
facts worktreeremove.RevalidationFacts
err error
}
func (plan *worktreeRemovalPlan) observeRevalidation(ctx context.Context) worktreeRevalidationObservation {
facts := worktreeremove.RevalidationFacts{}
worktrees, err := listRegisteredWorktrees(ctx, plan.git, plan.executionRoot)
if err != nil {
return worktreeRevalidationObservation{facts: facts, err: err}
}
currentEntry, found := findRegisteredWorktreeByPath(worktrees, plan.target.path)
if !found {
facts.Registration = worktreeremove.InvariantChanged
return worktreeRevalidationObservation{facts: facts, err: fmt.Errorf("target is no longer registered at %s", plan.target.path)}
}
if worktreeRegistryIdentity(currentEntry) != plan.target.registryID {
facts.Registration = worktreeremove.InvariantChanged
if currentEntry.locked != plan.target.locked || currentEntry.lockReason != plan.target.lockReason ||
currentEntry.prunable != plan.target.prunable || currentEntry.pruneReason != plan.target.pruneReason {
facts.LockPrune = worktreeremove.InvariantChanged
}
return worktreeRevalidationObservation{facts: facts, err: fmt.Errorf("registered target identity changed")}
}
facts.Registration = worktreeremove.InvariantStable
facts.LockPrune = worktreeremove.InvariantStable
facts.TargetPath = worktreeremove.InvariantStable
currentTarget, err := inspectWorktreeTarget(ctx, plan.git, currentEntry)
if err != nil {
return worktreeRevalidationObservation{facts: facts, err: err}
}
if !sameWorktreePath(currentTarget.gitDir, plan.target.gitDir) {
facts.GitAdminDirectory = worktreeremove.InvariantChanged
return worktreeRevalidationObservation{facts: facts, err: fmt.Errorf("target git directory changed")}
}
facts.GitAdminDirectory = worktreeremove.InvariantStable
if !sameWorktreePath(currentTarget.commonDir, plan.commonDir) {
facts.CommonDirectory = worktreeremove.InvariantChanged
return worktreeRevalidationObservation{facts: facts, err: fmt.Errorf("target common git directory changed")}
}
facts.CommonDirectory = worktreeremove.InvariantStable
if currentTarget.headOID != plan.target.headOID {
facts.Head = worktreeremove.InvariantChanged
return worktreeRevalidationObservation{facts: facts, err: fmt.Errorf("target HEAD changed from %s to %s", plan.target.headOID, currentTarget.headOID)}
}
facts.Head = worktreeremove.InvariantStable
if currentTarget.status != plan.target.status {
if (currentTarget.status == "") != (plan.target.status == "") {
facts.Cleanliness = worktreeremove.InvariantChanged
} else {
facts.Cleanliness = worktreeremove.InvariantStable
}
facts.StatusBytes = worktreeremove.InvariantChanged
return worktreeRevalidationObservation{facts: facts, err: fmt.Errorf("target cleanliness changed")}
}
facts.Cleanliness = worktreeremove.InvariantStable
facts.StatusBytes = worktreeremove.InvariantStable
if currentTarget.statusFingerprint != plan.target.statusFingerprint {
facts.DirtyFileFingerprint = worktreeremove.InvariantChanged
return worktreeRevalidationObservation{facts: facts, err: fmt.Errorf("target changed files changed")}
}
facts.DirtyFileFingerprint = worktreeremove.InvariantStable
if !plan.force && currentTarget.status != "" {
facts.Cleanliness = worktreeremove.InvariantChanged
return worktreeRevalidationObservation{facts: facts, err: fmt.Errorf("target is no longer clean")}
}
if !os.SameFile(currentTarget.pathInfo, plan.target.pathInfo) ||
!samePinnedFileMetadata(currentTarget.pathInfo, plan.target.pathInfo) {
facts.TargetDirectory = worktreeremove.InvariantChanged
return worktreeRevalidationObservation{facts: facts, err: fmt.Errorf("target directory identity changed")}
}
facts.TargetDirectory = worktreeremove.InvariantStable
if !os.SameFile(currentTarget.gitDirInfo, plan.target.gitDirInfo) ||
!samePinnedFileMetadata(currentTarget.gitDirInfo, plan.target.gitDirInfo) {
facts.GitAdminDirectory = worktreeremove.InvariantChanged
return worktreeRevalidationObservation{facts: facts, err: fmt.Errorf("target git directory identity changed")}
}
facts.GitAdminDirectory = worktreeremove.InvariantStable
if !os.SameFile(currentTarget.gitMarkerInfo, plan.target.gitMarkerInfo) ||
!samePinnedFileMetadata(currentTarget.gitMarkerInfo, plan.target.gitMarkerInfo) {
facts.GitMarker = worktreeremove.InvariantChanged
return worktreeRevalidationObservation{facts: facts, err: fmt.Errorf("target git marker identity changed")}
}
facts.GitMarker = worktreeremove.InvariantStable
if currentTarget.gitDirFingerprint != plan.target.gitDirFingerprint {
facts.GitAdminDirectoryBytes = worktreeremove.InvariantChanged
return worktreeRevalidationObservation{facts: facts, err: fmt.Errorf("target git directory identity changed (contents mismatch)")}
}
facts.GitAdminDirectoryBytes = worktreeremove.InvariantStable
if currentTarget.gitMarkerFingerprint != plan.target.gitMarkerFingerprint {
facts.GitMarkerBytes = worktreeremove.InvariantChanged
return worktreeRevalidationObservation{facts: facts, err: fmt.Errorf("registered target identity changed (git marker mismatch)")}
}
facts.GitMarkerBytes = worktreeremove.InvariantStable
if plan.gitignoreCleanup != nil {
if err := plan.gitignoreCleanup.validate(); err != nil {
facts.ManagedIgnore = worktreeremove.InvariantChanged
return worktreeRevalidationObservation{facts: facts, err: fmt.Errorf(".gitignore changed before removal: %w", err)}
}
}
facts.ManagedIgnore = worktreeremove.InvariantStable
if plan.comparator == nil {
facts.Comparator = worktreeremove.InvariantNotRequired
facts.Containment = worktreeremove.InvariantNotRequired
return worktreeRevalidationObservation{facts: facts}
}
currentComparator, err := plan.resolveComparator(ctx, currentTarget)
if err != nil {
return worktreeRevalidationObservation{facts: facts, err: err}
}
if currentComparator != *plan.comparator {
facts.Comparator = worktreeremove.InvariantChanged
return worktreeRevalidationObservation{facts: facts, err: fmt.Errorf(
"comparison target changed (was %s, now %s)",
plan.comparator.oid,
currentComparator.oid,
)}
}
facts.Comparator = worktreeremove.InvariantStable
_, err = verifyWorktreeContainment(
ctx,
plan.git,
plan.executionRoot,
currentTarget.headOID,
currentComparator,
)
if err != nil {
facts.Containment = worktreeremove.InvariantChanged
return worktreeRevalidationObservation{facts: facts, err: err}
}
facts.Containment = worktreeremove.InvariantStable
return worktreeRevalidationObservation{facts: facts}
}
func samePinnedFileMetadata(current, pinned os.FileInfo) bool {
return os.SameFile(current, pinned) &&
current.Mode() == pinned.Mode() &&
current.Size() == pinned.Size() &&
current.ModTime().Equal(pinned.ModTime())
}
type worktreeRemovalFailureObservation struct {
facts worktreeremove.FailureFacts
reinspectionErr error
state string
}
func (plan *worktreeRemovalPlan) observeRemovalFailure(ctx context.Context) worktreeRemovalFailureObservation {
reinspection := plan.observeRevalidation(ctx)
worktrees, listErr := listRegisteredWorktrees(ctx, plan.git, plan.executionRoot)
registered := false
registration := worktreeremove.PresenceUnknown
if listErr == nil {
_, registered = findRegisteredWorktreeByPath(worktrees, plan.target.path)
if registered {
registration = worktreeremove.Present
} else {
registration = worktreeremove.Missing
}
}
_, pathErr := os.Lstat(plan.target.path)
pathExists := pathErr == nil
pathPresence := worktreeremove.PresenceUnknown
if pathErr == nil {
pathPresence = worktreeremove.Present
} else if os.IsNotExist(pathErr) {
pathPresence = worktreeremove.Missing
}
if pathErr != nil && !os.IsNotExist(pathErr) {
pathExists = true
}
state := fmt.Sprintf("registered=%t, path_exists=%t", registered, pathExists)
if listErr != nil {
state += fmt.Sprintf(", registry inspection failed: %v", listErr)
}
if pathErr != nil && !os.IsNotExist(pathErr) {
state += fmt.Sprintf(", path inspection failed: %v", pathErr)
}
return worktreeRemovalFailureObservation{
facts: worktreeremove.FailureFacts{
Revalidation: reinspection.facts,
RevalidationResult: revalidationResult(reinspection.err),
Registration: registration,
TargetPath: pathPresence,
},
reinspectionErr: reinspection.err,
state: state,
}
}
func revalidationResult(err error) worktreeremove.RevalidationResult {
if err != nil {
return worktreeremove.RevalidationFailed
}
return worktreeremove.RevalidationPassed
}
func formatWorktreeRemovalFailure(
kind worktreeremove.FailureKind,
observation worktreeRemovalFailureObservation,
removeErr error,
output []byte,
) error {
diagnostic := strings.TrimSpace(string(output))
if kind == worktreeremove.UnchangedFailure {
if diagnostic == "" {
return fmt.Errorf(
"git worktree remove failed, but the target was revalidated unchanged: %w",
removeErr,
)
}
return fmt.Errorf(
"git worktree remove failed, but the target was revalidated unchanged: %w\n%s",
removeErr,
diagnostic,
)
}
if diagnostic == "" {
return fmt.Errorf(
"git worktree remove failed and target state is partial or indeterminate (%s): %w; reinspection: %v",
observation.state,
removeErr,
observation.reinspectionErr,
)
}
return fmt.Errorf(
"git worktree remove failed and target state is partial or indeterminate (%s): %w; reinspection: %v\n%s",
observation.state,
removeErr,
observation.reinspectionErr,
diagnostic,
)
}
func (plan *worktreeRemovalPlan) resolveComparator(
ctx context.Context,
target pinnedWorktreeTarget,
) (pinnedWorktreeComparator, error) {
if plan.comparator.explicit {
return resolveExplicitWorktreeComparator(
ctx,
plan.git,
plan.executionRoot,
target,
plan.comparator.selector,
)
}
return resolveUpstreamWorktreeComparator(ctx, plan.git, plan.executionRoot, target)
}
func isWorktreeLocalPseudoref(selector string) bool {
switch selector {
case "HEAD",
"AUTO_MERGE",
"BISECT_EXPECTED_REV",
"MERGE_AUTOSTASH",
"NOTES_MERGE_PARTIAL",
"NOTES_MERGE_REF":
return true
}
if !strings.HasSuffix(selector, "_HEAD") {
return false
}
prefix := strings.TrimSuffix(selector, "_HEAD")
if prefix == "" {
return false
}
for _, character := range prefix {
if character >= 'A' && character <= 'Z' ||
character >= '0' && character <= '9' ||
character == '_' {
continue
}
return false
}
return true
}
func isWorktreeLocalRef(ref string) bool {
for _, namespace := range []string{
"refs/bisect",
"refs/rewritten",
"refs/worktree",
} {
if ref == namespace || strings.HasPrefix(ref, namespace+"/") {
return true
}
}
return false
}
func resolveExplicitWorktreeComparator(
ctx context.Context,
git *worktreeRemovalGit,
executionRoot string,
target pinnedWorktreeTarget,
selector string,
) (pinnedWorktreeComparator, error) {
if isWorktreeLocalPseudoref(selector) {
return pinnedWorktreeComparator{}, fmt.Errorf(
"--merged-into value %q is a worktree-local pseudoref; use a full shared ref or full commit object ID",
selector,
)
}
if strings.HasPrefix(selector, "refs/") {
if isWorktreeLocalRef(selector) {
return pinnedWorktreeComparator{}, fmt.Errorf(
"--merged-into value %q is in a worktree-local ref namespace; use a shared ref or full commit object ID",
selector,
)
}
valid, err := gitRefNameIsValid(ctx, git, executionRoot, selector, false)
if err != nil {
return pinnedWorktreeComparator{}, err
}
if !valid {
return pinnedWorktreeComparator{}, fmt.Errorf("--merged-into value %q is not a valid full ref", selector)
}
return pinWorktreeComparatorRef(ctx, git, executionRoot, target, selector, selector, true)
}
validShortName, err := gitRefNameIsValid(ctx, git, executionRoot, selector, true)
if err != nil {
return pinnedWorktreeComparator{}, err
}
if !validShortName {
return pinnedWorktreeComparator{}, fmt.Errorf(
"--merged-into value %q is not an accepted ref name or full commit object ID",
selector,
)
}
matches, err := findWorktreeComparatorRefs(ctx, git, executionRoot, selector)
if err != nil {
return pinnedWorktreeComparator{}, err
}
hashLength, err := repositoryObjectIDLength(ctx, git, executionRoot)
if err != nil {
return pinnedWorktreeComparator{}, err
}
fullOID := isHexObjectID(selector, hashLength)
if len(matches) > 1 || fullOID && len(matches) > 0 {
return pinnedWorktreeComparator{}, fmt.Errorf(
"--merged-into value %q is ambiguous; use a full ref name or a non-ref full object ID (matches: %s)",
selector,
strings.Join(matches, ", "),
)
}
if len(matches) == 1 {
return pinWorktreeComparatorRef(ctx, git, executionRoot, target, selector, matches[0], true)
}
if !fullOID {
return pinnedWorktreeComparator{}, fmt.Errorf(
"--merged-into value %q does not name an existing unambiguous ref",
selector,
)
}
oid, err := resolveWorktreeCommitOID(ctx, git, executionRoot, selector)
if err != nil {
return pinnedWorktreeComparator{}, fmt.Errorf(
"--merged-into object ID %q does not resolve to a commit: %w",
selector,
err,
)
}
if oid == target.headOID {
return pinnedWorktreeComparator{}, fmt.Errorf(
"--merged-into object ID %q is the target HEAD itself; use a ref or descendant commit that independently proves containment",
selector,
)
}
return pinnedWorktreeComparator{
selector: selector,
explicit: true,
oid: oid,
}, nil
}
func gitRefNameIsValid(
ctx context.Context,
git *worktreeRemovalGit,
executionRoot string,
ref string,
allowOneLevel bool,
) (bool, error) {
args := []string{"check-ref-format"}
if allowOneLevel {
args = append(args, "--allow-onelevel")
}
args = append(args, ref)
_, err := git.output(ctx, executionRoot, args...)
if err == nil {
return true, nil
}
var exitError *exec.ExitError
if errors.As(err, &exitError) && exitError.ExitCode() == 1 {
return false, nil
}
return false, fmt.Errorf("failed to validate git ref name %q: %w", ref, err)
}
func findWorktreeComparatorRefs(
ctx context.Context,
git *worktreeRemovalGit,
executionRoot string,
selector string,
) ([]string, error) {
candidates := []string{
"refs/" + selector,
"refs/tags/" + selector,
"refs/heads/" + selector,
"refs/remotes/" + selector,
"refs/remotes/" + selector + "/HEAD",
}
candidateSet := make(map[string]struct{}, len(candidates))
for _, candidate := range candidates {
candidateSet[candidate] = struct{}{}
}
args := []string{"for-each-ref", "--format=%(refname)", "--"}
args = append(args, candidates...)
output, err := git.output(ctx, executionRoot, args...)
if err != nil {
return nil, fmt.Errorf("failed to enumerate --merged-into ref %q: %w", selector, err)
}
matchSet := make(map[string]struct{})
for _, line := range strings.Split(strings.TrimSpace(string(output)), "\n") {
ref := strings.TrimSpace(line)
if _, candidate := candidateSet[ref]; candidate {
matchSet[ref] = struct{}{}
}
}
matches := make([]string, 0, len(matchSet))
for ref := range matchSet {
matches = append(matches, ref)
}
sort.Strings(matches)
return matches, nil
}
func repositoryObjectIDLength(
ctx context.Context,
git *worktreeRemovalGit,
executionRoot string,
) (int, error) {
output, err := git.output(ctx, executionRoot, "rev-parse", "--show-object-format")
if err != nil {
return 0, fmt.Errorf("failed to determine repository object format: %w", err)
}
switch strings.TrimSpace(string(output)) {
case "sha1":
return 40, nil
case "sha256":
return 64, nil
default:
return 0, fmt.Errorf("unsupported git object format %q", strings.TrimSpace(string(output)))
}
}
func isHexObjectID(value string, length int) bool {
if len(value) != length {
return false
}
for _, character := range value {
if character >= '0' && character <= '9' ||
character >= 'a' && character <= 'f' ||
character >= 'A' && character <= 'F' {
continue
}
return false
}
return true
}
func pinWorktreeComparatorRef(
ctx context.Context,
git *worktreeRemovalGit,
executionRoot string,
target pinnedWorktreeTarget,
selector string,
ref string,
explicit bool,
) (pinnedWorktreeComparator, error) {
terminalRef, err := resolveWorktreeTerminalRef(ctx, git, executionRoot, ref)
if err != nil {
return pinnedWorktreeComparator{}, err
}
if isWorktreeLocalRef(ref) || isWorktreeLocalRef(terminalRef) {
return pinnedWorktreeComparator{}, fmt.Errorf(
"comparison ref %q resolves through a worktree-local ref namespace and cannot independently prove containment",
ref,
)
}
if ref == target.branch || terminalRef == target.branch {
return pinnedWorktreeComparator{}, fmt.Errorf(
"comparison ref %q resolves to the target worktree branch and cannot independently prove containment",
ref,
)
}
oid, err := resolveWorktreeCommitOID(ctx, git, executionRoot, ref)
if err != nil {
return pinnedWorktreeComparator{}, fmt.Errorf("comparison ref %q does not resolve to a commit: %w", ref, err)
}
return pinnedWorktreeComparator{
selector: selector,
explicit: explicit,
ref: ref,
terminalRef: terminalRef,
oid: oid,
}, nil
}
func resolveWorktreeTerminalRef(
ctx context.Context,
git *worktreeRemovalGit,
executionRoot string,
ref string,
) (string, error) {
current := ref
seen := make(map[string]struct{})
for range 16 {
if _, duplicate := seen[current]; duplicate {
return "", fmt.Errorf("symbolic ref cycle while resolving %q", ref)
}
seen[current] = struct{}{}
output, err := git.output(ctx, executionRoot, "symbolic-ref", "--quiet", current)
if err == nil {
next := strings.TrimSpace(string(output))
if !strings.HasPrefix(next, "refs/") {
return "", fmt.Errorf("symbolic ref %q resolves outside refs/: %q", current, next)
}
current = next
continue
}
var exitError *exec.ExitError
if errors.As(err, &exitError) && exitError.ExitCode() == 1 {
return current, nil
}
return "", fmt.Errorf("failed to inspect symbolic ref %q: %w", current, err)
}
return "", fmt.Errorf("symbolic ref chain for %q exceeds 16 links", ref)
}
func resolveWorktreeCommitOID(
ctx context.Context,
git *worktreeRemovalGit,
executionRoot string,
refOrOID string,
) (string, error) {
output, err := git.output(
ctx,
executionRoot,
"rev-parse",
"--verify",
"--quiet",
"--end-of-options",
refOrOID+"^{commit}",
)
if err != nil {
return "", err
}
oid := strings.TrimSpace(string(output))
hashLength, err := repositoryObjectIDLength(ctx, git, executionRoot)
if err != nil {
return "", err
}
if !isHexObjectID(oid, hashLength) {
return "", fmt.Errorf("git returned invalid commit object ID %q", oid)
}
return strings.ToLower(oid), nil
}
func resolveUpstreamWorktreeComparator(
ctx context.Context,
git *worktreeRemovalGit,
executionRoot string,
target pinnedWorktreeTarget,
) (pinnedWorktreeComparator, error) {
if target.branch == "" || target.detached {
return pinnedWorktreeComparator{}, fmt.Errorf(
"cannot verify unpushed commits: target is detached; use --merged-into <ref>",
)
}
output, err := git.output(
ctx,
executionRoot,
"for-each-ref",
"--format=%(upstream)",
"--",
target.branch,
)
if err != nil {
return pinnedWorktreeComparator{}, fmt.Errorf("failed to inspect configured upstream: %w", err)
}
upstreamRef := strings.TrimSpace(string(output))
if upstreamRef == "" || strings.Contains(upstreamRef, "\n") {
return pinnedWorktreeComparator{}, fmt.Errorf(
"cannot verify unpushed commits: the target branch has no single resolvable upstream; configure an upstream or use --merged-into <ref>",
)
}
return pinWorktreeComparatorRef(
ctx,
git,
executionRoot,
target,
upstreamRef,
upstreamRef,
false,
)
}
func verifyWorktreeContainment(
ctx context.Context,
git *worktreeRemovalGit,
executionRoot string,
headOID string,
comparator pinnedWorktreeComparator,
) (worktreeremove.Containment, error) {
output, err := git.output(
ctx,
executionRoot,
"merge-base",
"--is-ancestor",
headOID,
comparator.oid,
)
if err == nil {
return worktreeremove.Contained, nil
}
var exitError *exec.ExitError
if errors.As(err, &exitError) && exitError.ExitCode() == 1 {
if comparator.explicit {
return worktreeremove.NotContained, fmt.Errorf(
"worktree HEAD %s is not contained in --merged-into value %q at %s",
headOID,
comparator.selector,
comparator.oid,
)
}
return worktreeremove.NotContained, fmt.Errorf("worktree has commits not contained in its configured upstream")
}
return worktreeremove.ContainmentUnknown, fmt.Errorf(
"failed to verify worktree containment (%s in %s): %w\n%s",
headOID,
comparator.oid,
err,
strings.TrimSpace(string(output)),
)
}
func getWorktreeCurrentBranch(ctx context.Context, dir string) string {
gitCmd := gitCmdInDir(ctx, dir, "branch", "--show-current")
output, err := gitCmd.CombinedOutput()
if err != nil {
return "(unknown)"
}
return strings.TrimSpace(string(output))
}
func addToGitignore(ctx context.Context, repoRoot, entry string) error {
entry = strings.TrimSuffix(filepath.ToSlash(entry), "/")
if entry == "" {
return fmt.Errorf("gitignore entry must not be empty")
}
gitignorePath := filepath.Join(repoRoot, ".gitignore")
// If git already ignores this path (e.g., via a parent pattern like
// ".worktrees/"), avoid appending one line per worktree.
ignored, err := isIgnoredByGit(ctx, repoRoot, entry)
if err == nil && ignored {
return nil
}
// Read existing content
content, err := os.ReadFile(gitignorePath) //nolint:gosec // G304: gitignorePath from known repoRoot
if err != nil && !os.IsNotExist(err) {
return err
}
// Check if already present or covered by a parent-directory pattern.
// e.g. if ".worktrees" is in .gitignore, ".worktrees/my-branch" is already covered.
lines := strings.Split(string(content), "\n")
for _, line := range lines {
line = strings.TrimSuffix(line, "\r")
trimmed := strings.TrimSuffix(filepath.ToSlash(line), "/")
if trimmed == "" || strings.HasPrefix(trimmed, "#") {
continue
}
if trimmed == entry || strings.HasPrefix(entry+"/", trimmed+"/") {
return nil // Already present or covered by a parent pattern
}
}
// Append entry
f, err := os.OpenFile(gitignorePath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644) //nolint:gosec // G302: .gitignore should be world-readable
if err != nil {
return err
}
defer f.Close()
// AppendLines owns the line-ending and final-line completion policy and
// leaves existing bytes unchanged, so everything past len(content) is the
// append. Writing only that suffix keeps this an O_APPEND write rather than
// a rewrite of the user's file.
appended := gitignore.AppendLines(content, []string{"# bd worktree", entry + "/"})
if _, err := f.Write(appended[len(content):]); err != nil {
return err
}
return nil
}
func isIgnoredByGit(ctx context.Context, repoRoot, entry string) (bool, error) {
normalized := strings.TrimSuffix(filepath.ToSlash(entry), "/")
if normalized == "" {
return false, nil
}
gitCmd := gitCmdInDir(ctx, repoRoot, "check-ignore", "-q", "--no-index", "--", normalized)
err := gitCmd.Run()
if err == nil {
return true, nil
}
var exitErr *exec.ExitError
if errors.As(err, &exitErr) && exitErr.ExitCode() == 1 {
return false, nil
}
return false, err
}
type gitignoreCleanupPlan struct {
repoRoot string
path string
entry string
info os.FileInfo
original []byte
updated []byte
}
type gitignoreLine struct {
raw []byte
body string
}
func prepareGitignoreCleanup(repoRoot, entry string) (*gitignoreCleanupPlan, error) {
entry = strings.TrimSuffix(filepath.ToSlash(entry), "/")
if entry == "" {
return nil, fmt.Errorf("gitignore entry must not be empty")
}
gitignorePath := filepath.Join(repoRoot, ".gitignore")
if _, err := os.Lstat(gitignorePath); err != nil {
if os.IsNotExist(err) {
return nil, nil
}
return nil, err
}
info, content, err := readStableRegularFile(gitignorePath)
if err != nil {
return nil, err
}
updated, changed := removeManagedGitignoreEntry(content, entry)
if !changed {
return nil, nil
}
return &gitignoreCleanupPlan{
repoRoot: repoRoot,
path: gitignorePath,
entry: entry,
info: info,
original: content,
updated: updated,
}, nil
}
func readStableRegularFile(path string) (os.FileInfo, []byte, error) {
before, err := os.Lstat(path)
if err != nil {
return nil, nil, err
}
if before.Mode()&os.ModeSymlink != 0 || !before.Mode().IsRegular() {
return nil, nil, fmt.Errorf("%s is not a regular file", path)
}
file, err := os.Open(path) //nolint:gosec // path is the pinned primary worktree .gitignore
if err != nil {
return nil, nil, err
}
openedBefore, err := file.Stat()
if err != nil {
_ = file.Close()
return nil, nil, err
}
if !openedBefore.Mode().IsRegular() || !samePinnedFileMetadata(openedBefore, before) {
_ = file.Close()
return nil, nil, fmt.Errorf("%s changed while it was being opened", path)
}
content, readErr := io.ReadAll(file)
openedAfter, statErr := file.Stat()
closeErr := file.Close()
if readErr != nil {
return nil, nil, readErr
}
if statErr != nil {
return nil, nil, statErr
}
if closeErr != nil {
return nil, nil, closeErr
}
after, err := os.Lstat(path)
if err != nil {
return nil, nil, err
}
if after.Mode()&os.ModeSymlink != 0 ||
!after.Mode().IsRegular() ||
!samePinnedFileMetadata(openedAfter, openedBefore) ||
!samePinnedFileMetadata(after, openedAfter) {
return nil, nil, fmt.Errorf("%s changed while it was being read", path)
}
return after, content, nil
}
func removeManagedGitignoreEntry(content []byte, entry string) ([]byte, bool) {
lines := splitGitignoreLines(content)
updated := make([]byte, 0, len(content))
changed := false
for index := 0; index < len(lines); {
if lines[index].body == "# bd worktree" &&
index+1 < len(lines) &&
gitignoreLineMatchesEntry(lines[index+1].body, entry) {
changed = true
index += 2
continue
}
updated = append(updated, lines[index].raw...)
index++
}
return updated, changed
}
func splitGitignoreLines(content []byte) []gitignoreLine {
lines := make([]gitignoreLine, 0, bytes.Count(content, []byte{'\n'})+1)
for start := 0; start < len(content); {
end := len(content)
if newline := bytes.IndexByte(content[start:], '\n'); newline >= 0 {
end = start + newline + 1
}
bodyEnd := end
if bodyEnd > start && content[bodyEnd-1] == '\n' {
bodyEnd--
}
if bodyEnd > start && content[bodyEnd-1] == '\r' {
bodyEnd--
}
lines = append(lines, gitignoreLine{
raw: content[start:end],
body: string(content[start:bodyEnd]),
})
start = end
}
return lines
}
func gitignoreLineMatchesEntry(line, entry string) bool {
normalized := strings.TrimSuffix(
filepath.ToSlash(line),
"/",
)
return normalized == entry
}
func (plan *gitignoreCleanupPlan) apply() error {
if err := plan.validate(); err != nil {
return err
}
temp, err := os.CreateTemp(plan.repoRoot, ".gitignore.bd-*")
if err != nil {
return err
}
tempPath := temp.Name()
removeTemp := true
defer func() {
if removeTemp {
_ = os.Remove(tempPath)
}
}()
if err := temp.Chmod(plan.info.Mode().Perm()); err != nil {
_ = temp.Close()
return err
}
if _, err := temp.Write(plan.updated); err != nil {
_ = temp.Close()
return err
}
if err := temp.Sync(); err != nil {
_ = temp.Close()
return err
}
if err := temp.Close(); err != nil {
return err
}
if err := plan.validate(); err != nil {
return fmt.Errorf("destination changed before atomic cleanup: %w", err)
}
if err := os.Rename(tempPath, plan.path); err != nil {
return fmt.Errorf("atomically replace %s: %w", plan.path, err)
}
removeTemp = false
return nil
}
func (plan *gitignoreCleanupPlan) validate() error {
currentInfo, currentContent, err := readStableRegularFile(plan.path)
if err != nil {
return err
}
if !samePinnedFileMetadata(currentInfo, plan.info) ||
!bytes.Equal(currentContent, plan.original) {
return fmt.Errorf("%s changed after removal was prepared", plan.path)
}
return nil
}
func truncate(s string, maxLen int) string {
// Byte budget (len counts bytes), but never split a UTF-8 code point.
// Compact prime memories and other display paths call this; a mid-rune
// cut emits invalid UTF-8 and breaks SessionStart hosts that decode strictly.
if maxLen <= 0 {
return ""
}
if len(s) <= maxLen {
return s
}
if maxLen <= 3 {
cut := maxLen
for cut > 0 && !utf8.ValidString(s[:cut]) {
cut--
}
return s[:cut]
}
cut := maxLen - 3
for cut > 0 && !utf8.ValidString(s[:cut]) {
cut--
}
return s[:cut] + "..."
}