Cleanup

Author: nathanjcochran

internal/tiger/cmd/spinner.go

@@ -14,36 +14,43 @@ import (
 var spinnerFrames = []string{"⢎ ", "⠎⠁", "⠊⠑", "⠈⠱", " ⡱", "⢀⡰", "⢄⡠", "⢆⡀"}
 
 type Spinner struct {
-	// Populated when output is a TTY
+	// Populated when output is a terminal
 	program *tea.Program
 
-	// Populated when output is not a TTY
+	// Populated when output is not a terminal
 	output io.Writer
 	model  *spinnerModel
 }
 
+// NewSpinner creates and returns a new [Spinner] for displaying animated
+// status messages. If output is a terminal, it uses bubbletea to dynamically
+// update the spinner in place. If output is not a terminal, it prints each
+// message on a new line without animation. The message parameter supports
+// fmt.Sprintf-style formatting with optional args.
 func NewSpinner(output io.Writer, message string, args ...any) *Spinner {
-	model := spinnerModel{
-		message: fmt.Sprintf(message, args...),
+	if isTerminal(output) {
+		return newAnimatedSpinner(output, message, args...)
 	}
+	return newManualSpinner(output, message, args...)
+}
 
-	// If output is not a TTY, print each message on a new line
-	if !isTerminal(output) {
-		s := &Spinner{
-			output: output,
-			model:  &model,
-		}
-		s.println()
-		return s
+// isTerminal is a helper method for detecting whether an [io.Writer] is a
+// terminal.
+func isTerminal(w io.Writer) bool {
+	if f, ok := w.(*os.File); ok {
+		return term.IsTerminal(int(f.Fd()))
 	}
+	return false
+}
 
-	// If output is a TTY, use bubbletea to dynamically update the message
+func newAnimatedSpinner(output io.Writer, message string, args ...any) *Spinner {
 	program := tea.NewProgram(
-		model,
+		spinnerModel{
+			message: fmt.Sprintf(message, args...),
+		},
 		tea.WithOutput(output),
 	)
 
-	// Start the program in a goroutine
 	go func() {
 		if _, err := program.Run(); err != nil {
 			fmt.Fprintf(output, "Error displaying output: %s\n", err)
@@ -55,6 +62,20 @@ func NewSpinner(output io.Writer, message string, args ...any) *Spinner {
 	}
 }
 
+func newManualSpinner(output io.Writer, message string, args ...any) *Spinner {
+	s := &Spinner{
+		output: output,
+		model: &spinnerModel{
+			message: fmt.Sprintf(message, args...),
+		},
+	}
+	s.println()
+	return s
+}
+
+// Update changes the spinner's displayed message. If the output is a terminal,
+// the message is updated in place via bubbletea. Otherwise, the message is
+// printed on a new line if it differs from the previous one.
 func (s *Spinner) Update(message string, args ...any) {
 	message = fmt.Sprintf(message, args...)
 	if s.program != nil {
@@ -66,6 +87,8 @@ func (s *Spinner) Update(message string, args ...any) {
 	}
 }
 
+// Stop terminates the spinner program and waits for it to finish.
+// This method is a no-op if the output is not a terminal.
 func (s *Spinner) Stop() {
 	if s.program == nil {
 		return
@@ -75,22 +98,20 @@ func (s *Spinner) Stop() {
 	s.program.Wait()
 }
 
+// println prints the current state of the model to the configured output on a
+// new line. It is used when the output is not a terminal, and we therefore
+// don't want to write terminal control characters.
 func (s *Spinner) println() {
 	fmt.Fprintln(s.output, s.model.View())
 }
 
-func isTerminal(w io.Writer) bool {
-	if f, ok := w.(*os.File); ok {
-		return term.IsTerminal(int(f.Fd()))
-	}
-	return false
-}
-
-// Message types for the bubbletea model
-type tickMsg struct{}
-type updateMsg string
+// Message types for the [tea.Model].
+type (
+	tickMsg   struct{}
+	updateMsg string
+)
 
-// spinnerModel is the bubbletea model for the spinner
+// spinnerModel is the [tea.Model] for the spinner.
 type spinnerModel struct {
 	message string
 	frame   int