Package Health Score

88 / 100

security
No known security issues
popularity
Key ecosystem project
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
8.1.1	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
8.0.1	\|	12/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
7.0.1	\|	08/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.3.1	\|	05/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.4.1	\|	06/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Key ecosystem project

Weekly Downloads (24,077,744)

GitHub Stars: 9.19K
Forks: 271
Contributors: 50

Direct Usage Popularity

The npm package ora receives a total of 24,077,744 downloads a week. As such, we scored ora popularity level to be Key ecosystem project.

Based on project statistics from the GitHub repository for the npm package ora, we found that it has been starred 9,192 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 50
Funding: Yes

With more than 10 contributors for the ora repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 20
Open PR: 1
Last Release: 2 months ago
Last Commit: 2 months ago

Further analysis of the maintenance status of ora based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that ora demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=18

Age: 9 years
Dependencies: 9 Direct
Versions: 51
Install Size: 27.5 kB
Dist-tags: 1
# of Files: 5
Maintainers: 1
TS Typings: No

ora has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use ora?

To help you get started, we've collected the most common ways that ora is being used within popular public projects.

electron / electron-docs-linter / cli.js View on Github

// docsPath is required
if (!docsPath) usage('specify a pathname, .e.g ~/my/electron/electron')

// docsPath is relative to current working directory
docsPath = path.join(process.cwd(), docsPath)

// outfile is relative to current working directory
if (outfile) outfile = path.join(process.cwd(), outfile)

// version is required if writing to a file
if (outfile && !version) usage('`version` is required if `outfile` is specified')

// Use a placeholder version if not writing to a file
if (!version) version = '0.0.0'

const spinner = require('ora')('Parsing electron documentation').start()

lint(docsPath, version).then(function (apis) {
  spinner.stop().clear()

  apis.forEach(api => console.error(api.report()))

  if (apis.some(api => !api.valid)) process.exit(1)

  if (outfile) {
    fs.writeFileSync(outfile, JSON.stringify(apis, null, 2))
    console.log(dedent`
      Created ${path.relative(process.cwd(), outfile)}
    `)
  } else {
    console.log(dedent`
      Docs are good to go!\n

View more ways to use ora

ora

> Elegant terminal spinner

Install

npm install ora

Check out yocto-spinner for a smaller alternative.

Usage

import ora from 'ora';

const spinner = ora('Loading unicorns').start();

setTimeout(() =&gt; {
	spinner.color = 'yellow';
	spinner.text = 'Loading rainbows';
}, 1000);

API

ora(text)

ora(options)

If a string is provided, it is treated as a shortcut for options.text.

options

Type: object

text

Type: string

The text to display next to the spinner.

prefixText

Type: string | () => string

Text or a function that returns text to display before the spinner. No prefix text will be displayed if set to an empty string.

suffixText

Type: string | () => string

Text or a function that returns text to display after the spinner text. No suffix text will be displayed if set to an empty string.

spinner

Type: string | object
Default: 'dots'

The name of one of the provided spinners. See example.js in this repo if you want to test out different spinners. On Windows (except for Windows Terminal), it will always use the line spinner as the Windows command-line doesn't have proper Unicode support.

Or an object like:

{
	frames: ['-', '+', '-'],
	interval: 80 // Optional
}

color

The color of the spinner.

hideCursor

Type: boolean
Default: true

Set to false to stop Ora from hiding the cursor.

indent

Type: number
Default: 0

Indent the spinner with the given number of spaces.

interval

Type: number
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
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.

isSilent

Type: boolean
Default: false

Disable the spinner and all log text. All output is suppressed and isEnabled will be considered false.

discardStdin

Type: boolean
Default: true

Discard stdin input (except Ctrl+C) while running if it's TTY. This prevents the spinner from twitching on input, outputting broken lines on Enter key presses, and prevents buffering of input while the spinner is running.

This has no effect on Windows as there is no good way to implement discarding stdin properly there.

Instance

.text ^get/set

Change the text displayed after the spinner.

.prefixText ^get/set

Change the text before the spinner.

No prefix text will be displayed if set to an empty string.

.suffixText ^get/set

Change the text after the spinner text.

No suffix text will be displayed if set to an empty string.

.color ^get/set

Change the spinner color.

.spinner ^get/set

Change the spinner.

.indent ^get/set

Change the spinner indent.

.isSpinning ^get

A boolean indicating whether the instance is currently spinning.

.interval ^get

The interval between each frame.

The interval is decided by the chosen spinner.

.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
Default: ' '

Symbol to replace the spinner with.

text

Type: string
Default: Current 'text'

Text to be persisted after the symbol.

prefixText

Type: string | () => string
Default: Current prefixText

Text or a function that returns text to be persisted before the symbol. No prefix text will be displayed if set to an empty string.

suffixText

Type: string | () => string
Default: Current suffixText

Text or a function that returns text to be persisted after the text after the symbol. No suffix text will be displayed if set to an empty string.

.clear()

Clear the spinner. Returns the instance.

.render()

Manually render a new frame. Returns the instance.

.frame()

Get a new frame.

oraPromise(action, text)

oraPromise(action, options)

Starts a spinner for a promise or promise-returning function. The spinner is stopped with .succeed() if the promise fulfills or with .fail() if it rejects. Returns the promise.

import {oraPromise} from 'ora';

await oraPromise(somePromise);

action

Type: Promise | ((spinner: ora.Ora) => Promise)

options

Type: object

All of the options plus the following:

successText

Type: string | ((result: T) => string) | undefined

The new text of the spinner when the promise is resolved.

Keeps the existing text if undefined.

failText

Type: string | ((error: Error) => string) | undefined

The new text of the spinner when the promise is rejected.

Keeps the existing text if undefined.

spinners

Type: Record

All provided spinners.

FAQ

How do I change the color of the text?

Use chalk or yoctocolors:

import ora from 'ora';
import chalk from 'chalk';

const spinner = ora(`Loading ${chalk.red('unicorns')}`).start();

Why does the spinner freeze?

JavaScript is single-threaded, so any synchronous operations will block the spinner's animation. To avoid this, prefer using asynchronous operations.

yocto-spinner - Tiny terminal spinner
cli-spinners - Spinners for use in the terminal

Ports

CLISpinner - Terminal spinner library for Swift
halo - Python port
spinners - Terminal spinners for Rust
marquee-ora - Scrolling marquee spinner for Ora
briandowns/spinner - Terminal spinner/progress indicator for Go
tj/go-spin - Terminal spinner package for Go
observablehq.com/@victordidenko/ora - Ora port to Observable notebooks
kia - Simple terminal spinners for Deno 🦕

ora dependencies

chalk cli-cursor cli-spinners is-interactive is-unicode-supported log-symbols stdin-discarder string-width strip-ansi

ora development dependencies

@types/node ava get-stream transform-tty tsd xo

FAQs

What is ora?

Elegant terminal spinner. Visit Snyk Advisor to see a full health score report for ora, including popularity, security, maintenance & community analysis.

Is ora popular?

The npm package ora receives a total of 24,077,744 weekly downloads. As such, ora popularity was classified as a key ecosystem project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is ora well maintained?

We found that ora demonstrated a healthy version release cadence and project activity. It has a community of 50 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is ora safe to use?

The npm package ora was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 December-2024, at 02:01 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (24,077,744)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use ora?

ora

Install

Usage

API

ora(text)

ora(options)

options

text

prefixText

suffixText

spinner

color

hideCursor

indent

interval

stream

isEnabled

isSilent

discardStdin

Instance

.text get/set

.prefixText get/set

.suffixText get/set

.color get/set

.spinner get/set

.indent get/set

.isSpinning get

.interval get

.start(text?)

.stop()

.succeed(text?)

.fail(text?)

.warn(text?)

.info(text?)

.stopAndPersist(options?)

options

symbol

text

prefixText

suffixText

.clear()

.render()

.frame()

oraPromise(action, text)

oraPromise(action, options)

action

options

successText

failText

spinners

FAQ

How do I change the color of the text?

Why does the spinner freeze?

Related

ora dependencies

ora development dependencies

FAQs

What is ora?

Is ora popular?

Is ora well maintained?

Is ora safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

.text ^get/set

.prefixText ^get/set

.suffixText ^get/set

.color ^get/set

.spinner ^get/set

.indent ^get/set

.isSpinning ^get

.interval ^get