{"id":18573906,"url":"https://github.com/basedwon/spinner","last_synced_at":"2025-05-15T23:34:12.920Z","repository":{"id":210695196,"uuid":"726787445","full_name":"basedwon/spinner","owner":"basedwon","description":"A comprehensive Node.js module providing a set of tools for creating elegant command line interfaces.","archived":false,"fork":false,"pushed_at":"2023-12-05T07:56:35.000Z","size":16,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-21T16:04:12.818Z","etag":null,"topics":["cli","progress-bar","spinner"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/basedwon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-03T12:03:44.000Z","updated_at":"2023-12-03T12:07:15.000Z","dependencies_parsed_at":"2023-12-04T12:56:28.758Z","dependency_job_id":"d8045c93-d4dc-4a67-a46c-9548d82fe3b1","html_url":"https://github.com/basedwon/spinner","commit_stats":null,"previous_names":["basedwon/spinner"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basedwon%2Fspinner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basedwon%2Fspinner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basedwon%2Fspinner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/basedwon%2Fspinner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/basedwon","download_url":"https://codeload.github.com/basedwon/spinner/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254442345,"owners_count":22071863,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","progress-bar","spinner"],"created_at":"2024-11-06T23:13:21.724Z","updated_at":"2025-05-15T23:34:12.865Z","avatar_url":"https://github.com/basedwon.png","language":"JavaScript","readme":"# Spinner\n\n\u003e spin'er\n\n[![npm](https://img.shields.io/npm/v/@basd/spinner?style=flat\u0026logo=npm)](https://www.npmjs.com/package/@basd/spinner)\n[![pipeline](https://gitlab.com/frenware/utils/spinner/badges/master/pipeline.svg)](https://gitlab.com/frenware/utils/spinner/-/pipelines)\n[![license](https://img.shields.io/npm/l/@basd/spinner)](https://gitlab.com/frenware/utils/spinner/-/blob/master/LICENSE)\n[![downloads](https://img.shields.io/npm/dw/@basd/spinner)](https://www.npmjs.com/package/@basd/spinner) \n\n[![Gitlab](https://img.shields.io/badge/Gitlab%20-%20?logo=gitlab\u0026color=%23383a40)](https://gitlab.com/frenware/utils/spinner)\n[![Github](https://img.shields.io/badge/Github%20-%20?logo=github\u0026color=%23383a40)](https://github.com/basedwon/spinner)\n[![Twitter](https://img.shields.io/badge/@basdwon%20-%20?logo=twitter\u0026color=%23383a40)](https://twitter.com/basdwon)\n[![Discord](https://img.shields.io/badge/Basedwon%20-%20?logo=discord\u0026color=%23383a40)](https://discordapp.com/users/basedwon)\n\nA 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.\n\n## Features\n\n- **CLI Spinners**: Utilize a variety of spinner styles for asynchronous operations.\n- **Progress Bars**: Implement customizable progress bars for tracking lengthy processes.\n- **Turn-Key Spinner**: Singleton spinner instance for the especially lazy amongst us.\n\n## Installation\n\nInstall via npm:\n\n```bash\nnpm install @basd/spinner\n```\n\n## Usage\n\n### Spinners\n\n```js\nconst { Spinner } = require('@basd/spinner')\n\nconst spinner = new Spinner({\n  id: 'unique-spinner-id', // optional\n  color: 'green', // optional\n  spinner: 'dots' // optional, spinner style\n})\n\nspinner.start('Loading...')\n// Update the spinner\nspinner.update('Still loading...')\n// Complete the spinner\nspinner.succeed('Completed!')\n```\n\n### Progress Bars\n\n```js\nconst { Progress } = require('@basd/spinner')\n\nconst progressBar = new Progress({\n  total: 100, // total value of the progress bar\n  preset: 'shades_classic' // optional, style of the progress bar\n})\n\nprogressBar.start(0)\n// Increment the progress\nprogressBar.increment(10)\n// Update the progress bar to a specific value\nprogressBar.update(50)\n// Complete the progress\nprogressBar.stop()\n```\n\n## Documentation\n\n- [API Reference](/docs/api.md)\n\n## Tests\n\nIn order to run the test suite, simply clone the repository and install its dependencies:\n\n```sh\ngit clone https://github.com/basedwon/spinner.git\ncd spinner\nnpm install\n```\n\nTo run the tests:\n\n```sh\nnpm test\n```\n\n## Contributing\n\nThank you! Please see our [contributing guidelines](/docs/contributing.md) for details.\n\n## Donations\n\nIf 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!\n\n**Bitcoin (BTC):**\n```\n1JUb1yNFH6wjGekRUW6Dfgyg4J4h6wKKdF\n```\n\n**Monero (XMR):**\n```\n46uV2fMZT3EWkBrGUgszJCcbqFqEvqrB4bZBJwsbx7yA8e2WBakXzJSUK8aqT4GoqERzbg4oKT2SiPeCgjzVH6VpSQ5y7KQ\n```\n\n## License\n\n@basd/spinner is [MIT licensed](https://gitlab.com/frenware/utils/spinner/-/blob/master/LICENSE).\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbasedwon%2Fspinner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbasedwon%2Fspinner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbasedwon%2Fspinner/lists"}