{"id":17625124,"url":"https://github.com/derrickpelletier/node-status","last_synced_at":"2025-08-22T05:36:14.541Z","repository":{"id":8184530,"uuid":"9611151","full_name":"derrickpelletier/node-status","owner":"derrickpelletier","description":"Nodejs stdout status and progress bar. Multi-item, various display types.","archived":false,"fork":false,"pushed_at":"2016-08-23T20:25:38.000Z","size":105,"stargazers_count":75,"open_issues_count":6,"forks_count":11,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-08-09T12:26:08.336Z","etag":null,"topics":["nodejs","progress","progress-bar","status","stdout"],"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/derrickpelletier.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-04-22T23:31:50.000Z","updated_at":"2023-02-19T09:48:13.000Z","dependencies_parsed_at":"2022-08-06T21:00:32.280Z","dependency_job_id":null,"html_url":"https://github.com/derrickpelletier/node-status","commit_stats":{"total_commits":116,"total_committers":5,"mean_commits":23.2,"dds":0.07758620689655171,"last_synced_commit":"ce46b6ece73eb68df09c20eaaeee5ccd67ee38ef"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/derrickpelletier/node-status","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derrickpelletier%2Fnode-status","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derrickpelletier%2Fnode-status/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derrickpelletier%2Fnode-status/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derrickpelletier%2Fnode-status/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/derrickpelletier","download_url":"https://codeload.github.com/derrickpelletier/node-status/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derrickpelletier%2Fnode-status/sbom","scorecard":{"id":335831,"data":{"date":"2025-08-11","repo":{"name":"github.com/derrickpelletier/node-status","commit":"ce46b6ece73eb68df09c20eaaeee5ccd67ee38ef"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/1 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-18T04:41:31.043Z","repository_id":8184530,"created_at":"2025-08-18T04:41:31.043Z","updated_at":"2025-08-18T04:41:31.043Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271591577,"owners_count":24786420,"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","status":"online","status_checked_at":"2025-08-22T02:00:08.480Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["nodejs","progress","progress-bar","status","stdout"],"created_at":"2024-10-22T22:08:11.750Z","updated_at":"2025-08-22T05:36:14.523Z","avatar_url":"https://github.com/derrickpelletier.png","language":"JavaScript","readme":"# node-status\n\nMakes a little stdout status bar. As simple or complex as you need.\n\n```\nnpm install node-status\n```\n\n- [Config](#config)\n- [Item Options](#item-options)\n- [Item Methods](#item-methods)\n- [Patterns](#patterns)\n- [Tokens](#non-item-tokens)\n\n## Example of custom patterns\n![image](https://cl.ly/2m3E2629130X/Screen%20Recording%202016-08-23%20at%2012.46%20PM%20(3).gif)\n\n## Example of steps\n![image](https://d17oy1vhnax1f7.cloudfront.net/items/2S0x2U0S0L1r3a441O1Q/Screen%20Recording%202016-08-23%20at%2012.37%20PM.gif)\n\n## Quickstart\n```javascript\nvar status = require('node-status')\nvar pizzas = status.addItem('pizza')\n\nstatus.start()\n\npizzas.inc()\npizzas.inc(3)\n```\n\n## Config\nStatus accepts the following config options on `start()`:\n+ `invert`: defaults to *false*. Inverts the colors of the bar.\n+ `interval`: defaults to 250. Number of milliseconds per re-draw interval.\n+ `pattern`: optional manual definition for status bar layout. See [Patterns](#patterns)\n\n```javascript\nstatus.start({\n\tinvert: true,\n\tinterval: 200,\n\tpattern: 'Doing work: {uptime}  |  {spinner.cyan}  |  {pizza.bar}'\n})\n```\n\n## Item Options\n\nAll item options are optional.\n\n| option | type | default | notes |\n|---|---|---|---|\n| **count** | `number` | `0` | Can specify a starting count if needed. |\n| **max** | `number` | `null` | Will cause 'count' type to display as `count/max`. ***Required*** for some display types. Can be a number or a function that returns a number. |\n| **custom** | `function` | `null` | a function run when the pattern `{\u003citem\u003e.custom}` is used. Access `this.count` and `this.max` for values if needed. Must return a `string`. |\n| **precision** | `number` | `2` | The precision used in percentages. |\n| **steps** | `Array` | `false` | An array of strings that identify steps for the item. The count of the item identifies the current step. |\n\n## Item Methods\n\n| method | notes |\n|---|---|\n| `inc( Number )` | Increases the count on the item by the desired amount. If no amount is specified, will increase by 1. |\n| `dec( Number )` | Decreases the count on the item by the desired amount. If no amount is specified, will decrease by 1. |\n| `doneStep( success:Boolean, message:String )` | A helper method for when using `steps` on an item. Will stamp the step to the screen with a ✔ when success is `true`, ✖ when false. An optional message can be added which will be appended to the display. See the gif above, or the examples/steps.js |\n\n## Patterns\n\nThe pattern setting in status config can be used to layout your bar as you see fit, if the default doesn't suit you. Simply a string of tokens.\n\nThe pattern:\n\n```\n'Doing work: {uptime}  |  {spinner.cyan}  |  {pizza.bar}'\n```\n\nWould render as:\n```\nDoing work: 10s  |  ⠼  |  [▒▒▒▒▒▒----]\n```\n\nTokens are specified as: `{\u003ctoken\u003e[.color][.modifier]}`.\n\nAll tokens support colorization with [marak/colors](https://github.com/Marak/colors.js).\n\n### Non-item tokens\n\n| token | modifiers | notes |\n|---|---|---|\n| uptime |  | renders the current uptime of the process. |\n| spinner | spinner types | renders a spinner. Any type available in [cli-spinners](https://github.com/sindresorhus/cli-spinners) can be used. Ex: `{spinner.bouncingBall.cyan}`\n\n### Item tokens\n\nAll items use their `name` as tokens. If you add an item named `pizza`, you can render it in the pattern with `{pizza}`. Simple.\n\n#### Item type modifiers\nThe items have a number of types available to render.\n\n| type | example | |\n|---|---|---|\n| default | `5` or `5/10` | With no type specified, item is rendered as the `count`, or the `count/max` if `max` was specified. |\n| percentage | 15.23% | Renders a simple percentage, requires `max` to be set. Uses the `precision` setting to round the value. |\n| custom | anything | Renders whatever is returned by the specified `custom` function. |\n| bar | `[▒▒▒▒▒-----]` | Renders as a progress bar. Requires `max` to be set. |\n| time | 15s | Uses the count as milliseconds and renders the value as a nicely formatted time. |\n\n\n## Using Console.log alongside status\nRight now, if you have to use `console.log` after the status bar has started, it can be a bit janky because the stdout line isn't cleared when a console.log is run.\n\nYou can utilize an extended console.log by adding this after requiring status.\n```javascript\nconsole = status.console()\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fderrickpelletier%2Fnode-status","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fderrickpelletier%2Fnode-status","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fderrickpelletier%2Fnode-status/lists"}