mode

package
v0.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 16, 2026 License: MIT Imports: 15 Imported by: 0

Documentation

Overview

Package mode manages MAXAM operating modes

Package mode manages MAXAM operating modes

Package mode manages MAXAM operating modes

Package mode manages MAXAM operating modes

Index

Constants

View Source 
const DefaultPollingInterval = 30 * time.Second

DefaultPollingInterval is the default interval for polling approval status

View Source 
const PlanLabel = "maxam-plan"

PlanLabel is the label used to identify plan issues

Variables

View Source 
var DefaultIgnoreDirs = []string{
	".git", "node_modules", "vendor", ".venv", "__pycache__",
	"dist", "build", "out", "target", ".next", ".nuxt",
}

DefaultIgnoreDirs are directories to skip during analysis

View Source 
var DefaultIgnoreFiles = []string{
	"*.min.js", "*.min.css", "*.map", "*.lock",
}

DefaultIgnoreFiles are file patterns to skip

Functions

func IsCommand 

func IsCommand(input string) bool

IsCommand checks if the input starts with a command prefix

Types

type ApprovalNotification 

type ApprovalNotification struct {
	IssueNumber int
	ApprovedBy  string
}

ApprovalNotification represents a notification when a plan is approved

type AutoPlanConfig 

type AutoPlanConfig struct {
	PollInterval time.Duration
}

AutoPlanConfig holds configuration for AutoPlanHandler

func DefaultAutoPlanConfig 

func DefaultAutoPlanConfig() AutoPlanConfig

DefaultAutoPlanConfig returns the default configuration

type AutoPlanHandler 

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

AutoPlanHandler manages the automatic plan mode workflow It watches for approval on plan issues and transitions to auto mode when approved

func NewAutoPlanHandler 

func NewAutoPlanHandler(
	modeManager *Manager,
	watcher *approval.Watcher,
	poster *approval.QuestionPoster,
) *AutoPlanHandler

NewAutoPlanHandler creates a new AutoPlanHandler

func NewAutoPlanHandlerWithRunner added in v0.8.1 

func NewAutoPlanHandlerWithRunner(
	modeManager *Manager,
	watcher *approval.Watcher,
	poster *approval.QuestionPoster,
	runner *auto.Runner,
) *AutoPlanHandler

NewAutoPlanHandlerWithRunner creates a new AutoPlanHandler with a custom runner

func (*AutoPlanHandler) AskOwnerQuestion 

func (h *AutoPlanHandler) AskOwnerQuestion(ctx context.Context, question, agentName string) error

AskOwnerQuestion posts a question to the owner on the current issue

func (*AutoPlanHandler) CheckApproval 

func (h *AutoPlanHandler) CheckApproval(ctx context.Context) (bool, string, error)

CheckApproval checks for approval on the current plan Returns true if approved, false otherwise

func (*AutoPlanHandler) CheckFeedback added in v0.10.0 

func (h *AutoPlanHandler) CheckFeedback(ctx context.Context) ([]FeedbackNotification, error)

CheckFeedback checks for feedback on the current plan once

func (*AutoPlanHandler) PlanIssueNumber 

func (h *AutoPlanHandler) PlanIssueNumber() int

PlanIssueNumber returns the current plan issue number

func (*AutoPlanHandler) ReportBlocker 

func (h *AutoPlanHandler) ReportBlocker(ctx context.Context, blocker, agentName string) error

ReportBlocker posts a blocker notification to the owner

func (*AutoPlanHandler) Runner added in v0.8.1 

func (h *AutoPlanHandler) Runner() *auto.Runner

Runner returns the auto runner

func (*AutoPlanHandler) SetOnApproved 

func (h *AutoPlanHandler) SetOnApproved(fn func(issueNumber int, approvedBy string))

SetOnApproved sets the callback for when a plan is approved

func (*AutoPlanHandler) SetOnFeedback added in v0.10.0 

func (h *AutoPlanHandler) SetOnFeedback(fn func(issueNumber int, feedback *approval.FeedbackComment))

SetOnFeedback sets the callback for when feedback is received

func (*AutoPlanHandler) SetOnTransition 

func (h *AutoPlanHandler) SetOnTransition(fn func(from, to config.Mode))

SetOnTransition sets the callback for mode transitions

func (*AutoPlanHandler) StartFeedbackPolling added in v0.10.0 

func (h *AutoPlanHandler) StartFeedbackPolling(ctx context.Context) <-chan FeedbackNotification

StartFeedbackPolling starts the polling loop for feedback Returns a channel that receives feedback events

func (*AutoPlanHandler) StartPlanWorkflow 

func (h *AutoPlanHandler) StartPlanWorkflow(ctx context.Context, issueNumber int, planSummary, agentName string) error

StartPlanWorkflow starts the automatic plan workflow 1. Posts the plan to the issue 2. Starts watching for approval 3. When approved, transitions to auto mode

func (*AutoPlanHandler) StartPolling 

func (h *AutoPlanHandler) StartPolling(ctx context.Context) <-chan ApprovalNotification

StartPolling starts the polling loop for approval Returns a channel that receives the approval result

func (*AutoPlanHandler) State 

func (h *AutoPlanHandler) State() AutoPlanState

State returns the current state

func (*AutoPlanHandler) Stop 

func (h *AutoPlanHandler) Stop()

Stop stops the plan workflow and returns to interactive mode

func (*AutoPlanHandler) UnwatchFeedback added in v0.10.0 

func (h *AutoPlanHandler) UnwatchFeedback(issueNumber int)

UnwatchFeedback stops watching the plan issue for feedback

func (*AutoPlanHandler) WatchFeedback added in v0.10.0 

func (h *AutoPlanHandler) WatchFeedback(issueNumber int)

WatchFeedback starts watching the plan issue for feedback

type AutoPlanState 

type AutoPlanState string

AutoPlanState represents the state of the auto plan workflow 

const (
	// StateIdle means no active plan workflow
	StateIdle AutoPlanState = "idle"
	// StatePlanCreated means a plan has been created and posted
	StatePlanCreated AutoPlanState = "plan_created"
	// StateWaitingApproval means waiting for owner approval
	StateWaitingApproval AutoPlanState = "waiting_approval"
	// StateApproved means the plan has been approved
	StateApproved AutoPlanState = "approved"
	// StateExecuting means the plan is being executed
	StateExecuting AutoPlanState = "executing"
)

type CodeAnalysisResult 

type CodeAnalysisResult struct {
	Todos         []TodoItem
	UnusedImports []FileIssue
	LongFiles     []FileIssue
	Summary       string
}

CodeAnalysisResult contains the results of code analysis

type CodeAnalyzer 

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

CodeAnalyzer performs static analysis on project code

func NewCodeAnalyzer 

func NewCodeAnalyzer(workDir string) *CodeAnalyzer

NewCodeAnalyzer creates a new CodeAnalyzer

func (*CodeAnalyzer) Analyze 

func (ca *CodeAnalyzer) Analyze() (*CodeAnalysisResult, error)

Analyze performs code analysis on the project

type Command 

type Command string

Command represents a mode-related command 

const (
	// CommandPlan enters plan mode
	CommandPlan Command = "/plan"
	// CommandAuto enters auto mode directly (without plan)
	CommandAuto Command = "/auto"
	// CommandStop stops current mode and returns to interactive
	CommandStop Command = "/stop"
	// CommandStatus shows current mode status
	CommandStatus Command = "/status"
	// CommandResetAuto resets agent auto mode
	CommandResetAuto Command = "/resetauto"
	// CommandKill force kills agent(s) immediately
	CommandKill Command = "/kill"
	// CommandReset gracefully restarts agent(s)
	CommandReset Command = "/reset"
)

type FeedbackNotification added in v0.10.0 

type FeedbackNotification struct {
	IssueNumber int
	Feedback    *approval.FeedbackComment
}

FeedbackNotification represents a notification when feedback is received

type FileIssue 

type FileIssue struct {
	File    string
	Message string
}

FileIssue represents an issue found in a specific file

type IssueInfo 

type IssueInfo struct {
	Number    int
	Title     string
	CreatedAt time.Time
	Labels    []string
}

IssueInfo contains basic issue information

type Manager 

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

Manager manages the current operating mode

func NewManager 

func NewManager(defaultMode config.Mode) *Manager

NewManager creates a new mode manager with the given default mode

func (*Manager) AddIssue 

func (m *Manager) AddIssue(issueNum int)

AddIssue adds an issue number to the plan context

func (*Manager) Current 

func (m *Manager) Current() config.Mode

Current returns the current operating mode

func (*Manager) EnterAutoMode 

func (m *Manager) EnterAutoMode(ctx *PlanContext) error

EnterAutoMode transitions to auto mode from plan mode Requires plan approval

func (*Manager) EnterAutoModeWithoutPlan added in v0.9.0 

func (m *Manager) EnterAutoModeWithoutPlan() error

EnterAutoModeWithoutPlan transitions to auto mode directly from interactive mode This bypasses the plan mode and allows immediate auto execution

func (*Manager) EnterPlanMode 

func (m *Manager) EnterPlanMode() error

EnterPlanMode transitions to plan mode from interactive mode

func (*Manager) GetPlanContext 

func (m *Manager) GetPlanContext() *PlanContext

GetPlanContext returns the current plan context (nil if not in plan/auto mode)

func (*Manager) IsAuto 

func (m *Manager) IsAuto() bool

IsAuto returns true if in auto mode

func (*Manager) IsInteractive 

func (m *Manager) IsInteractive() bool

IsInteractive returns true if in interactive mode

func (*Manager) IsPlan 

func (m *Manager) IsPlan() bool

IsPlan returns true if in plan mode

func (*Manager) SetPlanApproved 

func (m *Manager) SetPlanApproved(approved bool)

SetPlanApproved marks the current plan as approved

func (*Manager) ShouldEnforceMention added in v0.9.0 

func (m *Manager) ShouldEnforceMention() bool

ShouldEnforceMention returns whether mention check should be enforced Plan mode and Auto mode require mentions, Interactive mode does not

func (*Manager) StatusString 

func (m *Manager) StatusString() string

StatusString returns a human-readable status string

func (*Manager) Stop 

func (m *Manager) Stop()

Stop returns to interactive mode from any mode

type ParseResult 

type ParseResult struct {
	IsCommand bool
	Command   Command
	Args      string // remaining text after command
}

ParseResult contains the result of parsing user input for commands

func Parse 

func Parse(input string) ParseResult

Parse parses user input and extracts any mode command

type PlanContext 

type PlanContext struct {
	DiscussionURL string // URL of approved discussion
	IssueNumbers  []int  // Issue numbers created from the plan
	Approved      bool   // Whether the plan was approved
}

PlanContext stores the context from plan mode

type PlanExecutor 

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

PlanExecutor handles plan mode execution

func NewPlanExecutor 

func NewPlanExecutor(ghClient *gh.Client, config *PlanModeConfig) *PlanExecutor

NewPlanExecutor creates a new PlanExecutor

func (*PlanExecutor) AnalyzeProject 

func (pe *PlanExecutor) AnalyzeProject(ctx context.Context) (*ProjectAnalysis, error)

AnalyzeProject performs a lightweight project analysis

func (*PlanExecutor) AppendToPlanIssue added in v0.10.0 

func (pe *PlanExecutor) AppendToPlanIssue(ctx context.Context, issueNumber int, appendContent string) error

AppendToPlanIssue appends content to the plan issue body

func (*PlanExecutor) CheckApprovalOnce 

func (pe *PlanExecutor) CheckApprovalOnce(ctx context.Context, issueNumber int, since time.Time) (*approval.ApprovalResult, error)

CheckApprovalOnce checks for approval without blocking

func (*PlanExecutor) CreatePlanIssue 

func (pe *PlanExecutor) CreatePlanIssue(ctx context.Context, analysis *ProjectAnalysis, proposal string) (*PlanIssue, error)

CreatePlanIssue creates an issue with the plan proposal

func (*PlanExecutor) CreatePlanIssueWithLabel added in v0.9.0 

func (pe *PlanExecutor) CreatePlanIssueWithLabel(ctx context.Context, analysis *ProjectAnalysis, proposal string) (*PlanIssue, error)

CreatePlanIssueWithLabel creates an issue with the plan proposal and maxam-plan label

func (*PlanExecutor) FindExistingPlanIssue added in v0.9.0 

func (pe *PlanExecutor) FindExistingPlanIssue(ctx context.Context) (*PlanIssue, error)

FindExistingPlanIssue searches for an existing open plan issue by label

func (*PlanExecutor) GetOrCreatePlanIssue added in v0.9.0 

func (pe *PlanExecutor) GetOrCreatePlanIssue(ctx context.Context, analysis *ProjectAnalysis, proposal string) (*PlanIssue, bool, error)

GetOrCreatePlanIssue finds an existing plan issue or creates a new one

func (*PlanExecutor) PostPlanComment added in v0.9.0 

func (pe *PlanExecutor) PostPlanComment(ctx context.Context, issueNumber int, proposal string) error

PostPlanComment posts a plan proposal as a comment to an existing issue

func (*PlanExecutor) ReplyToFeedback added in v0.10.0 

func (pe *PlanExecutor) ReplyToFeedback(ctx context.Context, issueNumber int, feedbackBy, replyContent string) error

ReplyToFeedback posts a reply comment to feedback

func (*PlanExecutor) UpdatePlanIssue added in v0.10.0 

func (pe *PlanExecutor) UpdatePlanIssue(ctx context.Context, issueNumber int, newBody string) error

UpdatePlanIssue updates the body of a plan issue

func (*PlanExecutor) WaitForApproval 

func (pe *PlanExecutor) WaitForApproval(ctx context.Context, issueNumber int) (*approval.ApprovalResult, error)

WaitForApproval polls the issue for approval comments

type PlanIssue 

type PlanIssue struct {
	IssueNumber int
	Title       string
	Body        string
	CreatedAt   time.Time
	URL         string
}

PlanIssue represents a plan issue created for approval

type PlanModeConfig 

type PlanModeConfig struct {
	PollingInterval time.Duration
}

PlanModeConfig holds configuration for plan mode

func DefaultPlanModeConfig 

func DefaultPlanModeConfig() *PlanModeConfig

DefaultPlanModeConfig returns the default configuration

type ProjectAnalysis 

type ProjectAnalysis struct {
	TotalIssues      int
	OpenIssues       int
	UnassignedIssues int
	OldestOpenIssue  *IssueInfo
	LabelCounts      map[string]int
	Summary          string
}

ProjectAnalysis contains simplified project analysis for plan mode

type TodoItem 

type TodoItem struct {
	File    string
	Line    int
	Content string
	Type    string // TODO, FIXME, HACK, XXX
}

TodoItem represents a TODO comment found in code

type TransitionManager 

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

TransitionManager manages mode transitions

func NewTransitionManager 

func NewTransitionManager(modeManager *Manager, runner *auto.Runner) *TransitionManager

NewTransitionManager creates a new transition manager

func (*TransitionManager) CanTransition 

func (t *TransitionManager) CanTransition(from, to config.Mode) bool

CanTransition checks if a transition is valid without performing it

func (*TransitionManager) CurrentMode 

func (t *TransitionManager) CurrentMode() config.Mode

CurrentMode returns the current mode

func (*TransitionManager) Runner 

func (t *TransitionManager) Runner() *auto.Runner

Runner returns the auto runner

func (*TransitionManager) SetOnError 

func (t *TransitionManager) SetOnError(fn func(err error))

SetOnError sets the callback for transition errors

func (*TransitionManager) SetOnTransition 

func (t *TransitionManager) SetOnTransition(fn func(from, to config.Mode))

SetOnTransition sets the callback for mode transitions

func (*TransitionManager) Transition 

func (t *TransitionManager) Transition(req TransitionRequest) TransitionResult

Transition performs a mode transition

func (*TransitionManager) TransitionToAutoAndRun 

func (t *TransitionManager) TransitionToAutoAndRun(ctx context.Context, planCtx *PlanContext, issues []auto.IssueInfo) error

TransitionToAutoAndRun transitions to auto mode and starts execution This is a convenience method that combines transition and execution

func (*TransitionManager) ValidTransitions 

func (t *TransitionManager) ValidTransitions() []config.Mode

ValidTransitions returns all valid transitions from the current mode

type TransitionRequest 

type TransitionRequest struct {
	// From is the expected current mode (optional, for validation)
	From config.Mode
	// To is the target mode
	To config.Mode
	// PlanContext is required when transitioning to auto mode
	PlanContext *PlanContext
	// Issues is the list of issues to execute (for auto mode)
	Issues []auto.IssueInfo
}

TransitionRequest represents a request to transition modes

type TransitionResult 

type TransitionResult struct {
	Success bool
	From    config.Mode
	To      config.Mode
	Error   error
}

TransitionResult represents the result of a transition

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.