cmd

Documentation

Overview

Package cmd provides CLI commands for the gwq application.

Index

• Constants
• func CreateFinder(g *git.Git, cfg *models.Config) *finder.Finder
• func CreateGlobalFinder(cfg *models.Config) *finder.Finder
• func Execute()
• func ExecuteWithArgs(requiresGit bool, fn func(*CommandContext, *cobra.Command, []string) error) func(*cobra.Command, []string) error
• func ExecuteWithContext(requiresGit bool, fn func(*CommandContext) error) func(*cobra.Command, []string) error
• func LaunchShell(dir string) error
• type CommandContext
  • func NewCommandContext() (*CommandContext, error)
  • func NewGitCommandContext() (*CommandContext, error)
  • func (ctx *CommandContext) DiscoverGlobalWorktrees() ([]*models.Worktree, error)
  • func (ctx *CommandContext) GetFinder() *finder.Finder
  • func (ctx *CommandContext) GetGlobalFinder() *finder.Finder
  • func (ctx *CommandContext) GetWorktrees(forceGlobal bool) ([]*models.Worktree, error)
  • func (ctx *CommandContext) WithGlobalLocalSupport(forceGlobal bool, localFn func(*CommandContext) error, ...) error
• type StatusCollector
  • func NewStatusCollector(includeProcess, fetchRemote bool) *StatusCollector
  • func NewStatusCollectorWithOptions(opts StatusCollectorOptions) *StatusCollector
  • func (c *StatusCollector) CollectAll(ctx context.Context, worktrees []*models.Worktree) ([]*models.WorktreeStatus, error)
• type StatusCollectorOptions

Constants

const (
	// EnvShellDepth is the environment variable name for tracking shell nesting depth.
	EnvShellDepth = "GWQ_SHELL_DEPTH"

	// DefaultNestWarningThreshold is the default depth at which to show a warning.
	DefaultNestWarningThreshold = 2
)

Functions

func CreateFinder

func CreateFinder(g *git.Git, cfg *models.Config) *finder.Finder

CreateFinder creates a finder instance for local operations with the given git instance.

func CreateGlobalFinder

func CreateGlobalFinder(cfg *models.Config) *finder.Finder

CreateGlobalFinder creates a finder instance for global operations.

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately.

func ExecuteWithArgs

func ExecuteWithArgs(requiresGit bool, fn func(*CommandContext, *cobra.Command, []string) error) func(*cobra.Command, []string) error

ExecuteWithArgs is a variant that passes command arguments to the function.

func ExecuteWithContext

func ExecuteWithContext(requiresGit bool, fn func(*CommandContext) error) func(*cobra.Command, []string) error

ExecuteWithContext creates a command context and executes the provided function. This is the main wrapper function that eliminates boilerplate in command implementations.

func LaunchShell

func LaunchShell(dir string) error

LaunchShell launches an interactive shell in the specified directory. This function is used by commands that support the --stay flag.

Types

type CommandContext

type CommandContext struct {
	Config          *models.Config
	Git             *git.Git
	Printer         *ui.Printer
	WorktreeManager *worktree.Manager

	IsGitRepo bool
	// contains filtered or unexported fields
}

CommandContext encapsulates common dependencies used across commands. This eliminates boilerplate code and provides consistent initialization.

func NewCommandContext

func NewCommandContext() (*CommandContext, error)

NewCommandContext creates a new command context for commands that don't require git.

func NewGitCommandContext

func NewGitCommandContext() (*CommandContext, error)

NewGitCommandContext creates a new command context for commands that require git repository.

func (*CommandContext) DiscoverGlobalWorktrees

func (ctx *CommandContext) DiscoverGlobalWorktrees() ([]*models.Worktree, error)

DiscoverGlobalWorktrees discovers global worktrees when -g flag is used.

func (*CommandContext) GetFinder

func (ctx *CommandContext) GetFinder() *finder.Finder

GetFinder returns a finder instance, creating it if needed. This provides lazy initialization to avoid creating finders for commands that don't need them.

func (*CommandContext) GetGlobalFinder

func (ctx *CommandContext) GetGlobalFinder() *finder.Finder

GetGlobalFinder returns a finder instance for global operations that don't require a git repository. This creates a finder with an empty git instance, suitable for global worktree operations.

func (*CommandContext) GetWorktrees

func (ctx *CommandContext) GetWorktrees(forceGlobal bool) ([]*models.Worktree, error)

GetWorktrees returns worktrees with support for both global and local modes

func (*CommandContext) WithGlobalLocalSupport

func (ctx *CommandContext) WithGlobalLocalSupport(
	forceGlobal bool,
	localFn func(*CommandContext) error,
	globalFn func(*CommandContext) error,
) error

WithGlobalLocalSupport handles commands that support both global and local modes.

type StatusCollector

type StatusCollector struct {
	// contains filtered or unexported fields
}

StatusCollector collects status information for worktrees.

func NewStatusCollector

func NewStatusCollector(includeProcess, fetchRemote bool) *StatusCollector

NewStatusCollector creates a new status collector instance.

func NewStatusCollectorWithOptions

func NewStatusCollectorWithOptions(opts StatusCollectorOptions) *StatusCollector

NewStatusCollectorWithOptions creates a new status collector with custom options.

func (*StatusCollector) CollectAll

func (c *StatusCollector) CollectAll(ctx context.Context, worktrees []*models.Worktree) ([]*models.WorktreeStatus, error)

CollectAll collects status for all provided worktrees in parallel.

type StatusCollectorOptions

type StatusCollectorOptions struct {
	IncludeProcess bool
	FetchRemote    bool
	StaleThreshold time.Duration
	BaseDir        string
}

StatusCollectorOptions contains optional parameters for StatusCollector.