chushihua
This commit is contained in:
li
+148
@@ -0,0 +1,148 @@
|
||||
'use strict';
|
||||
const chalk = require('chalk');
|
||||
const cliCursor = require('cli-cursor');
|
||||
const cliSpinners = require('cli-spinners');
|
||||
const logSymbols = require('log-symbols');
|
||||
|
||||
class Ora {
|
||||
constructor(options) {
|
||||
if (typeof options === 'string') {
|
||||
options = {
|
||||
text: options
|
||||
};
|
||||
}
|
||||
|
||||
this.options = Object.assign({
|
||||
text: '',
|
||||
color: 'cyan',
|
||||
stream: process.stderr
|
||||
}, options);
|
||||
|
||||
const sp = this.options.spinner;
|
||||
this.spinner = typeof sp === 'object' ? sp : (process.platform === 'win32' ? cliSpinners.line : (cliSpinners[sp] || cliSpinners.dots)); // eslint-disable-line no-nested-ternary
|
||||
|
||||
if (this.spinner.frames === undefined) {
|
||||
throw new Error('Spinner must define `frames`');
|
||||
}
|
||||
|
||||
this.text = this.options.text;
|
||||
this.color = this.options.color;
|
||||
this.interval = this.options.interval || this.spinner.interval || 100;
|
||||
this.stream = this.options.stream;
|
||||
this.id = null;
|
||||
this.frameIndex = 0;
|
||||
this.enabled = typeof this.options.enabled === 'boolean' ? this.options.enabled : ((this.stream && this.stream.isTTY) && !process.env.CI);
|
||||
}
|
||||
frame() {
|
||||
const frames = this.spinner.frames;
|
||||
let frame = frames[this.frameIndex];
|
||||
|
||||
if (this.color) {
|
||||
frame = chalk[this.color](frame);
|
||||
}
|
||||
|
||||
this.frameIndex = ++this.frameIndex % frames.length;
|
||||
|
||||
return frame + ' ' + this.text;
|
||||
}
|
||||
clear() {
|
||||
if (!this.enabled) {
|
||||
return this;
|
||||
}
|
||||
|
||||
this.stream.clearLine();
|
||||
this.stream.cursorTo(0);
|
||||
|
||||
return this;
|
||||
}
|
||||
render() {
|
||||
this.clear();
|
||||
this.stream.write(this.frame());
|
||||
|
||||
return this;
|
||||
}
|
||||
start(text) {
|
||||
if (text) {
|
||||
this.text = text;
|
||||
}
|
||||
|
||||
if (!this.enabled || this.id) {
|
||||
return this;
|
||||
}
|
||||
|
||||
cliCursor.hide(this.stream);
|
||||
this.render();
|
||||
this.id = setInterval(this.render.bind(this), this.interval);
|
||||
|
||||
return this;
|
||||
}
|
||||
stop() {
|
||||
if (!this.enabled) {
|
||||
return this;
|
||||
}
|
||||
|
||||
clearInterval(this.id);
|
||||
this.id = null;
|
||||
this.frameIndex = 0;
|
||||
this.clear();
|
||||
cliCursor.show(this.stream);
|
||||
|
||||
return this;
|
||||
}
|
||||
succeed(text) {
|
||||
return this.stopAndPersist({symbol: logSymbols.success, text});
|
||||
}
|
||||
fail(text) {
|
||||
return this.stopAndPersist({symbol: logSymbols.error, text});
|
||||
}
|
||||
warn(text) {
|
||||
return this.stopAndPersist({symbol: logSymbols.warning, text});
|
||||
}
|
||||
info(text) {
|
||||
return this.stopAndPersist({symbol: logSymbols.info, text});
|
||||
}
|
||||
stopAndPersist(options) {
|
||||
if (!this.enabled) {
|
||||
return this;
|
||||
}
|
||||
|
||||
// Legacy argument
|
||||
// TODO: Deprecate sometime in the future
|
||||
if (typeof options === 'string') {
|
||||
options = {
|
||||
symbol: options
|
||||
};
|
||||
}
|
||||
|
||||
options = options || {};
|
||||
|
||||
this.stop();
|
||||
this.stream.write(`${options.symbol || ' '} ${options.text || this.text}\n`);
|
||||
|
||||
return this;
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = function (opts) {
|
||||
return new Ora(opts);
|
||||
};
|
||||
|
||||
module.exports.promise = (action, options) => {
|
||||
if (typeof action.then !== 'function') {
|
||||
throw new TypeError('Parameter `action` must be a Promise');
|
||||
}
|
||||
|
||||
const spinner = new Ora(options);
|
||||
spinner.start();
|
||||
|
||||
action.then(
|
||||
() => {
|
||||
spinner.succeed();
|
||||
},
|
||||
() => {
|
||||
spinner.fail();
|
||||
}
|
||||
);
|
||||
|
||||
return spinner;
|
||||
};
|
||||
+21
@@ -0,0 +1,21 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
+49
@@ -0,0 +1,49 @@
|
||||
{
|
||||
"name": "ora",
|
||||
"version": "1.4.0",
|
||||
"description": "Elegant terminal spinner",
|
||||
"license": "MIT",
|
||||
"repository": "sindresorhus/ora",
|
||||
"author": {
|
||||
"name": "Sindre Sorhus",
|
||||
"email": "sindresorhus@gmail.com",
|
||||
"url": "sindresorhus.com"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=4"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "xo && ava"
|
||||
},
|
||||
"files": [
|
||||
"index.js"
|
||||
],
|
||||
"keywords": [
|
||||
"cli",
|
||||
"spinner",
|
||||
"spinners",
|
||||
"terminal",
|
||||
"term",
|
||||
"console",
|
||||
"ascii",
|
||||
"unicode",
|
||||
"loading",
|
||||
"indicator",
|
||||
"progress",
|
||||
"busy",
|
||||
"wait",
|
||||
"idle"
|
||||
],
|
||||
"dependencies": {
|
||||
"chalk": "^2.1.0",
|
||||
"cli-cursor": "^2.1.0",
|
||||
"cli-spinners": "^1.0.1",
|
||||
"log-symbols": "^2.1.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"ava": "*",
|
||||
"get-stream": "^3.0.0",
|
||||
"strip-ansi": "^3.0.1",
|
||||
"xo": "*"
|
||||
}
|
||||
}
|
||||
+189
@@ -0,0 +1,189 @@
|
||||
# ora [](https://travis-ci.org/sindresorhus/ora)
|
||||
|
||||
> Elegant terminal spinner
|
||||
|
||||
<p align="center">
|
||||
<img src="https://rawgit.com/sindresorhus/ora/master/screenshot.svg" width="500">
|
||||
</p>
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
$ npm install --save ora
|
||||
```
|
||||
|
||||
*Show your support for Ora by buying this excellent [Node.js course](https://LearnNode.com/friend/AWESOME).*
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const ora = require('ora');
|
||||
|
||||
const spinner = ora('Loading unicorns').start();
|
||||
|
||||
setTimeout(() => {
|
||||
spinner.color = 'yellow';
|
||||
spinner.text = 'Loading rainbows';
|
||||
}, 1000);
|
||||
```
|
||||
|
||||
|
||||
## API
|
||||
|
||||
It will gracefully not do anything when there's no TTY or when in a CI.
|
||||
|
||||
### ora([options|text])
|
||||
|
||||
If a string is provided, it is treated as a shortcut for [`options.text`](#text).
|
||||
|
||||
#### options
|
||||
|
||||
Type: `Object`
|
||||
|
||||
##### text
|
||||
|
||||
Type: `string`
|
||||
|
||||
Text to display after the spinner.
|
||||
|
||||
##### spinner
|
||||
|
||||
Type: `string` `Object`<br>
|
||||
Default: `dots` <img src="screenshot-spinner.gif" width="14">
|
||||
|
||||
Name of one of the [provided spinners](https://github.com/sindresorhus/cli-spinners/blob/master/spinners.json). See `example.js` in this repo if you want to test out different spinners.
|
||||
|
||||
Or an object like:
|
||||
|
||||
```js
|
||||
{
|
||||
interval: 80, // optional
|
||||
frames: ['-', '+', '-']
|
||||
}
|
||||
```
|
||||
|
||||
##### color
|
||||
|
||||
Type: `string`<br>
|
||||
Default: `cyan`<br>
|
||||
Values: `black` `red` `green` `yellow` `blue` `magenta` `cyan` `white` `gray`
|
||||
|
||||
Color of the spinner.
|
||||
|
||||
##### interval
|
||||
|
||||
Type: `number`<br>
|
||||
Default: Provided by the spinner or `100`
|
||||
|
||||
Interval between each frame.
|
||||
|
||||
Spinners provide their own recommended interval, so you don't really need to specify this.
|
||||
|
||||
##### stream
|
||||
|
||||
Type: `WritableStream`<br>
|
||||
Default: `process.stderr`
|
||||
|
||||
Stream to write the output.
|
||||
|
||||
You could for example set this to `process.stdout` instead.
|
||||
|
||||
##### enabled
|
||||
|
||||
Type: `boolean`
|
||||
|
||||
Force enable/disable the spinner. If not specified, the spinner will be enabled if the `stream` is being run inside a TTY context (not spawned or piped) and/or not in a CI environment.
|
||||
|
||||
### Instance
|
||||
|
||||
#### .start([text])
|
||||
|
||||
Start the spinner. Returns the instance. Set the current text if `text` is provided.
|
||||
|
||||
#### .stop()
|
||||
|
||||
Stop and clear the spinner. Returns the instance.
|
||||
|
||||
#### .succeed([text])
|
||||
|
||||
Stop the spinner, change it to a green `✔` and persist the current text, or `text` if provided. Returns the instance. See the GIF below.
|
||||
|
||||
#### .fail([text])
|
||||
|
||||
Stop the spinner, change it to a red `✖` and persist the current text, or `text` if provided. Returns the instance. See the GIF below.
|
||||
|
||||
#### .warn([text])
|
||||
|
||||
Stop the spinner, change it to a yellow `⚠` and persist the current text, or `text` if provided. Returns the instance.
|
||||
|
||||
#### .info([text])
|
||||
|
||||
Stop the spinner, change it to a blue `ℹ` and persist the current text, or `text` if provided. Returns the instance.
|
||||
|
||||
#### .stopAndPersist([options])
|
||||
|
||||
Stop the spinner and change the symbol or text. Returns the instance. See the GIF below.
|
||||
|
||||
##### options
|
||||
|
||||
Type: `Object`
|
||||
|
||||
###### symbol
|
||||
|
||||
Type: `string`<br>
|
||||
Default: `' '`
|
||||
|
||||
Symbol to replace the spinner with.
|
||||
|
||||
###### text
|
||||
|
||||
Type: `string`<br>
|
||||
Default: Current text
|
||||
|
||||
Text to be persisted.
|
||||
|
||||
<img src="screenshot-2.gif" width="480">
|
||||
|
||||
#### .clear()
|
||||
|
||||
Clear the spinner. Returns the instance.
|
||||
|
||||
#### .render()
|
||||
|
||||
Manually render a new frame. Returns the instance.
|
||||
|
||||
#### .frame()
|
||||
|
||||
Get a new frame.
|
||||
|
||||
#### .text
|
||||
|
||||
Change the text.
|
||||
|
||||
#### .color
|
||||
|
||||
Change the spinner color.
|
||||
|
||||
### ora.promise(action, [options|text])
|
||||
|
||||
Starts a spinner for a promise. The spinner is stopped with `.succeed()` if the promise fulfills or with `.fail()` if it rejects. Returns the spinner instance.
|
||||
|
||||
#### action
|
||||
|
||||
Type: `Promise`
|
||||
|
||||
|
||||
## Related
|
||||
|
||||
- [cli-spinners](https://github.com/sindresorhus/cli-spinners) - Spinners for use in the terminal
|
||||
- [listr](https://github.com/SamVerschueren/listr) - Terminal task list
|
||||
- [CLISpinner](https://github.com/kiliankoe/CLISpinner) - Terminal spinner library for Swift
|
||||
- [halo](https://github.com/ManrajGrover/halo) - Python port
|
||||
- [spinners](https://github.com/FGRibreau/spinners) - Terminal spinners for Rust
|
||||
|
||||
|
||||
## License
|
||||
|
||||
MIT © [Sindre Sorhus](https://sindresorhus.com)
|
||||
Reference in New Issue
Block a user