Documentation
¶
Overview ¶
Package progress provides timestamped logging to file and stdout with color support.
Index ¶
- func IsPathLockedByCurrentProcess(path string) bool
- func TryLockFile(f *os.File) (bool, error)
- type Colors
- type Config
- type Logger
- func (l *Logger) Close() error
- func (l *Logger) Elapsed() string
- func (l *Logger) Error(format string, args ...any)
- func (l *Logger) LogAnswer(answer string)
- func (l *Logger) LogDiffStats(files, additions, deletions int)
- func (l *Logger) LogDraftReview(action, feedback string)
- func (l *Logger) LogQuestion(question string, options []string)
- func (l *Logger) Path() string
- func (l *Logger) Print(format string, args ...any)
- func (l *Logger) PrintAligned(text string)
- func (l *Logger) PrintRaw(format string, args ...any)
- func (l *Logger) PrintSection(section status.Section)
- func (l *Logger) Warn(format string, args ...any)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsPathLockedByCurrentProcess ¶ added in v0.4.0
IsPathLockedByCurrentProcess reports whether this process holds the active lock for path.
Types ¶
type Colors ¶ added in v0.2.0
type Colors struct {
// contains filtered or unexported fields
}
Colors holds all color configuration for output formatting. use NewColors to create from config.ColorConfig.
func NewColors ¶ added in v0.2.0
func NewColors(cfg config.ColorConfig) *Colors
NewColors creates Colors from config.ColorConfig. all colors must be provided - use config with embedded defaults fallback. panics if any color value is invalid (configuration error).
type Config ¶
type Config struct {
PlanFile string // plan filename (used to derive progress filename)
PlanDescription string // plan description for plan mode (used for filename)
Mode string // execution mode: full, review, codex-only, plan
Branch string // current git branch
NoColor bool // disable color output (sets color.NoColor globally)
}
Config holds logger configuration.
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
Logger writes timestamped output to both file and stdout.
func NewLogger ¶
NewLogger creates a logger writing to both a progress file and stdout. if the progress file already exists with a completion footer, it is truncated and a fresh header is written. if the file exists without a completion footer (interrupted run), existing log is preserved and a restart separator is written. colors must be provided (created via NewColors from config). holder is the shared PhaseHolder for reading the current execution phase.
func (*Logger) Elapsed ¶
Elapsed returns formatted elapsed time since start. for durations >= 1 hour, truncates to minutes (e.g. "1h23m"); otherwise to seconds (e.g. "5m30s").
func (*Logger) LogAnswer ¶ added in v0.4.0
LogAnswer logs the user's answer for plan creation mode. format: ANSWER: <answer>
func (*Logger) LogDiffStats ¶ added in v0.10.0
LogDiffStats writes git diff stats to the progress file (file-only, no stdout). format: [timestamp] DIFFSTATS: files=F additions=A deletions=D
func (*Logger) LogDraftReview ¶ added in v0.6.0
LogDraftReview logs the user's draft review action and optional feedback. format: DRAFT REVIEW: <action> if feedback is non-empty: FEEDBACK: <feedback>
func (*Logger) LogQuestion ¶ added in v0.4.0
LogQuestion logs a question and its options for plan creation mode. format: QUESTION: <question>\n OPTIONS: <opt1>, <opt2>, ...
func (*Logger) PrintAligned ¶
PrintAligned writes text with timestamp on each line, suppressing empty lines.
func (*Logger) PrintSection ¶
PrintSection writes a section header without timestamp in yellow. format: "\n--- {label} ---\n"
Source Files