feat: warn about legacy worktree layout

Author: satococoa

cmd/wtp/cd.go

@@ -62,8 +62,10 @@ func cdToWorktree(_ context.Context, cmd *cli.Command) error {
 		return errors.NotInGitRepository()
 	}
 
+	rootCmd := cmd.Root()
+
 	// Get the writer from cli.Command
-	w := cmd.Root().Writer
+	w := rootCmd.Writer
 	if w == nil {
 		w = os.Stdout
 	}
@@ -74,7 +76,7 @@ func cdToWorktree(_ context.Context, cmd *cli.Command) error {
 }
 
 func cdCommandWithCommandExecutor(
-	_ *cli.Command,
+	cmd *cli.Command,
 	w io.Writer,
 	executor command.Executor,
 	_ string,
@@ -93,6 +95,25 @@ func cdCommandWithCommandExecutor(
 	// Find the main worktree path
 	mainWorktreePath := findMainWorktreePath(worktrees)
 
+	errWriter := io.Discard
+	if cmd != nil {
+		if root := cmd.Root(); root != nil && root.ErrWriter != nil {
+			errWriter = root.ErrWriter
+		} else if root != nil && root.ErrWriter == nil {
+			errWriter = os.Stderr
+		}
+	}
+
+	if mainWorktreePath != "" {
+		cfgForWarning, cfgErr := config.LoadConfig(mainWorktreePath)
+		if cfgErr != nil {
+			cfgForWarning = &config.Config{
+				Defaults: config.Defaults{BaseDir: config.DefaultBaseDir},
+			}
+		}
+		maybeWarnLegacyWorktreeLayout(errWriter, mainWorktreePath, cfgForWarning, worktrees)
+	}
+
 	// Find the worktree using multiple resolution strategies
 	targetPath := resolveCdWorktreePath(worktreeName, worktrees, mainWorktreePath)
 

cmd/wtp/legacy_warning.go

@@ -0,0 +1,141 @@
+package main
+
+import (
+	"fmt"
+	"io"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/satococoa/wtp/internal/config"
+	"github.com/satococoa/wtp/internal/git"
+)
+
+const legacyWarningExampleLimit = 3
+
+type legacyWorktreeMigration struct {
+	currentRel   string
+	suggestedRel string
+}
+
+func maybeWarnLegacyWorktreeLayout(
+	w io.Writer,
+	mainRepoPath string,
+	cfg *config.Config,
+	worktrees []git.Worktree,
+) {
+	if w == nil {
+		w = os.Stderr
+	}
+
+	if cfg == nil || mainRepoPath == "" || len(worktrees) == 0 {
+		return
+	}
+
+	if hasConfigFile(mainRepoPath) {
+		return
+	}
+
+	migrations := detectLegacyWorktreeMigrations(mainRepoPath, cfg, worktrees)
+	if len(migrations) == 0 {
+		return
+	}
+
+	repoBase := filepath.Base(mainRepoPath)
+	fmt.Fprintln(w, "⚠️  Legacy worktree layout detected.")
+	fmt.Fprintf(w, "    wtp now expects worktrees under '../worktrees/%s/...'\n", repoBase)
+	fmt.Fprintln(w, "    Move existing worktrees to the new layout (run from the repository root):")
+
+	limit := len(migrations)
+	if limit > legacyWarningExampleLimit {
+		limit = legacyWarningExampleLimit
+	}
+	for i := 0; i < limit; i++ {
+		migration := migrations[i]
+		fmt.Fprintf(w, "      git worktree move %s %s\n", migration.currentRel, migration.suggestedRel)
+	}
+
+	if len(migrations) > legacyWarningExampleLimit {
+		fmt.Fprintf(w, "      ... and %d more\n", len(migrations)-legacyWarningExampleLimit)
+	}
+
+	fmt.Fprintln(w, "    (Alternatively, run 'wtp init' and set defaults.base_dir to keep a custom layout.)")
+	fmt.Fprintln(w)
+}
+
+func detectLegacyWorktreeMigrations(
+	mainRepoPath string,
+	cfg *config.Config,
+	worktrees []git.Worktree,
+) []legacyWorktreeMigration {
+	if cfg == nil || mainRepoPath == "" {
+		return nil
+	}
+
+	mainRepoPath = filepath.Clean(mainRepoPath)
+
+	newBaseDir := filepath.Clean(cfg.ResolveWorktreePath(mainRepoPath, ""))
+	legacyBaseDir := filepath.Clean(filepath.Join(filepath.Dir(mainRepoPath), "worktrees"))
+	repoBase := filepath.Base(mainRepoPath)
+
+	if legacyBaseDir == newBaseDir {
+		return nil
+	}
+
+	var migrations []legacyWorktreeMigration
+	for _, wt := range worktrees {
+		if wt.IsMain {
+			continue
+		}
+
+		worktreePath := filepath.Clean(wt.Path)
+
+		if strings.HasPrefix(worktreePath, newBaseDir+string(os.PathSeparator)) ||
+			worktreePath == newBaseDir {
+			continue
+		}
+
+		if !strings.HasPrefix(worktreePath, legacyBaseDir+string(os.PathSeparator)) {
+			continue
+		}
+
+		legacyRel, err := filepath.Rel(legacyBaseDir, worktreePath)
+		if err != nil || legacyRel == "." {
+			continue
+		}
+
+		if strings.HasPrefix(legacyRel, repoBase+string(os.PathSeparator)) {
+			// Already under the new structure (worktrees/<repo>/...)
+			continue
+		}
+
+		suggestedPath := filepath.Join(legacyBaseDir, repoBase, legacyRel)
+
+		currentRel := relativeToRepo(mainRepoPath, worktreePath)
+		suggestedRel := relativeToRepo(mainRepoPath, suggestedPath)
+
+		migrations = append(migrations, legacyWorktreeMigration{
+			currentRel:   currentRel,
+			suggestedRel: suggestedRel,
+		})
+	}
+
+	return migrations
+}
+
+func relativeToRepo(mainRepoPath, targetPath string) string {
+	rel, err := filepath.Rel(mainRepoPath, targetPath)
+	if err != nil {
+		return targetPath
+	}
+	if !strings.HasPrefix(rel, "..") {
+		rel = filepath.Join(".", rel)
+	}
+	return filepath.Clean(rel)
+}
+
+func hasConfigFile(mainRepoPath string) bool {
+	configPath := filepath.Join(mainRepoPath, config.ConfigFileName)
+	_, err := os.Stat(configPath)
+	return err == nil
+}

cmd/wtp/legacy_warning_test.go

@@ -0,0 +1,108 @@
+package main
+
+import (
+	"bytes"
+	"os"
+	"path/filepath"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	"github.com/satococoa/wtp/internal/config"
+	"github.com/satococoa/wtp/internal/git"
+)
+
+func TestDetectLegacyWorktreeMigrations(t *testing.T) {
+	tempDir := t.TempDir()
+	mainRepoPath := filepath.Join(tempDir, "repo")
+	requireNoErr(t, os.MkdirAll(mainRepoPath, 0o755))
+
+	cfg := &config.Config{
+		Defaults: config.Defaults{BaseDir: config.DefaultBaseDir},
+	}
+
+	legacyWorktreePath := filepath.Join(filepath.Dir(mainRepoPath), "worktrees", "feature", "foo")
+	modernWorktreePath := filepath.Join(
+		filepath.Dir(mainRepoPath),
+		"worktrees",
+		filepath.Base(mainRepoPath),
+		"feature",
+		"bar",
+	)
+
+	worktrees := []git.Worktree{
+		{Path: mainRepoPath, IsMain: true},
+		{Path: legacyWorktreePath},
+		{Path: modernWorktreePath},
+	}
+
+	migrations := detectLegacyWorktreeMigrations(mainRepoPath, cfg, worktrees)
+
+	assert.Len(t, migrations, 1)
+	expectedCurrent := filepath.Join("..", "worktrees", "feature", "foo")
+	expectedSuggested := filepath.Join("..", "worktrees", filepath.Base(mainRepoPath), "feature", "foo")
+
+	assert.Equal(t, filepath.Clean(expectedCurrent), migrations[0].currentRel)
+	assert.Equal(t, filepath.Clean(expectedSuggested), migrations[0].suggestedRel)
+}
+
+func TestMaybeWarnLegacyWorktreeLayout_EmitsWarningWithoutConfig(t *testing.T) {
+	tempDir := t.TempDir()
+	mainRepoPath := filepath.Join(tempDir, "repo")
+	requireNoErr(t, os.MkdirAll(mainRepoPath, 0o755))
+
+	cfg := &config.Config{
+		Defaults: config.Defaults{BaseDir: config.DefaultBaseDir},
+	}
+
+	legacyWorktree := filepath.Join(filepath.Dir(mainRepoPath), "worktrees", "feature", "foo")
+	worktrees := []git.Worktree{
+		{Path: mainRepoPath, IsMain: true},
+		{Path: legacyWorktree},
+	}
+
+	var buf bytes.Buffer
+	maybeWarnLegacyWorktreeLayout(&buf, mainRepoPath, cfg, worktrees)
+
+	output := buf.String()
+	assert.NotEmpty(t, output)
+	assert.Contains(t, output, "Legacy worktree layout detected")
+
+	moveCommand := strings.Join([]string{
+		"git worktree move",
+		filepath.Join("..", "worktrees", "feature", "foo"),
+		filepath.Join("..", "worktrees", filepath.Base(mainRepoPath), "feature", "foo"),
+	}, " ")
+	assert.Contains(t, output, moveCommand)
+}
+
+func TestMaybeWarnLegacyWorktreeLayout_SuppressedWhenConfigPresent(t *testing.T) {
+	tempDir := t.TempDir()
+	mainRepoPath := filepath.Join(tempDir, "repo")
+	requireNoErr(t, os.MkdirAll(mainRepoPath, 0o755))
+
+	configPath := filepath.Join(mainRepoPath, config.ConfigFileName)
+	requireNoErr(t, os.WriteFile(configPath, []byte("version: 1.0\n"), 0o600))
+
+	cfg := &config.Config{
+		Defaults: config.Defaults{BaseDir: config.DefaultBaseDir},
+	}
+
+	worktrees := []git.Worktree{
+		{Path: mainRepoPath, IsMain: true},
+		{Path: filepath.Join(filepath.Dir(mainRepoPath), "worktrees", "feature", "foo")},
+	}
+
+	var buf bytes.Buffer
+	maybeWarnLegacyWorktreeLayout(&buf, mainRepoPath, cfg, worktrees)
+
+	assert.Empty(t, buf.String())
+}
+
+func requireNoErr(t *testing.T, err error) {
+	t.Helper()
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
+	}
+}

cmd/wtp/list.go

@@ -103,8 +103,10 @@ func listCommand(_ context.Context, cmd *cli.Command) error {
 		return errors.GitCommandFailed("get main worktree path", err.Error())
 	}
 
+	rootCmd := cmd.Root()
+
 	// Get the writer from cli.Command
-	w := cmd.Root().Writer
+	w := rootCmd.Writer
 	if w == nil {
 		w = os.Stdout
 	}
@@ -124,7 +126,7 @@ func listCommand(_ context.Context, cmd *cli.Command) error {
 }
 
 func listCommandWithCommandExecutor(
-	_ *cli.Command, w io.Writer, executor command.Executor, cfg *config.Config, mainRepoPath string, quiet bool,
+	cmd *cli.Command, w io.Writer, executor command.Executor, cfg *config.Config, mainRepoPath string, quiet bool,
 	opts listDisplayOptions,
 ) error {
 	// Get current working directory
@@ -150,6 +152,16 @@ func listCommandWithCommandExecutor(
 		return nil
 	}
 
+	errWriter := io.Discard
+	if cmd != nil {
+		if root := cmd.Root(); root != nil && root.ErrWriter != nil {
+			errWriter = root.ErrWriter
+		} else if root != nil && root.ErrWriter == nil {
+			errWriter = os.Stderr
+		}
+	}
+	maybeWarnLegacyWorktreeLayout(errWriter, mainRepoPath, cfg, worktrees)
+
 	// Display worktrees
 	if quiet {
 		displayWorktreesQuiet(w, worktrees, cfg, mainRepoPath)