https://github.com/basedwon/spinner

A comprehensive Node.js module providing a set of tools for creating elegant command line interfaces.
https://github.com/basedwon/spinner

cli progress-bar spinner

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/basedwon/spinner
• Owner: basedwon
• License: mit
• Created: 2023-12-03T12:03:44.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-12-05T07:56:35.000Z (over 1 year ago)
• Last Synced: 2025-04-21T16:04:12.818Z (3 months ago)
• Topics: cli, progress-bar, spinner
• Language: JavaScript
• Homepage:
• Size: 15.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Spinner

> spin'er

[![npm](https://img.shields.io/npm/v/@basd/spinner?style=flat&logo=npm)](https://www.npmjs.com/package/@basd/spinner)

[![pipeline](https://gitlab.com/frenware/utils/spinner/badges/master/pipeline.svg)](https://gitlab.com/frenware/utils/spinner/-/pipelines)

[![license](https://img.shields.io/npm/l/@basd/spinner)](https://gitlab.com/frenware/utils/spinner/-/blob/master/LICENSE)

[![downloads](https://img.shields.io/npm/dw/@basd/spinner)](https://www.npmjs.com/package/@basd/spinner) 

[![Gitlab](https://img.shields.io/badge/Gitlab%20-%20?logo=gitlab&color=%23383a40)](https://gitlab.com/frenware/utils/spinner)

[![Github](https://img.shields.io/badge/Github%20-%20?logo=github&color=%23383a40)](https://github.com/basedwon/spinner)

[![Twitter](https://img.shields.io/badge/@basdwon%20-%20?logo=twitter&color=%23383a40)](https://twitter.com/basdwon)

[![Discord](https://img.shields.io/badge/Basedwon%20-%20?logo=discord&color=%23383a40)](https://discordapp.com/users/basedwon)

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:

```bash

npm install @basd/spinner

```

## Usage

### Spinners

```js

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

```js

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](/docs/api.md)

## Tests

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

```sh

git clone https://github.com/basedwon/spinner.git

cd spinner

npm install

```

To run the tests:

```sh

npm test

```

## Contributing

Thank you! Please see our [contributing guidelines](/docs/contributing.md) 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](https://gitlab.com/frenware/utils/spinner/-/blob/master/LICENSE).