This repository was archived by the owner on Oct 6, 2025. It is now read-only.
forked from sindresorhus/ora
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest.js
More file actions
380 lines (302 loc) · 8.59 KB
/
Copy pathtest.js
File metadata and controls
380 lines (302 loc) · 8.59 KB
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
import {PassThrough as PassThroughStream} from 'stream';
import getStream from 'get-stream';
import test from 'ava';
import stripAnsi from 'strip-ansi';
import Ora from '.';
const spinnerChar = process.platform === 'win32' ? '-' : '⠋';
const noop = () => {};
const getPassThroughStream = () => {
const stream = new PassThroughStream();
stream.clearLine = noop;
stream.cursorTo = noop;
stream.moveCursor = noop;
return stream;
};
const doSpinner = async (fn, extraOptions = {}) => {
const stream = getPassThroughStream();
const output = getStream(stream);
const spinner = new Ora({
stream,
text: 'foo',
color: false,
isEnabled: true,
isSilent: false,
...extraOptions
});
spinner.start();
fn(spinner);
stream.end();
return stripAnsi(await output);
};
const macro = async (t, fn, expected, extraOptions = {}) => {
t.regex(await doSpinner(fn, extraOptions), expected);
};
test('main', macro, spinner => {
spinner.stop();
}, new RegExp(`${spinnerChar} foo`));
test('title shortcut', async t => {
const stream = getPassThroughStream();
const output = getStream(stream);
const ora = Ora;
const spinner = ora('foo');
spinner.stream = stream;
spinner.color = false;
spinner.isEnabled = true;
spinner.start();
t.true(spinner.isSpinning);
spinner.stop();
stream.end();
t.is(await output, `${spinnerChar} foo`);
});
test('`.id` is not set when created', t => {
const spinner = new Ora('foo');
t.falsy(spinner.id);
t.false(spinner.isSpinning);
});
test('ignore consecutive calls to `.start()`', t => {
const spinner = new Ora('foo');
spinner.start();
const {id} = spinner;
spinner.start();
t.is(id, spinner.id);
});
test('chain call to `.start()` with constructor', t => {
const spinner = new Ora({
stream: getPassThroughStream(),
text: 'foo',
isEnabled: true
}).start();
t.truthy(spinner.id);
t.true(spinner.isEnabled);
});
test('.succeed()', macro, spinner => {
spinner.succeed();
}, /(?:✔|√) foo\n$/);
test('.succeed() - with new text', macro, spinner => {
spinner.succeed('fooed');
}, /(?:✔|√) fooed\n$/);
test('.fail()', macro, spinner => {
spinner.fail();
}, /(?:✖|×) foo\n$/);
test('.fail() - with new text', macro, spinner => {
spinner.fail('failed to foo');
}, /(?:✖|×) failed to foo\n$/);
test('.warn()', macro, spinner => {
spinner.warn();
}, /(?:⚠|‼) foo\n$/);
test('.info()', macro, spinner => {
spinner.info();
}, /(?:ℹ|i) foo\n$/);
test('.stopAndPersist() - with new text', macro, spinner => {
spinner.stopAndPersist({text: 'all done'});
}, /\s all done\n$/);
test('.stopAndPersist() - with new symbol and text', macro, spinner => {
spinner.stopAndPersist({symbol: '@', text: 'all done'});
}, /@ all done\n$/);
test('.start(text)', macro, spinner => {
spinner.start('Test text');
spinner.stopAndPersist();
}, /Test text\n$/);
test('.start() - isEnabled:false outputs text', macro, spinner => {
spinner.stop();
}, /- foo\n$/, {isEnabled: false});
test('.stopAndPersist() - isEnabled:false outputs text', macro, spinner => {
spinner.stopAndPersist({symbol: '@', text: 'all done'});
}, /- foo\n@ all done\n$/, {isEnabled: false});
test('.start() - isSilent:true no output', macro, spinner => {
spinner.stop();
}, /^(?![\s\S])/, {isSilent: true});
test('.stopAndPersist() - isSilent:true no output', macro, spinner => {
spinner.stopAndPersist({symbol: '@', text: 'all done'});
}, /^(?![\s\S])/, {isSilent: true});
test('.stopAndPersist() - isSilent:true can be disabled', macro, spinner => {
spinner.isSilent = false;
spinner.stopAndPersist({symbol: '@', text: 'all done'});
}, /@ all done\n$/, {isSilent: true});
test('.promise() - resolves', async t => {
const stream = getPassThroughStream();
const output = getStream(stream);
const resolves = Promise.resolve(1);
Ora.promise(resolves, {
stream,
text: 'foo',
color: false,
isEnabled: true
});
await resolves;
stream.end();
t.regex(stripAnsi(await output), /(?:✔|√) foo\n$/);
});
test('.promise() - rejects', async t => {
const stream = getPassThroughStream();
const output = getStream(stream);
const rejects = Promise.reject(new Error());
Ora.promise(rejects, {
stream,
text: 'foo',
color: false,
isEnabled: true
});
try {
await rejects;
} catch (_) {}
stream.end();
t.regex(stripAnsi(await output), /(?:✖|×) foo\n$/);
});
test('erases wrapped lines', t => {
const stream = getPassThroughStream();
stream.isTTY = true;
stream.columns = 40;
let clearedLines = 0;
let cursorAtRow = 0;
stream.clearLine = () => {
clearedLines++;
};
stream.moveCursor = (dx, dy) => {
cursorAtRow += dy;
};
const reset = () => {
clearedLines = 0;
cursorAtRow = 0;
};
const spinner = new Ora({
stream,
text: 'foo',
color: false,
isEnabled: true
});
spinner.render();
t.is(clearedLines, 0);
t.is(cursorAtRow, 0);
spinner.text = 'foo\n\nbar';
spinner.render();
t.is(clearedLines, 1); // Cleared 'foo'
t.is(cursorAtRow, 0);
spinner.render();
t.is(clearedLines, 4); // Cleared 'foo\n\nbar'
t.is(cursorAtRow, -2);
spinner.clear();
reset();
spinner.text = '0'.repeat(stream.columns + 10);
spinner.render();
spinner.render();
t.is(clearedLines, 2);
t.is(cursorAtRow, -1);
spinner.clear();
reset();
// Unicorns take up two cells, so this creates 3 rows of text not two
spinner.text = '🦄'.repeat(stream.columns + 10);
spinner.render();
spinner.render();
t.is(clearedLines, 3);
t.is(cursorAtRow, -2);
spinner.clear();
reset();
// Unicorns take up two cells. Remove the spinner and space and fill two rows,
// then force a linebreak and write the third row.
spinner.text = '🦄'.repeat(stream.columns - 2) + '\nfoo';
spinner.render();
spinner.render();
t.is(clearedLines, 3);
t.is(cursorAtRow, -2);
spinner.clear();
reset();
spinner.prefixText = 'foo\n';
spinner.text = '\nbar';
spinner.render();
spinner.render();
t.is(clearedLines, 3); // Cleared 'foo\n\nbar'
t.is(cursorAtRow, -2);
spinner.stop();
});
test('reset frameIndex when setting new spinner', async t => {
const stream = getPassThroughStream();
const output = getStream(stream);
const spinner = new Ora({
stream,
isEnabled: true,
spinner: {frames: ['foo', 'fooo']}
});
spinner.render();
t.is(spinner.frameIndex, 1);
spinner.spinner = {frames: ['baz']};
spinner.render();
stream.end();
t.is(spinner.frameIndex, 0);
t.regex(stripAnsi(await output), /foo baz/);
});
test('set the correct interval when changing spinner (object case)', t => {
const spinner = new Ora({
isEnabled: false,
spinner: {frames: ['foo', 'bar']},
interval: 300
});
t.is(spinner.interval, 300);
spinner.spinner = {frames: ['baz'], interval: 200};
t.is(spinner.interval, 200);
});
test('set the correct interval when changing spinner (string case)', t => {
const spinner = new Ora({
isEnabled: false,
spinner: 'dots',
interval: 100
});
t.is(spinner.interval, 100);
spinner.spinner = 'layer';
const expectedInterval = process.platform === 'win32' ? 130 : 150;
t.is(spinner.interval, expectedInterval);
});
if (process.platform !== 'win32') {
test('throw when incorrect spinner', t => {
const ora = new Ora();
t.throws(() => {
ora.spinner = 'random-string-12345';
}, /no built-in spinner/);
});
}
test('indent option', t => {
const stream = getPassThroughStream();
stream.isTTY = true;
let cursorAtRow = 0;
stream.cursorTo = indent => {
cursorAtRow = indent;
};
const spinner = new Ora({
stream,
text: 'foo',
color: false,
isEnabled: true,
indent: 7
});
spinner.render();
spinner.clear();
t.is(cursorAtRow, 7);
spinner.stop();
});
test('indent option throws', t => {
const stream = getPassThroughStream();
const spinner = new Ora({
stream,
text: 'foo',
color: false,
isEnabled: true
});
t.throws(() => {
spinner.indent = -1;
}, 'The `indent` option must be an integer from 0 and up');
});
test('.stopAndPersist() with prefixText', macro, spinner => {
spinner.stopAndPersist({symbol: '@', text: 'foo'});
}, /bar @ foo\n$/, {prefixText: 'bar'});
test('.stopAndPersist() with empty prefixText', macro, spinner => {
spinner.stopAndPersist({symbol: '@', text: 'foo'});
}, /@ foo\n$/, {prefixText: ''});
test('.stopAndPersist() with manual prefixText', macro, spinner => {
spinner.stopAndPersist({symbol: '@', prefixText: 'baz', text: 'foo'});
}, /baz @ foo\n$/, {prefixText: 'bar'});
test('.stopAndPersist() with manual empty prefixText', macro, spinner => {
spinner.stopAndPersist({symbol: '@', prefixText: '', text: 'foo'});
}, /@ foo\n$/, {prefixText: 'bar'});
test('.stopAndPersist() with dynamic prefixText', macro, spinner => {
spinner.stopAndPersist({symbol: '&', prefixText: () => 'babeee', text: 'yorkie'});
}, /babeee & yorkie\n$/, {prefixText: () => 'babeee'});