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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
package termenv
import (
"io"
"os"
"sync"
)
// output is the default global output.
var output = NewOutput(os.Stdout)
// File represents a file descriptor.
//
// Deprecated: Use *os.File instead.
type File interface {
io.ReadWriter
Fd() uintptr
}
// OutputOption sets an option on Output.
type OutputOption = func(*Output)
// Output is a terminal output.
type Output struct {
Profile
w io.Writer
environ Environ
assumeTTY bool
unsafe bool
cache bool
fgSync *sync.Once
fgColor Color
bgSync *sync.Once
bgColor Color
}
// Environ is an interface for getting environment variables.
type Environ interface {
Environ() []string
Getenv(string) string
}
type osEnviron struct{}
func (oe *osEnviron) Environ() []string {
return os.Environ()
}
func (oe *osEnviron) Getenv(key string) string {
return os.Getenv(key)
}
// DefaultOutput returns the default global output.
func DefaultOutput() *Output {
return output
}
// SetDefaultOutput sets the default global output.
func SetDefaultOutput(o *Output) {
output = o
}
// NewOutput returns a new Output for the given writer.
func NewOutput(w io.Writer, opts ...OutputOption) *Output {
o := &Output{
w: w,
environ: &osEnviron{},
Profile: -1,
fgSync: &sync.Once{},
fgColor: NoColor{},
bgSync: &sync.Once{},
bgColor: NoColor{},
}
if o.w == nil {
o.w = os.Stdout
}
for _, opt := range opts {
opt(o)
}
if o.Profile < 0 {
o.Profile = o.EnvColorProfile()
}
return o
}
// WithEnvironment returns a new OutputOption for the given environment.
func WithEnvironment(environ Environ) OutputOption {
return func(o *Output) {
o.environ = environ
}
}
// WithProfile returns a new OutputOption for the given profile.
func WithProfile(profile Profile) OutputOption {
return func(o *Output) {
o.Profile = profile
}
}
// WithColorCache returns a new OutputOption with fore- and background color values
// pre-fetched and cached.
func WithColorCache(v bool) OutputOption {
return func(o *Output) {
o.cache = v
// cache the values now
_ = o.ForegroundColor()
_ = o.BackgroundColor()
}
}
// WithTTY returns a new OutputOption to assume whether or not the output is a TTY.
// This is useful when mocking console output.
func WithTTY(v bool) OutputOption {
return func(o *Output) {
o.assumeTTY = v
}
}
// WithUnsafe returns a new OutputOption with unsafe mode enabled. Unsafe mode doesn't
// check whether or not the terminal is a TTY.
//
// This option supersedes WithTTY.
//
// This is useful when mocking console output and enforcing ANSI escape output
// e.g. on SSH sessions.
func WithUnsafe() OutputOption {
return func(o *Output) {
o.unsafe = true
}
}
// ForegroundColor returns the terminal's default foreground color.
func (o *Output) ForegroundColor() Color {
f := func() {
if !o.isTTY() {
return
}
o.fgColor = o.foregroundColor()
}
if o.cache {
o.fgSync.Do(f)
} else {
f()
}
return o.fgColor
}
// BackgroundColor returns the terminal's default background color.
func (o *Output) BackgroundColor() Color {
f := func() {
if !o.isTTY() {
return
}
o.bgColor = o.backgroundColor()
}
if o.cache {
o.bgSync.Do(f)
} else {
f()
}
return o.bgColor
}
// HasDarkBackground returns whether terminal uses a dark-ish background.
func (o *Output) HasDarkBackground() bool {
c := ConvertToRGB(o.BackgroundColor())
_, _, l := c.Hsl()
return l < 0.5 //nolint:mnd
}
// TTY returns the terminal's file descriptor. This may be nil if the output is
// not a terminal.
//
// Deprecated: Use Writer() instead.
func (o Output) TTY() File {
if f, ok := o.w.(File); ok {
return f
}
return nil
}
// Writer returns the underlying writer. This may be of type io.Writer,
// io.ReadWriter, or *os.File.
func (o Output) Writer() io.Writer {
return o.w
}
func (o Output) Write(p []byte) (int, error) {
return o.w.Write(p) //nolint:wrapcheck
}
// WriteString writes the given string to the output.
func (o Output) WriteString(s string) (int, error) {
return o.Write([]byte(s))
}
|
