Completed MVP. Needs testing.

- Renamed list package to ls.
- Added rm command.
- Added mv command.
- Refactored command exit handling.
- Updated README.

Author: jason-dour

README.md

@@ -2,6 +2,11 @@
 
 Git Extension For Worktree Management
 
+## Caveat Emptor
+
+This is very new code. It has not had extensive testing. Use in full knowledge
+there may be bugs.
+
 ## Purpose
 
 This helper is intended to assist in managing git worktrees in a workflow based
@@ -26,6 +31,10 @@ Commands are:
     - List the worktrees in the project.
 - `mk`
     - Add a worktree to the project.
+- `mv`
+    - Move a worktree within the project.
+- `rm`
+    - Remove a worktree from the project.
 
 ## Project Layout
 
@@ -47,15 +56,16 @@ graph TD
 ## Git Worktree Coverage
 
 The goal is to cover the `git worktree` commands essential to a worktree-based
-workflow. Not every command is likely to be implemented.
-
-| Git Worktree Command | git-wt Command | Notes                   |
-| -------------------- | -------------- | ----------------------- |
-| list                 | ls             | No arguments supported. |
-| add                  | mk             | Not implemented yet.    |
-| remove               | rm             | Not implemented yet.    |
-| move                 | mv             | Not implemented yet.    |
-| prune                | tbd            | Under review.           |
-| lock                 | n/a            | No intent to implement. |
-| unlock               | n/a            | No intent to implement. |
-| repair               | n/a            | No intent to implement. |
+workflow. Not every command is likely to be implemented, or implemented with all
+possible flags.
+
+| Git Worktree Command | git-wt Command | Notes                                     |
+| -------------------- | -------------- | ----------------------------------------- |
+| list                 | ls             | No arguments supported.                   |
+| add                  | mk             | Does not implement locks or guess-remote. |
+| remove               | rm             | Full implementation.                      |
+| move                 | mv             | Full implementation.                      |
+| prune                | tbd            | Under review.                             |
+| lock                 | n/a            | No intent to implement.                   |
+| unlock               | n/a            | No intent to implement.                   |
+| repair               | n/a            | No intent to implement.                   |

internal/cmn/cmn.go

@@ -9,6 +9,25 @@ import (
 	"slices"
 )
 
+type (
+	CfgMk struct {
+		Branch      string
+		BranchReset string
+		CheckoutNo  bool
+		Force       bool
+		Track       bool
+		Quiet       bool
+	} // Configuration for 'mk' command.
+
+	CfgRm struct {
+		Force bool
+	} // Configuration for 'rm' command.
+
+	CfgMv struct {
+		Force bool
+	} // Configuration for 'mv' command.
+)
+
 var (
 	Basename string // Base name of the program; injected during compile.
 	Version  string // Version of the program; injected during compile.
@@ -95,7 +114,7 @@ func walkUpTree(path string) (string, error) {
 			continue
 		} else {
 			ProjectDir = target
-			Debug("%s: project dir: %s", funcName, ProjectDir)
+			Debug("%s: project dir: %s\n", funcName, ProjectDir)
 			Debug("%s: end\n", funcName)
 			return filename, nil
 		}

internal/cobra/cl/command.go

@@ -34,7 +34,7 @@ func run(cmd *cobra.Command, args []string) error {
 	cmn.Debug("%s: %s: retrieving default branch from remote\n", command, funcName)
 	defaultBranch, err := git.GetDefaultBranch(args[0])
 	if err != nil {
-		cmn.Exit(11, "could not retrieve default branch: %v", err.Error())
+		return fmt.Errorf("could not retrieve default branch: %v", err.Error())
 	}
 	cmn.Debug("%s: run: defaultBranch: %v\n", command, defaultBranch)
 
@@ -46,13 +46,13 @@ func run(cmd *cobra.Command, args []string) error {
 	// Clone the repository.
 	err = git.Clone(args[0], defaultBranch, clonePath)
 	if err != nil {
-		cmn.Exit(12, "could not clone repo: %v", err.Error())
+		return fmt.Errorf("could not clone repo: %v", err.Error())
 	}
 
 	// Write config file to project path.
 	err = cmn.WriteConfig(repo, defaultBranch)
 	if err != nil {
-		cmn.Exit(13, "error writing config file: %v", err.Error())
+		return fmt.Errorf("error writing config file: %v", err.Error())
 	}
 
 	fmt.Printf("Clone complete.\n")

internal/cobra/list/command.go internal/cobra/ls/command.go

@@ -1,5 +1,5 @@
 // Package list implements the list subcommand for git-wt.
-package list
+package ls
 
 import (
 	"fmt"
@@ -27,7 +27,7 @@ func run(cmd *cobra.Command, args []string) error {
 
 	output, err := git.WorktreeList()
 	if err != nil {
-		cmn.Exit(20, "error listing worktrees: %s", err.Error())
+		return fmt.Errorf("error listing worktrees: %s", err.Error())
 	}
 	fmt.Print(string(output))
 

internal/cobra/mk/command.go

@@ -2,27 +2,83 @@
 package mk
 
 import (
+	"fmt"
+
 	"github.com/jason-dour/git-wt/internal/cmn"
+	"github.com/jason-dour/git-wt/internal/git"
 	"github.com/spf13/cobra"
 )
 
 var (
-	command = "mk" // Command name.
-	Cmd     = &cobra.Command{
-		Use:     command + " repo_url",
+	command            = "mk"         // Command name.
+	config  *cmn.CfgMk = &cmn.CfgMk{} // Configuration for the command.
+	Cmd                = &cobra.Command{
+		Use:     command + " worktree_name commit-ish",
 		Short:   "Add a worktree to the project.",
 		Long:    cmn.Basename + " " + command + " - Add a worktree to the project.",
-		Args:    cobra.ExactArgs(1),
+		Args:    cobra.ExactArgs(2),
 		Aliases: []string{"make"},
 		RunE:    run,
-	} // Cobra command definition for the 'clone' command.
+	} // Cobra command definition for the 'mk' command.
 )
 
+// init performs initialization for the 'mk' command.
+func init() {
+	Cmd.PersistentFlags().BoolVar(&config.Track, "track", false, "set up tracking mode")
+	Cmd.PersistentFlags().StringVarP(&config.Branch, "b", "b", "", "create a new branch")
+	Cmd.PersistentFlags().StringVarP(&config.BranchReset, "B", "B", "", "create or reset a branch")
+	Cmd.PersistentFlags().BoolVar(&config.CheckoutNo, "no-checkout", false, "do not populate the new worktree")
+	Cmd.PersistentFlags().BoolVarP(&config.Force, "force", "f", false, "checkout <branch> even if already checked out in other worktree")
+	Cmd.PersistentFlags().BoolVarP(&config.Quiet, "quiet", "q", false, "suppress progress reporting")
+}
+
+// checkConfig scans config for proper use of flags.
+func checkConfig(args []string) error {
+	funcName := "checkConfig"
+	cmn.Debug("%s: %s: begin\n", command, funcName)
+
+	cmn.Debug("%s: %s: check mutually exclusive branch flags\n", command, funcName)
+	if len(config.Branch) > 0 && len(config.BranchReset) > 0 {
+		return fmt.Errorf("config: set branch with either -b or -B; don't use both")
+	}
+
+	cmn.Debug("%s: %s: check track has a new branch in flags\n", command, funcName)
+	if config.Track && !(len(config.Branch) > 0 || len(config.BranchReset) > 0) {
+		return fmt.Errorf("config: track requires new branch via -b or -B")
+	}
+
+	cmn.Debug("%s: %s: end\n", command, funcName)
+	return nil
+}
+
+// run provides the core execution of the 'mk' command.
 func run(cmd *cobra.Command, args []string) error {
 	funcName := "run"
 	cmn.Debug("%s: %s: begin\n", command, funcName)
+	cmn.Debug("%s: %s: config: %#v\n", command, funcName, config)
 	cmn.Debug("%s: %s: args: %v\n", command, funcName, args)
 
+	// Set the worktree name.
+	wtName := args[0]
+	cmn.Debug("%s: %s: worktree name: %s\n", command, funcName, wtName)
+
+	// Set the commit-ish to be used.
+	commitish := args[1]
+	cmn.Debug("%s: %s: commit-ish: %s\n", command, funcName, commitish)
+
+	// Check configuration.
+	err := checkConfig(args)
+	if err != nil {
+		return err
+	}
+
+	// Add the worktree.
+	output, err := git.WorktreeAdd(config, wtName, commitish)
+	if err != nil {
+		return err
+	}
+	fmt.Print(string(output))
+
 	cmn.Debug("%s: %s: end\n", command, funcName)
 	return nil
 }

internal/cobra/mv/command.go

@@ -0,0 +1,54 @@
+// Package mv implements the mv subcommand for git-wt.
+package mv
+
+import (
+	"fmt"
+
+	"github.com/jason-dour/git-wt/internal/cmn"
+	"github.com/jason-dour/git-wt/internal/git"
+	"github.com/spf13/cobra"
+)
+
+var (
+	command            = "mv"         // Command name.
+	config  *cmn.CfgMv = &cmn.CfgMv{} // Configuration for the command.
+	Cmd                = &cobra.Command{
+		Use:     command + " worktree-name new-worktree-name",
+		Short:   "Move a worktree within the project.",
+		Long:    cmn.Basename + " " + command + " - Move a worktree within the project.",
+		Args:    cobra.ExactArgs(2),
+		Aliases: []string{"move", "ren", "rename"},
+		RunE:    run,
+	} // Cobra command definition for the 'mv' command.
+)
+
+// init performs initialization for the 'mv' command.
+func init() {
+	Cmd.PersistentFlags().BoolVarP(&config.Force, "force", "f", false, "force move even if worktree is dirty or locked")
+}
+
+// run provides the core execution of the 'mv' command.
+func run(cmd *cobra.Command, args []string) error {
+	funcName := "run"
+	cmn.Debug("%s: %s: begin\n", command, funcName)
+	cmn.Debug("%s: %s: config: %#v\n", command, funcName, config)
+	cmn.Debug("%s: %s: args: %v\n", command, funcName, args)
+
+	// Set the worktree current name.
+	wtCurr := args[0]
+	cmn.Debug("%s: %s: worktree name: %s\n", command, funcName, wtCurr)
+
+	// Set the worktree current name.
+	wtNew := args[1]
+	cmn.Debug("%s: %s: new worktree name: %s\n", command, funcName, wtNew)
+
+	// Remove the worktree.
+	output, err := git.WorktreeMove(config, wtCurr, wtNew)
+	if err != nil {
+		return err
+	}
+	fmt.Print(string(output))
+
+	cmn.Debug("%s: %s: end\n", command, funcName)
+	return nil
+}

internal/cobra/rm/command.go

@@ -0,0 +1,50 @@
+// Package rm implements the rm subcommand for git-wt.
+package rm
+
+import (
+	"fmt"
+
+	"github.com/jason-dour/git-wt/internal/cmn"
+	"github.com/jason-dour/git-wt/internal/git"
+	"github.com/spf13/cobra"
+)
+
+var (
+	command            = "rm"         // Command name.
+	config  *cmn.CfgRm = &cmn.CfgRm{} // Configuration for the command.
+	Cmd                = &cobra.Command{
+		Use:     command,
+		Short:   "Remove a worktree from the project.",
+		Long:    cmn.Basename + " " + command + " - Remove a worktree from the project.",
+		Args:    cobra.ExactArgs(1),
+		Aliases: []string{"remove", "del", "delete"},
+		RunE:    run,
+	} // Cobra command definition for the 'rm' command.
+)
+
+// init performs initialization for the 'rm' command.
+func init() {
+	Cmd.PersistentFlags().BoolVarP(&config.Force, "force", "f", false, "force removal even if worktree is dirty or locked")
+}
+
+// run provides the core execution of the 'rm' command.
+func run(cmd *cobra.Command, args []string) error {
+	funcName := "run"
+	cmn.Debug("%s: %s: begin\n", command, funcName)
+	cmn.Debug("%s: %s: config: %#v\n", command, funcName, config)
+	cmn.Debug("%s: %s: args: %v\n", command, funcName, args)
+
+	// Set the worktree name.
+	wtName := args[0]
+	cmn.Debug("%s: %s: worktree name: %s\n", command, funcName, wtName)
+
+	// Remove the worktree.
+	output, err := git.WorktreeRemove(config, wtName)
+	if err != nil {
+		return err
+	}
+	fmt.Print(string(output))
+
+	cmn.Debug("%s: %s: end\n", command, funcName)
+	return nil
+}

internal/cobra/root/command.go

@@ -4,8 +4,10 @@ package root
 import (
 	"github.com/jason-dour/git-wt/internal/cmn"
 	"github.com/jason-dour/git-wt/internal/cobra/cl"
-	"github.com/jason-dour/git-wt/internal/cobra/list"
+	"github.com/jason-dour/git-wt/internal/cobra/ls"
 	"github.com/jason-dour/git-wt/internal/cobra/mk"
+	"github.com/jason-dour/git-wt/internal/cobra/mv"
+	"github.com/jason-dour/git-wt/internal/cobra/rm"
 	"github.com/spf13/cobra"
 )
 
@@ -26,7 +28,9 @@ func init() {
 	Cmd.PersistentFlags().BoolVarP(&cmn.DebugFlag, "debug", "d", false, "enable debug mode")
 
 	// Sub-Commands
-	Cmd.AddCommand(mk.Cmd)
 	Cmd.AddCommand(cl.Cmd)
-	Cmd.AddCommand(list.Cmd)
+	Cmd.AddCommand(ls.Cmd)
+	Cmd.AddCommand(mk.Cmd)
+	Cmd.AddCommand(mv.Cmd)
+	Cmd.AddCommand(rm.Cmd)
 }