{"id":40052428,"url":"https://github.com/rollercodester/consolate","last_synced_at":"2026-01-19T06:30:34.594Z","repository":{"id":57206033,"uuid":"83254152","full_name":"rollercodester/consolate","owner":"rollercodester","description":"Customize your Node.JS console like a dignitary.","archived":false,"fork":false,"pushed_at":"2017-03-19T08:42:30.000Z","size":2031,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-08-09T03:36:42.465Z","etag":null,"topics":["animation","bullets","cli-spinners","console-error","console-log","console-tool","console-visualization","progress","spinner","steps","terminal-themes"],"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/rollercodester.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":"2017-02-27T01:06:58.000Z","updated_at":"2021-11-06T16:19:33.000Z","dependencies_parsed_at":"2022-09-18T06:47:06.055Z","dependency_job_id":null,"html_url":"https://github.com/rollercodester/consolate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rollercodester/consolate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rollercodester%2Fconsolate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rollercodester%2Fconsolate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rollercodester%2Fconsolate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rollercodester%2Fconsolate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rollercodester","download_url":"https://codeload.github.com/rollercodester/consolate/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rollercodester%2Fconsolate/sbom","scorecard":{"id":783412,"data":{"date":"2025-08-11","repo":{"name":"github.com/rollercodester/consolate","commit":"63b0803efc8bcffe930eaaa08e531a3589028f14"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 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":"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":"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":"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":"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":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"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":"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":"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":"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":"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":"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"}}]},"last_synced_at":"2025-08-23T05:27:18.307Z","repository_id":57206033,"created_at":"2025-08-23T05:27:18.307Z","updated_at":"2025-08-23T05:27:18.307Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28562404,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-19T03:31:16.861Z","status":"ssl_error","status_checked_at":"2026-01-19T03:31:15.069Z","response_time":67,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["animation","bullets","cli-spinners","console-error","console-log","console-tool","console-visualization","progress","spinner","steps","terminal-themes"],"created_at":"2026-01-19T06:30:30.872Z","updated_at":"2026-01-19T06:30:34.576Z","avatar_url":"https://github.com/rollercodester.png","language":"JavaScript","readme":"[![npm](http://img.shields.io/npm/v/consolate.svg)](https://www.npmjs.org/package/consolate)\r\n[![travis](https://travis-ci.org/rollercodester/consolate.svg?branch=master)](https://travis-ci.org/rollercodester/consolate)\r\n[![Dependency Status](https://david-dm.org/rollercodester/consolate.svg)](https://david-dm.org/rollercodester/consolate)\r\n\r\n# consolate\r\n#### Customize your Node.JS console like a dignitary.\r\nEasily create intuitive log functions on the console object\u0026mdash;even override built-in console functions (error, info, warn, etc.) And while you're at it, feel free to easily define colors, prefixes, and bullets that can automatically animate [cli-cursors](https://www.npmjs.com/package/cli-spinners).\r\n\r\n![examples/6-cicd-pipeline.js](https://cloud.githubusercontent.com/assets/1450389/23842310/a584cdfc-0770-11e7-8969-f2d6659ca41a.gif)\r\n\r\n## Index\r\n\r\n* [Examples](#examples)\r\n\t* [Super-simple Custom Console Method](#example1)\r\n\t* [Overriding Built-in Console Methods](#example2)\r\n\t* [Animated vs Static Bullets](#example3)\r\n\t* [Smart Log Argument Handling](#example4)\r\n\t* [Apollo 11](#example5)\r\n\t* [CI/CD Pipeline Console](#example6)\r\n* [API Reference](#api)\r\n\r\n\u003ca name=\"examples\"\u003e\u003c/a\u003e\r\n\r\n## Examples\r\n\r\n\u003ch3\u003e\u003ca name=\"example1\" href='https://github.com/rollercodester/consolate/blob/master/examples/1-simple-custom-method.js'\u003eSuper-simple Custom Console Method\u003c/a\u003e\u003c/h3\u003e\r\n\r\n![examples/1-simple-custom-method.js](https://cloud.githubusercontent.com/assets/1450389/23828435/20fe2f50-0686-11e7-962f-fbf2702ea259.gif)\r\n\r\n```javascript\r\nvar consolate = require('consolate')\r\n\r\nconsolate.init({\r\n   arrow: {\r\n      color: consolate.colors.cyan,\r\n      prefix: {\r\n         chars: '\u003e\u003e\u003e\u003e\u003e-----\u003e',\r\n         color: consolate.colors.lightCyan\r\n      }\r\n   }\r\n})\r\n\r\nconsole.arrow('My customized \"arrow\" log method!')\r\n\r\nsetTimeout(() =\u003e {\r\n\tconsole.arrow('Just think of the possibilities :-)')\r\n}, 1500)\r\n\r\nsetTimeout(() =\u003e {\r\n\tconsole.arrow('And we haven\\'t even scratched the surface.')\r\n}, 3000)\r\n\r\nsetTimeout(() =\u003e {\r\n\tconsole.arrow('Okay, one more time before moving on.')\r\n\tconsole.log()\r\n}, 4500)\r\n```\r\n\r\n\u003ch3\u003e\u003ca name=\"example2\" href='https://github.com/rollercodester/consolate/blob/master/examples/2-console-overrides-on-built-in-methods.js'\u003eOverriding Built-in Console Methods\u003c/a\u003e\u003c/h3\u003e\r\n\r\n![examples/2-console-overrides-on-built-in-methods.js](https://cloud.githubusercontent.com/assets/1450389/23828470/7610d2f8-0687-11e7-8410-fdf2b567775a.gif)\r\n\r\n\r\n\u003ch3\u003e\u003ca name=\"example3\" href='https://github.com/rollercodester/consolate/blob/master/examples/3-animated-and-static-bullets.js'\u003eAnimated vs Static Bullets\u003c/a\u003e\u003c/h3\u003e\r\n\r\n![examples/3-animated-and-static-bullets.js](https://cloud.githubusercontent.com/assets/1450389/23828520/e8a89fd4-0688-11e7-9c95-aa3959920f46.gif)\r\n\r\n\r\n\u003ch3\u003e\u003ca name=\"example4\" href='https://github.com/rollercodester/consolate/blob/master/examples/4-smart-log-argument-handling.js'\u003eSmart Log Argument Handling\u003c/a\u003e\u003c/h3\u003e\r\n\r\n![examples/4-smart-log-argument-handling.js](https://cloud.githubusercontent.com/assets/1450389/23831679/bd7c44d6-06e3-11e7-9e8c-087b0b996a75.gif)\r\n\r\n\r\n\u003ch3\u003e\u003ca name=\"example5\" href='https://github.com/rollercodester/consolate/blob/master/examples/5-apollo-11.js'\u003eApollo 11\u003c/a\u003e\u003c/h3\u003e\r\n\r\n![examples/5-apollo-11.js](https://cloud.githubusercontent.com/assets/1450389/23831850/6751c74a-06e6-11e7-8340-66e53124a7c0.gif)\r\n\r\n\r\n\u003ch3\u003e\u003ca name=\"example6\" href='https://github.com/rollercodester/consolate/blob/master/examples/6-cicd-pipeline.js'\u003eCI/CD Pipeline Console\u003c/a\u003e\u003c/h3\u003e\r\n\r\n![examples/6-cicd-pipeline.js](https://cloud.githubusercontent.com/assets/1450389/23842310/a584cdfc-0770-11e7-8969-f2d6659ca41a.gif)\r\n\r\n\r\n\u003ca name=\"api\"\u003e\u003c/a\u003e\r\n\r\n## API Reference\r\n\u003ca name=\"module_consolate.init\"\u003e\u003c/a\u003e\n\n## consolate.init(options)\nThe initialization function that must be called to enable consolate.\n\n**Kind**: static method of \u003ccode\u003e[consolate](#module_consolate)\u003c/code\u003e  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| options | \u003ccode\u003econsolateOptions\u003c/code\u003e | (or string) Options object with values that drive consolate behavior OR this parameter can be a filepath to options yaml file. If options is not provided, then a default options file consolate.yml will be searched for in working directory. See example #6 (examples/6-cicd-pipeline.js) for an example options yaml file. |\n\n\u003ca name=\"module_consolate..colors\"\u003e\u003c/a\u003e\n\n## consolate~colors : \u003ccode\u003eenum\u003c/code\u003e\nColor representations of ANSI output text codes that consolate supports.\n\n**Kind**: inner enum of \u003ccode\u003e[consolate](#module_consolate)\u003c/code\u003e  \n**Read only**: true  \n**Properties**\n\n| Name | Type | Default | Description |\n| --- | --- | --- | --- |\n| reset | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e0\u003c/code\u003e | Not a color, per se...rather used to reset the active color back to default |\n| default | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e39\u003c/code\u003e | The default color configured by your terminal |\n| black | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e30\u003c/code\u003e |  |\n| red | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e31\u003c/code\u003e |  |\n| green | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e32\u003c/code\u003e |  |\n| yellow | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e33\u003c/code\u003e |  |\n| blue | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e34\u003c/code\u003e |  |\n| magenta | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e35\u003c/code\u003e |  |\n| cyan | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e36\u003c/code\u003e |  |\n| lightGray | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e37\u003c/code\u003e |  |\n| darkGray | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e90\u003c/code\u003e |  |\n| lightRed | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e91\u003c/code\u003e |  |\n| lightGreen | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e92\u003c/code\u003e |  |\n| lightYellow | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e93\u003c/code\u003e |  |\n| lightBlue | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e94\u003c/code\u003e |  |\n| lightMagenta | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e95\u003c/code\u003e |  |\n| lightCyan | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e96\u003c/code\u003e |  |\n| white | \u003ccode\u003enumber\u003c/code\u003e | \u003ccode\u003e97\u003c/code\u003e |  |\n\n\u003ca name=\"module_consolate..restore\"\u003e\u003c/a\u003e\n\n## consolate~restore\nRestores the console object back to its native state by removing all consolate modifications.\n\n**Kind**: inner constant of \u003ccode\u003e[consolate](#module_consolate)\u003c/code\u003e  \n\u003ca name=\"module_consolate..consolateOptions\"\u003e\u003c/a\u003e\n\n## consolate~consolateOptions : \u003ccode\u003eObject\u003c/code\u003e\nThe consolate options object that defines output methods and their respective settings and/or overrides existing log methods and their behavior.\n\n**Kind**: inner typedef of \u003ccode\u003e[consolate](#module_consolate)\u003c/code\u003e  \n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| key | \u003ccode\u003estring\u003c/code\u003e | The name of an output method (built-in or user-defined), which consolate will use to create a log method (of same name) on the console object. |\n| value | \u003ccode\u003eoutputMethodSettings\u003c/code\u003e | The settings to apply to the respecive output method. |\n\n\u003ca name=\"module_consolate..outputMethodSettings\"\u003e\u003c/a\u003e\n\n## consolate~outputMethodSettings : \u003ccode\u003eObject\u003c/code\u003e\nAn object that represents the settings for the output method that has the same name as this object's key.\n\n**Kind**: inner typedef of \u003ccode\u003e[consolate](#module_consolate)\u003c/code\u003e  \n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| inPlace | \u003ccode\u003eboolean\u003c/code\u003e | Specifies that when a series of calls are made for this output method, all subsequent output will be rendered on the same line after the initial call—in effect overwriting the previous console output. |\n| color | \u003ccode\u003ecolors\u003c/code\u003e | The color to use for the output text. |\n| prefix | \u003ccode\u003eprefix\u003c/code\u003e | The prefix option (if any) to use for this output method. |\n| bullet | \u003ccode\u003ebullet\u003c/code\u003e | The bullet option (if any) to use for this output method. |\n\n\u003ca name=\"module_consolate..prefix\"\u003e\u003c/a\u003e\n\n## consolate~prefix : \u003ccode\u003eObject\u003c/code\u003e\nSpecifies preferences (if any) for including an automatic prefix to all console output for an output method.\n\n**Kind**: inner typedef of \u003ccode\u003e[consolate](#module_consolate)\u003c/code\u003e  \n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| chars | \u003ccode\u003estring\u003c/code\u003e | One or more characters to use as the prefix. |\n| color | \u003ccode\u003ecolors\u003c/code\u003e | The color to use for the prefix text. |\n| leftPadding | \u003ccode\u003enumber\u003c/code\u003e | The number of spaces to pad on the left side of the prefix. |\n| rightPadding | \u003ccode\u003enumber\u003c/code\u003e | The number of spaces to pad on the right side of the prefix. |\n\n\u003ca name=\"module_consolate..bullet\"\u003e\u003c/a\u003e\n\n## consolate~bullet : \u003ccode\u003eObject\u003c/code\u003e\nSpecifies preferences (if any) for including an automatic left-aligned bullet to all console output for an output method.\n\n**Kind**: inner typedef of \u003ccode\u003e[consolate](#module_consolate)\u003c/code\u003e  \n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| cliSpinner | \u003ccode\u003estring\u003c/code\u003e | For an animated bullet, this is the spinner name to use per the [cli-spinners](https://www.npmjs.com/package/cli-spinners) library. Note: The animation will continue until a different output method is called, which will then overwrite the animation output, thus stopping and clearing it. |\n| chars | \u003ccode\u003estring\u003c/code\u003e | For a static (non-animated) bullet, this is one or more characters to use as the bullet. This property is ignored if cliSpinner is specified. |\n| color | \u003ccode\u003ecolors\u003c/code\u003e | The color to use for the bullet text. |\n| leftPadding | \u003ccode\u003enumber\u003c/code\u003e | The number of spaces to pad on the left side of the bullet. |\n| rightPadding | \u003ccode\u003enumber\u003c/code\u003e | The number of spaces to pad on the right side of the bullet. |\n\n\r\n\r\n\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frollercodester%2Fconsolate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frollercodester%2Fconsolate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frollercodester%2Fconsolate/lists"}