forked from kubernetes-sigs/kind
-
Notifications
You must be signed in to change notification settings - Fork 0
/
spinner.go
108 lines (96 loc) · 2.29 KB
/
spinner.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/*
Copyright 2018 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
// Package fidget implements CLI functionality for bored users waiting for results
package fidget
import (
"fmt"
"io"
"sync"
"time"
)
// custom CLI loading spinner for kind
var spinnerFrames = []string{
"⠈⠁",
"⠈⠑",
"⠈⠱",
"⠈⡱",
"⢀⡱",
"⢄⡱",
"⢄⡱",
"⢆⡱",
"⢎⡱",
"⢎⡰",
"⢎⡠",
"⢎⡀",
"⢎⠁",
"⠎⠁",
"⠊⠁",
}
// Spinner is a simple and efficient CLI loading spinner used by kind
// It is simplistic and assumes that the line length will not change.
// It is best used indirectly via log.Status (see parent package)
type Spinner struct {
frames []string
stop chan struct{}
ticker *time.Ticker
writer io.Writer
mu *sync.Mutex
// protected by mu
prefix string
suffix string
}
// NewSpinner initializes and returns a new Spinner that will write to
func NewSpinner(w io.Writer) *Spinner {
return &Spinner{
frames: spinnerFrames,
stop: make(chan struct{}, 1),
ticker: time.NewTicker(time.Millisecond * 100),
mu: &sync.Mutex{},
writer: w,
}
}
// SetPrefix sets the prefix to print before the spinner
func (s *Spinner) SetPrefix(prefix string) {
s.mu.Lock()
s.prefix = prefix
s.mu.Unlock()
}
// SetSuffix sets the suffix to print after the spinner
func (s *Spinner) SetSuffix(suffix string) {
s.mu.Lock()
s.suffix = suffix
s.mu.Unlock()
}
// Start starts the spinner running
func (s *Spinner) Start() {
go func() {
for {
for _, frame := range s.frames {
select {
case <-s.stop:
return
case <-s.ticker.C:
func() {
s.mu.Lock()
defer s.mu.Unlock()
fmt.Fprintf(s.writer, "\r%s%s%s", s.prefix, frame, s.suffix)
}()
}
}
}
}()
}
// Stop signals the spinner to stop
func (s *Spinner) Stop() {
s.stop <- struct{}{}
}