prompt

package
v0.136.0 Latest Latest
Warning

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

 Go to latest Published: Apr 27, 2026 License: BSD-2-Clause Imports: 20 Imported by: 0

Documentation

Overview

Package prompt handles prompt file loading, saving, and queue management.

Index

Constants

This section is empty.

Variables

View Source 
var AvailablePromptStatuses = PromptStatuses{
	IdeaPromptStatus,
	DraftPromptStatus,
	ApprovedPromptStatus,
	ExecutingPromptStatus,
	CompletedPromptStatus,
	FailedPromptStatus,
	InReviewPromptStatus,
	PendingVerificationPromptStatus,
	CancelledPromptStatus,
	CommittingPromptStatus,
	RejectedPromptStatus,
}

AvailablePromptStatuses is the collection of all valid PromptStatus values.

View Source 
var ErrEmptyPrompt = stderrors.New("prompt file is empty")

ErrEmptyPrompt is returned when a prompt file is empty or contains only whitespace.

Functions

func StripNumberPrefix added in v0.47.0 

func StripNumberPrefix(filename string) string

StripNumberPrefix removes any leading numeric prefix (e.g. "200-foo.md" → "foo.md", "1-bar.md" → "bar.md"). Returns the original filename if no numeric prefix is found.

Types

type BaseName added in v0.135.17 

type BaseName string

BaseName is the prompt filename without the .md extension and with special characters replaced.

func (BaseName) String added in v0.135.17 

func (b BaseName) String() string

String returns the underlying string value.

type ContainerName added in v0.135.17 

type ContainerName string

ContainerName is a sanitized Docker container name derived from project and prompt names.

func (ContainerName) Sanitize added in v0.135.17 

func (n ContainerName) Sanitize() ContainerName

Sanitize replaces any character not in [a-zA-Z0-9_-] with '-'.

func (ContainerName) String added in v0.135.17 

func (n ContainerName) String() string

String returns the underlying string for use with exec / docker.

type Counter added in v0.17.24 

type Counter interface {
	CountBySpec(ctx context.Context, specID string) (completed, total int, err error)
}

Counter counts prompts linked to specs.

func NewCounter added in v0.17.24 

func NewCounter(currentDateTimeGetter libtime.CurrentDateTimeGetter, dirs ...string) Counter

NewCounter creates a Counter that scans the given directories.

type FileMover added in v0.2.36 

type FileMover interface {
	MoveFile(ctx context.Context, oldPath string, newPath string) error
}

FileMover handles file move operations with git awareness.

type Frontmatter 

type Frontmatter struct {
	Status             string   `yaml:"status"`
	Specs              SpecList `yaml:"spec,omitempty,flow"`
	Summary            string   `yaml:"summary,omitempty"`
	Container          string   `yaml:"container,omitempty"`
	DarkFactoryVersion string   `yaml:"dark-factory-version,omitempty"`
	Created            string   `yaml:"created,omitempty"`
	Queued             string   `yaml:"queued,omitempty"`
	Started            string   `yaml:"started,omitempty"`
	Completed          string   `yaml:"completed,omitempty"`
	PRURL              string   `yaml:"pr-url,omitempty"`
	Branch             string   `yaml:"branch,omitempty"`
	Issue              string   `yaml:"issue,omitempty"`
	RetryCount         int      `yaml:"retryCount,omitempty"`
	LastFailReason     string   `yaml:"lastFailReason,omitempty"`
	Rejected           string   `yaml:"rejected,omitempty"`
	RejectedReason     string   `yaml:"rejected_reason,omitempty"`
}

Frontmatter represents the YAML frontmatter in a prompt file.

func (Frontmatter) HasSpec added in v0.17.28 

func (f Frontmatter) HasSpec(id string) bool

HasSpec returns true if the given spec ID is in the Specs list. Comparison is by parsed integer prefix: "019" matches "19", "0019", and "019-review-fix-loop". If either value has no numeric prefix, falls back to exact string match.

type Manager added in v0.2.26 

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

Manager manages prompt file operations.

func NewManager added in v0.2.26 

func NewManager(
	inboxDir string,
	inProgressDir string,
	completedDir string,
	mover FileMover,
	currentDateTimeGetter libtime.CurrentDateTimeGetter,
) *Manager

NewManager creates a new Manager.

func (*Manager) AllPreviousCompleted added in v0.4.0 

func (pm *Manager) AllPreviousCompleted(ctx context.Context, n int) bool

AllPreviousCompleted checks if all prompts with numbers less than n are in completed/.

func (*Manager) Content added in v0.2.26 

func (pm *Manager) Content(ctx context.Context, path string) (string, error)

Content returns the prompt content (without frontmatter) for passing to Docker.

func (*Manager) FindCommitting added in v0.123.0 

func (pm *Manager) FindCommitting(ctx context.Context) ([]string, error)

FindCommitting returns paths of all prompt files in in-progress/ with status "committing".

func (*Manager) FindMissingCompleted added in v0.97.0 

func (pm *Manager) FindMissingCompleted(ctx context.Context, n int) []int

FindMissingCompleted returns prompt numbers less than n that are NOT in completed/.

func (*Manager) FindPromptStatusInProgress added in v0.97.0 

func (pm *Manager) FindPromptStatusInProgress(ctx context.Context, number int) string

FindPromptStatusInProgress looks up a prompt by number in the in-progress directory and returns its frontmatter status.

func (*Manager) HasExecuting added in v0.2.26 

func (pm *Manager) HasExecuting(ctx context.Context) bool

HasExecuting returns true if any prompt in dir has status "executing".

func (*Manager) HasQueuedPromptsOnBranch added in v0.42.0 

func (pm *Manager) HasQueuedPromptsOnBranch(
	ctx context.Context,
	branch string,
	excludePath string,
) (bool, error)

HasQueuedPromptsOnBranch returns true if any queued prompt (other than excludePath) has the given branch value in its frontmatter.

func (*Manager) IncrementRetryCount added in v0.17.34 

func (pm *Manager) IncrementRetryCount(ctx context.Context, path string) error

IncrementRetryCount increments the retryCount field in a prompt file's frontmatter.

func (*Manager) ListQueued added in v0.2.26 

func (pm *Manager) ListQueued(ctx context.Context) ([]Prompt, error)

ListQueued scans a directory for .md files that should be picked up.

func (*Manager) Load added in v0.11.6 

func (pm *Manager) Load(ctx context.Context, path string) (*PromptFile, error)

Load reads a prompt file from disk, parsing frontmatter and body.

func (*Manager) MoveToCompleted added in v0.2.26 

func (pm *Manager) MoveToCompleted(ctx context.Context, path string) error

MoveToCompleted sets status to "completed" and moves a prompt file to the completed/ subdirectory.

func (*Manager) NormalizeFilenames added in v0.2.26 

func (pm *Manager) NormalizeFilenames(ctx context.Context, dir string) ([]Rename, error)

NormalizeFilenames scans a directory for .md files and ensures they follow the NNN-slug.md naming convention. It also checks the completed directory for used numbers.

func (*Manager) ReadFrontmatter added in v0.2.26 

func (pm *Manager) ReadFrontmatter(ctx context.Context, path string) (*Frontmatter, error)

ReadFrontmatter reads frontmatter from a file.

func (*Manager) ResetExecuting added in v0.2.26 

func (pm *Manager) ResetExecuting(ctx context.Context) error

ResetExecuting resets any prompts with status "executing" back to "approved".

func (*Manager) ResetFailed added in v0.10.6 

func (pm *Manager) ResetFailed(ctx context.Context) error

ResetFailed resets any prompts with status "failed" back to "approved".

func (*Manager) SetBranch added in v0.17.17 

func (pm *Manager) SetBranch(ctx context.Context, path string, branch string) error

SetBranch updates the branch field in a prompt file's frontmatter.

func (*Manager) SetContainer added in v0.2.26 

func (pm *Manager) SetContainer(ctx context.Context, path string, name string) error

SetContainer updates the container field in a prompt file's frontmatter.

func (*Manager) SetPRURL added in v0.16.0 

func (pm *Manager) SetPRURL(ctx context.Context, path string, url string) error

SetPRURL updates the pr-url field in a prompt file's frontmatter.

func (*Manager) SetStatus added in v0.2.26 

func (pm *Manager) SetStatus(ctx context.Context, path string, status string) error

SetStatus updates the status field in a prompt file's frontmatter.

func (*Manager) SetVersion added in v0.6.0 

func (pm *Manager) SetVersion(ctx context.Context, path string, version string) error

SetVersion updates the dark-factory-version field in a prompt file's frontmatter.

func (*Manager) Title added in v0.2.26 

func (pm *Manager) Title(ctx context.Context, path string) (string, error)

Title extracts the first # heading from a prompt file.

type Prompt 

type Prompt struct {
	Path   string
	Status PromptStatus
}

Prompt represents a prompt file with YAML frontmatter.

func (Prompt) Number added in v0.4.0 

func (p Prompt) Number() int

Number extracts the numeric prefix from the prompt filename. Returns -1 if the filename has no numeric prefix.

func (Prompt) Validate added in v0.4.0 

func (p Prompt) Validate(ctx context.Context) error

Validate validates the Prompt struct.

func (Prompt) ValidateForExecution added in v0.4.0 

func (p Prompt) ValidateForExecution(ctx context.Context) error

ValidateForExecution validates that a prompt is ready to execute.

type PromptFile added in v0.11.6 

type PromptFile struct {
	Path        string
	Frontmatter Frontmatter
	Body        []byte // immutable after Load — never modified
	// contains filtered or unexported fields
}

PromptFile represents a loaded prompt file with immutable body and mutable frontmatter.

func NewPromptFile added in v0.36.3 

func NewPromptFile(
	path string,
	fm Frontmatter,
	body []byte,
	currentDateTimeGetter libtime.CurrentDateTimeGetter,
) *PromptFile

NewPromptFile creates a PromptFile with the given fields and currentDateTimeGetter. This is intended for use in tests where a PromptFile must be constructed without reading from disk.

func (*PromptFile) Branch added in v0.17.17 

func (pf *PromptFile) Branch() string

Branch returns the branch field from frontmatter.

func (*PromptFile) Content added in v0.11.6 

func (pf *PromptFile) Content() (string, error)

Content returns the body as a string, stripped of leading empty frontmatter blocks. Returns ErrEmptyPrompt if body is empty or whitespace-only.

func (*PromptFile) Issue added in v0.43.0 

func (pf *PromptFile) Issue() string

Issue returns the issue tracker reference from the prompt frontmatter (empty string if unset).

func (*PromptFile) MarkApproved added in v0.24.2 

func (pf *PromptFile) MarkApproved()

MarkApproved sets status to approved and ensures created/queued timestamps exist.

func (*PromptFile) MarkCancelled added in v0.62.0 

func (pf *PromptFile) MarkCancelled()

MarkCancelled sets status to cancelled.

func (*PromptFile) MarkCommitting added in v0.123.0 

func (pf *PromptFile) MarkCommitting()

MarkCommitting sets the status to "committing" — container succeeded, awaiting git commit.

func (*PromptFile) MarkCompleted added in v0.11.6 

func (pf *PromptFile) MarkCompleted()

MarkCompleted sets status to completed with timestamp and clears any previously recorded lastFailReason so a successful retry leaves no stale failure data in the frontmatter. The YAML tag is lastFailReason,omitempty so the field is dropped entirely from the serialised file when empty.

func (*PromptFile) MarkFailed added in v0.11.6 

func (pf *PromptFile) MarkFailed()

MarkFailed sets status to failed with timestamp.

func (*PromptFile) MarkPendingVerification added in v0.28.0 

func (pf *PromptFile) MarkPendingVerification()

MarkPendingVerification sets status to pending_verification.

func (*PromptFile) PRURL added in v0.17.17 

func (pf *PromptFile) PRURL() string

PRURL returns the pr-url field from frontmatter.

func (*PromptFile) PrepareForExecution added in v0.11.6 

func (pf *PromptFile) PrepareForExecution(container, version string)

PrepareForExecution sets all fields needed before container launch. This replaces separate SetContainer + SetVersion + SetStatus calls.

func (*PromptFile) RetryCount added in v0.17.34 

func (pf *PromptFile) RetryCount() int

RetryCount returns the retryCount field from frontmatter.

func (*PromptFile) Save added in v0.11.6 

func (pf *PromptFile) Save(ctx context.Context) error

Save writes the prompt file back to disk: frontmatter + body. Body is always preserved exactly as loaded.

func (*PromptFile) SetBranch added in v0.17.17 

func (pf *PromptFile) SetBranch(branch string)

SetBranch sets the branch field in frontmatter.

func (*PromptFile) SetBranchIfEmpty added in v0.40.0 

func (pf *PromptFile) SetBranchIfEmpty(branch string)

SetBranchIfEmpty sets the branch field only if it is currently empty.

func (*PromptFile) SetIssue added in v0.40.0 

func (pf *PromptFile) SetIssue(issue string)

SetIssue sets the issue field in frontmatter.

func (*PromptFile) SetIssueIfEmpty added in v0.40.0 

func (pf *PromptFile) SetIssueIfEmpty(issue string)

SetIssueIfEmpty sets the issue field only if it is currently empty.

func (*PromptFile) SetLastFailReason added in v0.98.0 

func (pf *PromptFile) SetLastFailReason(reason string)

SetLastFailReason records the human-readable reason for the last failure.

func (*PromptFile) SetPRURL added in v0.16.0 

func (pf *PromptFile) SetPRURL(url string)

SetPRURL sets the pr-url field in frontmatter.

func (*PromptFile) SetSummary added in v0.13.1 

func (pf *PromptFile) SetSummary(summary string)

SetSummary sets the summary field in frontmatter.

func (*PromptFile) Specs added in v0.17.28 

func (pf *PromptFile) Specs() []string

Specs returns the specs slice from frontmatter. Returns an empty slice if nil.

func (*PromptFile) StampRejected added in v0.133.0 

func (pf *PromptFile) StampRejected(reason string)

StampRejected sets the rejected timestamp and reason, then marks status as rejected.

func (*PromptFile) Title added in v0.11.6 

func (pf *PromptFile) Title() string

Title extracts the first # heading from the body.

func (*PromptFile) VerificationSection added in v0.28.0 

func (pf *PromptFile) VerificationSection() string

VerificationSection extracts the content of the <verification> tag from the prompt body. Returns an empty string if no <verification> tag is found.

type PromptStatus added in v0.24.2 

type PromptStatus string

PromptStatus represents the current state of a prompt. 

const (
	// IdeaPromptStatus indicates a rough concept that needs refinement before it can be reviewed.
	IdeaPromptStatus PromptStatus = "idea"
	// DraftPromptStatus indicates the prompt is complete and ready for human review and approval.
	DraftPromptStatus PromptStatus = "draft"
	// ApprovedPromptStatus indicates the prompt has been approved and queued for execution.
	ApprovedPromptStatus PromptStatus = "approved"
	// ExecutingPromptStatus indicates the prompt is currently being executed in a YOLO container.
	ExecutingPromptStatus PromptStatus = "executing"
	// CompletedPromptStatus indicates the prompt has been executed successfully.
	CompletedPromptStatus PromptStatus = "completed"
	// FailedPromptStatus indicates the prompt execution failed and needs fix or retry.
	FailedPromptStatus PromptStatus = "failed"
	// InReviewPromptStatus indicates the prompt's PR is under review.
	InReviewPromptStatus PromptStatus = "in_review"
	// PendingVerificationPromptStatus indicates the prompt is awaiting verification after review.
	PendingVerificationPromptStatus PromptStatus = "pending_verification"
	// CancelledPromptStatus indicates the prompt was cancelled before or during execution.
	CancelledPromptStatus PromptStatus = "cancelled"
	// CommittingPromptStatus indicates the container succeeded but the git commit is still pending.
	// The prompt stays in in-progress/ until the commit succeeds.
	CommittingPromptStatus PromptStatus = "committing"
	// RejectedPromptStatus indicates the prompt was deliberately abandoned before execution.
	// This is a terminal state — rejected prompts are moved to prompts/rejected/ and never executed.
	RejectedPromptStatus PromptStatus = "rejected"
)

func (PromptStatus) CanTransitionTo added in v0.132.2 

func (s PromptStatus) CanTransitionTo(target PromptStatus) error

CanTransitionTo returns nil if transitioning from s to target is valid, or an error naming both states if the transition is not in the table.

func (PromptStatus) IsActive added in v0.132.2 

func (s PromptStatus) IsActive() bool

IsActive returns true if the prompt is in active processing (neither pre-execution nor terminal). Note: FailedPromptStatus is intentionally Active — failed prompts can be re-approved for retry.

func (PromptStatus) IsPreExecution added in v0.132.2 

func (s PromptStatus) IsPreExecution() bool

IsPreExecution returns true if the prompt has not yet entered active execution.

func (PromptStatus) IsRejectable added in v0.133.0 

func (s PromptStatus) IsRejectable() bool

IsRejectable returns true if the prompt may be rejected from its current state. Rejection is only allowed from pre-execution states (idea, draft, approved).

func (PromptStatus) IsTerminal added in v0.132.2 

func (s PromptStatus) IsTerminal() bool

IsTerminal returns true if the prompt has reached a final, non-actionable state.

func (PromptStatus) String added in v0.24.2 

func (s PromptStatus) String() string

String returns the string representation of the PromptStatus.

func (PromptStatus) Validate added in v0.24.2 

func (s PromptStatus) Validate(ctx context.Context) error

Validate validates the PromptStatus value.

type PromptStatuses added in v0.24.2 

type PromptStatuses []PromptStatus

PromptStatuses is a slice of PromptStatus values.

func (PromptStatuses) Contains added in v0.24.2 

func (p PromptStatuses) Contains(status PromptStatus) bool

Contains returns true if the given status is in the collection.

type Rename added in v0.2.15 

type Rename struct {
	OldPath string
	NewPath string
}

Rename represents a file rename operation.

type SpecList added in v0.17.28 

type SpecList []string

SpecList is a []string that handles both YAML scalar and sequence for the spec field. This enables backward compatibility where spec was a single string (e.g. spec: "017") while also supporting multiple specs (e.g. spec: ["017", "019"]).

func (*SpecList) UnmarshalYAML added in v0.17.28 

func (s *SpecList) UnmarshalYAML(value *yaml.Node) error

UnmarshalYAML implements yaml.Unmarshaler to accept both scalar and sequence.

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.