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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
"use strict"
var hasUnicode = require("has-unicode")
var ansi = require("ansi")
var align = {
center: require("lodash.pad"),
left: require("lodash.padright"),
right: require("lodash.padleft")
}
var defaultStream = process.stderr
function isTTY() {
return process.stderr.isTTY
}
function getWritableTTYColumns() {
// Writing to the final column wraps the line
// We have to use stdout here, because Node's magic SIGWINCH handler only
// updates process.stdout, not process.stderr
return process.stdout.columns - 1
}
var ProgressBar = module.exports = function (options, cursor) {
if (! options) options = {}
if (! cursor && options.write) {
cursor = options
options = {}
}
if (! cursor) {
cursor = ansi(defaultStream)
}
this.cursor = cursor
this.showing = false
this.theme = options.theme || (hasUnicode() ? ProgressBar.unicode : ProgressBar.ascii)
this.template = options.template || [
{type: "name", separated: true, length: 25},
{type: "spinner", separated: true},
{type: "startgroup"},
{type: "completionbar"},
{type: "endgroup"}
]
this.updatefreq = options.maxUpdateFrequency || 50
this.lastName = ""
this.lastCompleted = 0
this.spun = 0
this.last = new Date(0)
var self = this
this._handleSizeChange = function () {
if (!self.showing) return
self.hide()
self.show()
}
}
ProgressBar.prototype = {}
ProgressBar.unicode = {
startgroup: "╢",
endgroup: "╟",
complete: "█",
incomplete: "░",
spinner: "▀▐▄▌",
subsection: "→"
}
ProgressBar.ascii = {
startgroup: "|",
endgroup: "|",
complete: "#",
incomplete: "-",
spinner: "-\\|/",
subsection: "->"
}
ProgressBar.prototype.setTheme = function(theme) {
this.theme = theme
}
ProgressBar.prototype.setTemplate = function(template) {
this.template = template
}
ProgressBar.prototype._enableResizeEvents = function() {
process.stdout.on('resize', this._handleSizeChange)
}
ProgressBar.prototype._disableResizeEvents = function() {
process.stdout.removeListener('resize', this._handleSizeChange)
}
ProgressBar.prototype.disable = function() {
this.hide()
this.disabled = true
}
ProgressBar.prototype.enable = function() {
this.disabled = false
this.show()
}
ProgressBar.prototype.hide = function() {
if (!isTTY()) return
if (this.disabled) return
this.cursor.show()
if (this.showing) this.cursor.up(1)
this.cursor.horizontalAbsolute(0).eraseLine()
this.showing = false
}
var repeat = function (str, count) {
var out = ""
for (var ii=0; ii<count; ++ii) out += str
return out
}
ProgressBar.prototype.pulse = function(name) {
++ this.spun
if (! this.showing) return
if (this.disabled) return
var baseName = this.lastName
name = name
? ( baseName
? baseName + " " + this.theme.subsection + " " + name
: null )
: baseName
this.show(name)
this.lastName = baseName
}
ProgressBar.prototype.show = function(name, completed) {
name = this.lastName = name || this.lastName
completed = this.lastCompleted = completed || this.lastCompleted
if (!isTTY()) return
if (this.disabled) return
if (! this.spun && ! completed) return
if (this.tryAgain) {
clearTimeout(this.tryAgain)
this.tryAgain = null
}
var self = this
if (this.showing && new Date() - this.last < this.updatefreq) {
this.tryAgain = setTimeout(function () {
if (self.disabled) return
if (! self.spun && ! completed) return
drawBar()
}, this.updatefreq - (new Date() - this.last))
return
}
return drawBar()
function drawBar() {
var values = {
name: name,
spinner: self.spun,
completed: completed
}
self.last = new Date()
var statusline = self.renderTemplate(self.theme, self.template, values)
if (self.showing) self.cursor.up(1)
self.cursor
.hide()
.horizontalAbsolute(0)
.write(statusline.substr(0, getWritableTTYColumns()) + "\n")
.show()
self.showing = true
}
}
ProgressBar.prototype.renderTemplate = function (theme, template, values) {
values.startgroup = theme.startgroup
values.endgroup = theme.endgroup
values.spinner = values.spinner
? theme.spinner.substr(values.spinner % theme.spinner.length,1)
: ""
var output = {prebar: "", postbar: ""}
var status = "prebar"
var self = this
template.forEach(function(T) {
if (typeof T === "string") {
output[status] += T
return
}
if (T.type === "completionbar") {
status = "postbar"
return
}
if (!values.hasOwnProperty(T.type)) throw new Error("Unknown template value '"+T.type+"'")
var value = self.renderValue(T, values[T.type])
if (value === "") return
var sofar = output[status].length
var lastChar = sofar ? output[status][sofar-1] : null
if (T.separated && sofar && lastChar !== " ") {
output[status] += " "
}
output[status] += value
if (T.separated) output[status] += " "
})
var bar = ""
if (status === "postbar") {
var nonBarLen = output.prebar.length + output.postbar.length
var barLen = getWritableTTYColumns() - nonBarLen
var sofar = Math.round(barLen * Math.max(0,Math.min(1,values.completed||0)))
var rest = barLen - sofar
bar = repeat(theme.complete, sofar)
+ repeat(theme.incomplete, rest)
}
return output.prebar + bar + output.postbar
}
ProgressBar.prototype.renderValue = function (template, value) {
if (value == null || value === "") return ""
var maxLength = template.maxLength || template.length
var minLength = template.minLength || template.length
var alignWith = align[template.align] || align.left
// if (maxLength) value = value.substr(-1 * maxLength)
if (maxLength) value = value.substr(0, maxLength)
if (minLength) value = alignWith(value, minLength)
return value
}
|
