diff options
Diffstat (limited to 'node_modules/ora')
| -rw-r--r-- | node_modules/ora/index.d.ts | 257 | ||||
| -rw-r--r-- | node_modules/ora/index.js | 246 | ||||
| -rw-r--r-- | node_modules/ora/license | 9 | ||||
| -rw-r--r-- | node_modules/ora/package.json | 53 | ||||
| -rw-r--r-- | node_modules/ora/readme.md | 239 |
5 files changed, 804 insertions, 0 deletions
diff --git a/node_modules/ora/index.d.ts b/node_modules/ora/index.d.ts new file mode 100644 index 0000000..e1d4f18 --- /dev/null +++ b/node_modules/ora/index.d.ts @@ -0,0 +1,257 @@ +/// <reference types="node"/> +import {SpinnerName} from 'cli-spinners'; + +declare namespace ora { + interface Spinner { + readonly interval?: number; + readonly frames: string[]; + } + + type Color = + | 'black' + | 'red' + | 'green' + | 'yellow' + | 'blue' + | 'magenta' + | 'cyan' + | 'white' + | 'gray'; + + interface Options { + /** + Text to display after the spinner. + */ + readonly text?: string; + + /** + Text to display before the spinner. + */ + readonly prefixText?: string; + + /** + Name of one of the provided spinners. See [`example.js`](https://github.com/BendingBender/ora/blob/master/example.js) in this repo if you want to test out different spinners. On Windows, it will always use the line spinner as the Windows command-line doesn't have proper Unicode support. + + @default 'dots' + + Or an object like: + + @example + ``` + { + interval: 80, // Optional + frames: ['-', '+', '-'] + } + ``` + */ + readonly spinner?: SpinnerName | Spinner; + + /** + Color of the spinner. + + @default 'cyan' + */ + readonly color?: Color; + + /** + Set to `false` to stop Ora from hiding the cursor. + + @default true + */ + readonly hideCursor?: boolean; + + /** + Indent the spinner with the given number of spaces. + + @default 0 + */ + readonly indent?: number; + + /** + Interval between each frame. + + Spinners provide their own recommended interval, so you don't really need to specify this. Default value: Provided by the spinner or `100`. + */ + readonly interval?: number; + + /** + Stream to write the output. + + You could for example set this to `process.stdout` instead. + + @default process.stderr + */ + readonly stream?: NodeJS.WritableStream; + + /** + 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. + + Note that `{isEnabled: false}` doesn't mean it won't output anything. It just means it won't output the spinner, colors, and other ansi escape codes. It will still log text. + */ + readonly isEnabled?: boolean; + } + + interface PersistOptions { + /** + Symbol to replace the spinner with. + + @default ' ' + */ + readonly symbol?: string; + + /** + Text to be persisted after the symbol. Default: Current `text`. + */ + readonly text?: string; + + /** + Text to be persisted before the symbol. Default: Current `prefixText`. + */ + readonly prefixText?: string; + } + + interface Ora { + /** + A boolean of whether the instance is currently spinning. + */ + readonly isSpinning: boolean; + + /** + Change the text after the spinner. + */ + text: string; + + /** + Change the text before the spinner. + */ + prefixText: string; + + /** + Change the spinner color. + */ + color: Color; + + /** + Change the spinner. + */ + spinner: SpinnerName | Spinner; + + /** + Change the spinner indent. + */ + indent: number; + + /** + Start the spinner. + + @param text - Set the current text. + @returns The spinner instance. + */ + start(text?: string): Ora; + + /** + Stop and clear the spinner. + + @returns The spinner instance. + */ + stop(): Ora; + + /** + Stop the spinner, change it to a green `✔` and persist the current text, or `text` if provided. + + @param text - Will persist text if provided. + @returns The spinner instance. + */ + succeed(text?: string): Ora; + + /** + Stop the spinner, change it to a red `✖` and persist the current text, or `text` if provided. + + @param text - Will persist text if provided. + @returns The spinner instance. + */ + fail(text?: string): Ora; + + /** + Stop the spinner, change it to a yellow `⚠` and persist the current text, or `text` if provided. + + @param text - Will persist text if provided. + @returns The spinner instance. + */ + warn(text?: string): Ora; + + /** + Stop the spinner, change it to a blue `ℹ` and persist the current text, or `text` if provided. + + @param text - Will persist text if provided. + @returns The spinner instance. + */ + info(text?: string): Ora; + + /** + Stop the spinner and change the symbol or text. + + @returns The spinner instance. + */ + stopAndPersist(options?: PersistOptions): Ora; + + /** + Clear the spinner. + + @returns The spinner instance. + */ + clear(): Ora; + + /** + Manually render a new frame. + + @returns The spinner instance. + */ + render(): Ora; + + /** + Get a new frame. + + @returns The spinner instance. + */ + frame(): Ora; + } +} + +declare const ora: { + /** + Elegant terminal spinner. + + @param options - If a string is provided, it is treated as a shortcut for `options.text`. + + @example + ``` + import ora = require('ora'); + + const spinner = ora('Loading unicorns').start(); + + setTimeout(() => { + spinner.color = 'yellow'; + spinner.text = 'Loading rainbows'; + }, 1000); + ``` + */ + (options?: ora.Options | string): ora.Ora; + + /** + Starts a spinner for a promise. The spinner is stopped with `.succeed()` if the promise fulfills or with `.fail()` if it rejects. + + @param action - The promise to start the spinner for. + @param options - If a string is provided, it is treated as a shortcut for `options.text`. + @returns The spinner instance. + */ + promise( + action: PromiseLike<unknown>, + options?: ora.Options | string + ): ora.Ora; + + // TODO: Remove this for the next major release + default: typeof ora; +}; + +export = ora; diff --git a/node_modules/ora/index.js b/node_modules/ora/index.js new file mode 100644 index 0000000..028db28 --- /dev/null +++ b/node_modules/ora/index.js @@ -0,0 +1,246 @@ +'use strict'; +const chalk = require('chalk'); +const cliCursor = require('cli-cursor'); +const cliSpinners = require('cli-spinners'); +const logSymbols = require('log-symbols'); +const stripAnsi = require('strip-ansi'); +const wcwidth = require('wcwidth'); + +const TEXT = Symbol('text'); +const PREFIX_TEXT = Symbol('prefixText'); + +class Ora { + constructor(options) { + if (typeof options === 'string') { + options = { + text: options + }; + } + + this.options = Object.assign({ + text: '', + color: 'cyan', + stream: process.stderr + }, options); + + this.spinner = this.options.spinner; + + this.color = this.options.color; + this.hideCursor = this.options.hideCursor !== false; + this.interval = this.options.interval || this.spinner.interval || 100; + this.stream = this.options.stream; + this.id = null; + this.isEnabled = typeof this.options.isEnabled === 'boolean' ? this.options.isEnabled : ((this.stream && this.stream.isTTY) && !process.env.CI); + + // Set *after* `this.stream` + this.text = this.options.text; + this.prefixText = this.options.prefixText; + this.linesToClear = 0; + this.indent = this.options.indent; + } + + get indent() { + return this._indent; + } + + set indent(indent = 0) { + if (!(indent >= 0 && Number.isInteger(indent))) { + throw new Error('The `indent` option must be an integer from 0 and up'); + } + + this._indent = indent; + } + + get spinner() { + return this._spinner; + } + + set spinner(spinner) { + this.frameIndex = 0; + + if (typeof spinner === 'object') { + if (spinner.frames === undefined) { + throw new Error('The given spinner must have a `frames` property'); + } + + this._spinner = spinner; + } else if (process.platform === 'win32') { + this._spinner = cliSpinners.line; + } else if (spinner === undefined) { + // Set default spinner + this._spinner = cliSpinners.dots; + } else if (cliSpinners[spinner]) { + this._spinner = cliSpinners[spinner]; + } else { + throw new Error(`There is no built-in spinner named '${spinner}'. See https://github.com/sindresorhus/cli-spinners/blob/master/spinners.json for a full list.`); + } + } + + get text() { + return this[TEXT]; + } + + get prefixText() { + return this[PREFIX_TEXT]; + } + + get isSpinning() { + return this.id !== null; + } + + updateLineCount() { + const columns = this.stream.columns || 80; + const fullPrefixText = (typeof this[PREFIX_TEXT] === 'string') ? this[PREFIX_TEXT] + '-' : ''; + this.lineCount = stripAnsi(fullPrefixText + '--' + this[TEXT]).split('\n').reduce((count, line) => { + return count + Math.max(1, Math.ceil(wcwidth(line) / columns)); + }, 0); + } + + set text(value) { + this[TEXT] = value; + this.updateLineCount(); + } + + set prefixText(value) { + this[PREFIX_TEXT] = value; + this.updateLineCount(); + } + + frame() { + const {frames} = this.spinner; + let frame = frames[this.frameIndex]; + + if (this.color) { + frame = chalk[this.color](frame); + } + + this.frameIndex = ++this.frameIndex % frames.length; + const fullPrefixText = typeof this.prefixText === 'string' ? this.prefixText + ' ' : ''; + const fullText = typeof this.text === 'string' ? ' ' + this.text : ''; + + return fullPrefixText + frame + fullText; + } + + clear() { + if (!this.isEnabled || !this.stream.isTTY) { + return this; + } + + for (let i = 0; i < this.linesToClear; i++) { + if (i > 0) { + this.stream.moveCursor(0, -1); + } + + this.stream.clearLine(); + this.stream.cursorTo(this.indent); + } + + this.linesToClear = 0; + + return this; + } + + render() { + this.clear(); + this.stream.write(this.frame()); + this.linesToClear = this.lineCount; + + return this; + } + + start(text) { + if (text) { + this.text = text; + } + + if (!this.isEnabled) { + this.stream.write(`- ${this.text}\n`); + return this; + } + + if (this.isSpinning) { + return this; + } + + if (this.hideCursor) { + cliCursor.hide(this.stream); + } + + this.render(); + this.id = setInterval(this.render.bind(this), this.interval); + + return this; + } + + stop() { + if (!this.isEnabled) { + return this; + } + + clearInterval(this.id); + this.id = null; + this.frameIndex = 0; + this.clear(); + if (this.hideCursor) { + 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 = {}) { + const prefixText = options.prefixText || this.prefixText; + const fullPrefixText = (typeof prefixText === 'string') ? prefixText + ' ' : ''; + const text = options.text || this.text; + const fullText = (typeof text === 'string') ? ' ' + text : ''; + + this.stop(); + this.stream.write(`${fullPrefixText}${options.symbol || ' '}${fullText}\n`); + + return this; + } +} + +const oraFactory = function (opts) { + return new Ora(opts); +}; + +module.exports = oraFactory; +// TODO: Remove this for the next major release +module.exports.default = oraFactory; + +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; +}; diff --git a/node_modules/ora/license b/node_modules/ora/license new file mode 100644 index 0000000..e7af2f7 --- /dev/null +++ b/node_modules/ora/license @@ -0,0 +1,9 @@ +MIT License + +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. diff --git a/node_modules/ora/package.json b/node_modules/ora/package.json new file mode 100644 index 0000000..befdf05 --- /dev/null +++ b/node_modules/ora/package.json @@ -0,0 +1,53 @@ +{ + "name": "ora", + "version": "3.4.0", + "description": "Elegant terminal spinner", + "license": "MIT", + "repository": "sindresorhus/ora", + "author": { + "name": "Sindre Sorhus", + "email": "sindresorhus@gmail.com", + "url": "sindresorhus.com" + }, + "engines": { + "node": ">=6" + }, + "scripts": { + "test": "xo && ava && tsd" + }, + "files": [ + "index.js", + "index.d.ts" + ], + "keywords": [ + "cli", + "spinner", + "spinners", + "terminal", + "term", + "console", + "ascii", + "unicode", + "loading", + "indicator", + "progress", + "busy", + "wait", + "idle" + ], + "dependencies": { + "chalk": "^2.4.2", + "cli-cursor": "^2.1.0", + "cli-spinners": "^2.0.0", + "log-symbols": "^2.2.0", + "strip-ansi": "^5.2.0", + "wcwidth": "^1.0.1" + }, + "devDependencies": { + "@types/node": "^11.13.0", + "ava": "^1.4.1", + "get-stream": "^4.1.0", + "tsd": "^0.7.2", + "xo": "^0.24.0" + } +} diff --git a/node_modules/ora/readme.md b/node_modules/ora/readme.md new file mode 100644 index 0000000..154b112 --- /dev/null +++ b/node_modules/ora/readme.md @@ -0,0 +1,239 @@ +# ora [](https://travis-ci.org/sindresorhus/ora) + +> Elegant terminal spinner + +<p align="center"> + <br> + <img src="screenshot.svg" width="500"> + <br> +</p> + + +## Install + +``` +$ npm install ora +``` + +<a href="https://www.patreon.com/sindresorhus"> + <img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160"> +</a> + + +## Usage + +```js +const ora = require('ora'); + +const spinner = ora('Loading unicorns').start(); + +setTimeout(() => { + spinner.color = 'yellow'; + spinner.text = 'Loading rainbows'; +}, 1000); +``` + + +## API + +### 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. + +##### prefixText + +Type: `string` + +Text to display before 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. On Windows, it will always use the `line` spinner as the Windows command-line doesn't have proper Unicode support. + +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. + +##### hideCursor + +Type: `boolean`<br> +Default: `true` + +Set to `false` to stop Ora from hiding the cursor. + +##### indent + +Type: `number`<br> +Default: `0` + +Indent the spinner with the given number of spaces. + +##### 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: `stream.Writable`<br> +Default: `process.stderr` + +Stream to write the output. + +You could for example set this to `process.stdout` instead. + +##### isEnabled + +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. + +Note that `{isEnabled: false}` doesn't mean it won't output anything. It just means it won't output the spinner, colors, and other ansi escape codes. It will still log text. + +### 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. + +#### .isSpinning + +A boolean of whether the instance is currently spinning. + +#### .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 after the symbol + +###### prefixText + +Type: `string`<br> +Default: Current `prefixText` + +Text to be persisted before the symbol. + +<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 after the spinner. + +#### .prefixText + +Change the text before the spinner. + +#### .color + +Change the spinner color. + +#### .spinner + +Change the spinner. + +#### .indent + +Change the spinner indent. + +### 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 +- [marquee-ora](https://github.com/joeycozza/marquee-ora) - Scrolling marquee spinner for Ora +- [briandowns/spinner](https://github.com/briandowns/spinner) - Terminal spinner/progress indicator for Go +- [tj/go-spin](https://github.com/tj/go-spin) - Terminal spinner package for Go + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) |