Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ spinner := termite.NewSpinner(termite.StdoutWriter, "Processing...", refreshInte
if err := spinner.Start(ctx); err == nil {
doWork()

_ = spinner.Stop("Done!")
_ = spinner.Stop(context.Background(), "Done!")
}
```

Expand Down
2 changes: 1 addition & 1 deletion internal/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ func demoSpinner(ctx *demoContext) {
}
time.Sleep(time.Second)
for _, spinner := range spinners {
_ = spinner.Stop("- Done " + taskDoneMarkUniChar)
_ = spinner.Stop(context.Background(), "- Done "+taskDoneMarkUniChar)
}

cancel()
Expand Down
14 changes: 9 additions & 5 deletions spinner.go
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ func (f *SimpleSpinnerFormatter) CharSeq() []string {
// Spinner a spinning progress indicator
type Spinner interface {
Start(context.Context) error
Stop(string) error
Stop(ctx context.Context, message string) error
SetTitle(title string) error
}

Expand Down Expand Up @@ -211,16 +211,20 @@ func (s *spinner) Start(ctx context.Context) (err error) {
}

// Stop stops the spinner and displays the specified message
func (s *spinner) Stop(message string) (err error) {
func (s *spinner) Stop(ctx context.Context, message string) (err error) {
s.stateMx.Lock()
defer s.stateMx.Unlock()

if !s.active {
err = errors.New("spinner not active")
} else {
s.stopC <- true
s.active = false
s.printExitMessage(message)
select {
case s.stopC <- true:
s.active = false
s.printExitMessage(message)
case <-ctx.Done():
err = ctx.Err()
}
}

return err
Expand Down
8 changes: 4 additions & 4 deletions spinner_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ func TestSpinnerTitles(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
_ = spin.Start(ctx)
_ = spin.Stop("")
_ = spin.Stop(context.Background(), "")

assert.Error(t, spin.SetTitle("new title"))
})
Expand Down Expand Up @@ -106,8 +106,8 @@ func TestSpinnerErrors(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
_ = spin.Start(ctx)
assert.NoError(t, spin.Stop(""))
assert.Error(t, spin.Stop(""))
assert.NoError(t, spin.Stop(context.Background(), ""))
assert.Error(t, spin.Stop(context.Background(), ""))
},
},
{
Expand Down Expand Up @@ -138,7 +138,7 @@ func TestSpinnerStopMessage(t *testing.T) {
err := spin.Start(ctx)
assert.NoError(t, err)

err = spin.Stop(expectedStopMessage)
err = spin.Stop(context.Background(), expectedStopMessage)
assert.NoError(t, err)

assertBufferEventuallyContains(t, emulatedStdout, expectedStopMessage)
Expand Down
Loading