Merge pull request #15 from fumeapp/disable-ui

🎨 1st attempt at disabling the ui

Author: acidjazz

config.go

@@ -7,11 +7,12 @@ import (
 )
 
 type Config struct {
-	Options         ConfigOptions
-	Spinner         spinner.Spinner
 	Colors          ConfigColors
-	ProgressOptions []progress.Option
 	Chars           ConfigChars
+	Spinner         spinner.Spinner
+	Options         ConfigOptions
+	ProgressOptions []progress.Option
+	DisableUI       bool // Disable animations and spinners
 }
 
 type ConfigOptions struct {

config_test.go

@@ -58,3 +58,33 @@ func TestConfig(t *testing.T) {
 		t.Errorf("Expected ExitOnFailure to be 'true', got '%v'", config.Options.ExitOnFailure)
 	}
 }
+
+func TestDisableUI(t *testing.T) {
+	tasks := Tasks{
+		{
+			Title: "Test task",
+			Task: func(task *Task) error {
+				task.Title = "Test task completed"
+				return nil
+			},
+		},
+	}
+
+	// Test with UI disabled
+	cfg := Defaults
+	cfg.DisableUI = true
+
+	runners := New(tasks, cfg)
+
+	// Verify that spinners are not initialized when UI is disabled
+	for _, runner := range runners {
+		if runner.Spinner != nil {
+			t.Error("Expected spinner to be nil when DisableUI is true")
+		}
+	}
+
+	err := runners.Run()
+	if err != nil {
+		t.Fatalf("Expected no error, got: %v", err)
+	}
+}

examples/disable-ui/main.go

@@ -0,0 +1,58 @@
+package main
+
+import (
+	"fmt"
+	"time"
+
+	"github.com/fumeapp/taskin"
+)
+
+func main() {
+	tasks := taskin.Tasks{
+		{
+			Title: "Task with UI disabled",
+			Task: func(t *taskin.Task) error {
+				for i := 0; i < 3; i++ {
+					t.Title = fmt.Sprintf("Task with UI disabled: [%d/3] processing", i+1)
+					time.Sleep(500 * time.Millisecond)
+				}
+				return nil
+			},
+		},
+		{
+			Title: "Parent task with children",
+			Tasks: taskin.Tasks{
+				{
+					Title: "Child task 1",
+					Task: func(t *taskin.Task) error {
+						for i := 0; i < 2; i++ {
+							t.Title = fmt.Sprintf("Child task 1: [%d/2] working", i+1)
+							time.Sleep(300 * time.Millisecond)
+						}
+						return nil
+					},
+				},
+				{
+					Title: "Child task 2",
+					Task: func(t *taskin.Task) error {
+						for i := 0; i < 2; i++ {
+							t.Title = fmt.Sprintf("Child task 2: [%d/2] working", i+1)
+							time.Sleep(300 * time.Millisecond)
+						}
+						return nil
+					},
+				},
+			},
+		},
+	}
+
+	// Create configuration with UI disabled
+	cfg := taskin.Defaults
+	cfg.DisableUI = true
+
+	runners := taskin.New(tasks, cfg)
+	err := runners.Run()
+	if err != nil {
+		panic(err)
+	}
+}

examples/too-much-to-do/main.go

@@ -16,7 +16,7 @@ func main() {
 	libraries := generateLibraries(20)
 	runners := NewLibraryDownloader(libraries)
 
-	runners.Run()
+	runners.Run() //nolint:errcheck // Example code
 }
 
 func generateLibraries(count int) []Library {

mvc.go

@@ -46,7 +46,7 @@ func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 			var spinnerCmds []tea.Cmd
 
 			if runner.State == Running || runner.State == NotStarted {
-				if !IsCI() && runner.Spinner != nil {
+				if !IsCI() && !runner.Config.DisableUI && runner.Spinner != nil {
 					newSpinner, cmd := runner.Spinner.Update(msg)
 					runner.Spinner = &newSpinner
 					spinnerCmds = append(spinnerCmds, cmd)
@@ -105,8 +105,8 @@ func (m *Model) View() string {
 		}
 	}
 
-	// Handle CI mode
-	if IsCI() {
+	// Handle CI mode or UI disabled mode
+	if IsCI() || (len(m.Runners) > 0 && m.Runners[0].Config.DisableUI) {
 		allDone, anyFailed := m.checkTasksState()
 		if !allDone && !anyFailed {
 			return ""
@@ -142,14 +142,14 @@ func renderTask(runner Runner, indent string) string {
 		status = Color(runner.Config.Colors.Failure, runner.Config.Chars.Failure) + " " + runner.Task.Title
 	}
 
-	if IsCI() {
+	if IsCI() || runner.Config.DisableUI {
 		view = indent + status + "\n"
 	} else {
 		view = indent + lipgloss.NewStyle().Render(status) + "\n"
 	}
 
 	// Recursively render children
-	if len(runner.Children) > 0 && (runner.State == Running || IsCI()) {
+	if len(runner.Children) > 0 && (runner.State == Running || IsCI() || runner.Config.DisableUI) {
 		for _, child := range runner.Children {
 			view += renderTask(child, indent+"  ")
 		}

readme.md

@@ -56,6 +56,12 @@ https://github.com/fumeapp/taskin/blob/3cd766c21e5eaba5edb33f38d3781d6cf814f9f9/
 
 
 
+Disable UI animations and spinners
+
+https://github.com/fumeapp/taskin/blob/main/examples/disable-ui/main.go#L32-L42
+
+This is useful when you want plain text output without animations, similar to CI mode but controllable via configuration.
+
 Nest tasks inside tasks
 
 https://github.com/fumeapp/taskin/blob/3cd766c21e5eaba5edb33f38d3781d6cf814f9f9/examples/multi/main.go#L23-L34

taskin.go

@@ -19,7 +19,7 @@ func NewRunner(task Task, cfg Config) Runner {
 
 	var spinr *spinner.Model
 
-	if !IsCI() {
+	if !IsCI() && !cfg.DisableUI {
 		spinnerModel := spinner.New(spinner.WithSpinner(cfg.Spinner))           // Initialize with a spinner model
 		spinnerModel.Style = lipgloss.NewStyle().Foreground(cfg.Colors.Spinner) // Styling spinner
 		spinr = &spinnerModel
@@ -73,7 +73,8 @@ func (r *Runners) Run() error {
 	m := &Model{Runners: *r, Shutdown: false, ShutdownError: nil}
 
 	var out io.Writer = os.Stdout
-	if IsCI() {
+	// Check if we need to disable UI features or are in CI mode
+	if IsCI() || (len(*r) > 0 && (*r)[0].Config.DisableUI) {
 		out = &ansiEscapeCodeFilter{writer: out}
 	}