basedwon / spinner

A comprehensive Node.js module providing a set of tools for creating elegant command line interfaces.

Spinner

spin'er

A single module for all your spinner and progress bar needs. Get spin'n right away with the pre-configured spinner instance or customize to your hearts content. This package includes features for CLI spinners and progress bars, designed to enhance the user experience of your command-line applications.

Features

• CLI Spinners: Utilize a variety of spinner styles for asynchronous operations.
• Progress Bars: Implement customizable progress bars for tracking lengthy processes.
• Turn-Key Spinner: Singleton spinner instance for the especially lazy amongst us.

Installation

Install via npm:

npm install @basd/spinner

Usage

Spinners

const { Spinner } = require('@basd/spinner')

const spinner = new Spinner({
  id: 'unique-spinner-id', // optional
  color: 'green', // optional
  spinner: 'dots' // optional, spinner style
})

spinner.start('Loading...')
// Update the spinner
spinner.update('Still loading...')
// Complete the spinner
spinner.succeed('Completed!')

Progress Bars

const { Progress } = require('@basd/spinner')

const progressBar = new Progress({
  total: 100, // total value of the progress bar
  preset: 'shades_classic' // optional, style of the progress bar
})

progressBar.start(0)
// Increment the progress
progressBar.increment(10)
// Update the progress bar to a specific value
progressBar.update(50)
// Complete the progress
progressBar.stop()

Documentation

• API Reference

Tests

In order to run the test suite, simply clone the repository and install its dependencies:

git clone https://github.com/basedwon/spinner.git
cd spinner
npm install

To run the tests:

npm test

Contributing

Thank you! Please see our contributing guidelines for details.

Donations

If you find this project useful and want to help support further development, please send us some coin. We greatly appreciate any and all contributions. Thank you!

Bitcoin (BTC):

1JUb1yNFH6wjGekRUW6Dfgyg4J4h6wKKdF

Monero (XMR):

46uV2fMZT3EWkBrGUgszJCcbqFqEvqrB4bZBJwsbx7yA8e2WBakXzJSUK8aqT4GoqERzbg4oKT2SiPeCgjzVH6VpSQ5y7KQ

License

@basd/spinner is MIT licensed.