{"id":16208488,"url":"https://github.com/ehmicky/colors-option","last_synced_at":"2025-03-16T11:30:39.081Z","repository":{"id":40569261,"uuid":"343560202","full_name":"ehmicky/colors-option","owner":"ehmicky","description":"Let users toggle colors","archived":false,"fork":false,"pushed_at":"2024-09-14T16:52:53.000Z","size":5885,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-11T10:17:07.711Z","etag":null,"topics":["ansi","bash","chalk","cli","color","colors","config","configuration","disable","es6","javascript","library","nodejs","option","rgb","shell","terminal","tty","typescript","windows"],"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/ehmicky.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2021-03-01T21:19:32.000Z","updated_at":"2024-09-14T16:52:57.000Z","dependencies_parsed_at":"2024-08-13T04:41:48.467Z","dependency_job_id":"1b3f0471-fbf9-4d9d-a329-aecf2255c26c","html_url":"https://github.com/ehmicky/colors-option","commit_stats":{"total_commits":353,"total_committers":1,"mean_commits":353.0,"dds":0.0,"last_synced_commit":"99109db5983907e1a4b42e4a1157f4cfccfb89b9"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fcolors-option","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fcolors-option/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fcolors-option/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fcolors-option/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ehmicky","download_url":"https://codeload.github.com/ehmicky/colors-option/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243814864,"owners_count":20352037,"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":["ansi","bash","chalk","cli","color","colors","config","configuration","disable","es6","javascript","library","nodejs","option","rgb","shell","terminal","tty","typescript","windows"],"created_at":"2024-10-10T10:17:14.826Z","updated_at":"2025-03-16T11:30:38.726Z","avatar_url":"https://github.com/ehmicky.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Node](https://img.shields.io/badge/-Node.js-808080?logo=node.js\u0026colorA=404040\u0026logoColor=66cc33)](https://www.npmjs.com/package/colors-option)\n[![TypeScript](https://img.shields.io/badge/-Typed-808080?logo=typescript\u0026colorA=404040\u0026logoColor=0096ff)](/src/main.d.ts)\n[![Codecov](https://img.shields.io/badge/-Tested%20100%25-808080?logo=codecov\u0026colorA=404040)](https://codecov.io/gh/ehmicky/colors-option)\n[![Mastodon](https://img.shields.io/badge/-Mastodon-808080.svg?logo=mastodon\u0026colorA=404040\u0026logoColor=9590F9)](https://fosstodon.org/@ehmicky)\n[![Medium](https://img.shields.io/badge/-Medium-808080.svg?logo=medium\u0026colorA=404040)](https://medium.com/@ehmicky)\n\nLet users toggle colors.\n\nThis is a thin wrapper around the popular\n[`chalk`](https://github.com/chalk/chalk) colors library that adds support for:\n\n- A [`colors` boolean option](#colors)\n- The [`NO_COLOR`](https://no-color.org/) and\n  [`NODE_DISABLE_COLORS`](https://nodejs.org/api/cli.html#cli_node_disable_colors_1)\n  environment variables\n\n# Hire me\n\nPlease\n[reach out](https://www.linkedin.com/feed/update/urn:li:activity:7117265228068716545/)\nif you're looking for a Node.js API or CLI engineer (11 years of experience).\nMost recently I have been [Netlify Build](https://github.com/netlify/build)'s\nand [Netlify Plugins](https://www.netlify.com/products/build/plugins/)'\ntechnical lead for 2.5 years. I am available for full-time remote positions.\n\n# Example\n\n```js\nimport colorsOption from 'colors-option'\n\nconst exampleLibrary = ({ colors, ...otherLibraryOptions }) =\u003e {\n  const chalk = colorsOption({ colors })\n  console.log(chalk.red('example'))\n}\n```\n\n# Install\n\n```\nnpm install colors-option\n```\n\nThis package works in Node.js \u003e=18.18.0.\n\nThis is an ES module. It must be loaded using\n[an `import` or `import()` statement](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c),\nnot `require()`. If TypeScript is used, it must be configured to\n[output ES modules](https://www.typescriptlang.org/docs/handbook/esm-node.html),\nnot CommonJS.\n\n# API\n\n## colorsOption(options?)\n\n`options`: `object`\\\n_Return value_: [`Chalk` instance](https://github.com/chalk/chalk#api)\n\n### options\n\n#### colors\n\n_Type_: `boolean`\\\n_Default_: `undefined`\n\nWhether colors should be enabled/disabled, regardless of terminal support.\nColors support is automatically detected, so this is only meant to override that\ndefault behavior.\n\nThe recommended approach is to:\n\n- Add a `colors` boolean programmatic option and/or CLI flag\n- Keep its default value `undefined`\n- Forward it to `colors-option`\n\nInstead of using\n[`chalk/supports-color`](https://github.com/chalk/supports-color), this relies\non Node.js built-in colors detection\n[`getColorDepth()`](https://nodejs.org/api/tty.html#tty_writestream_getcolordepth_env)\nwhich:\n\n- Supports the [`NO_COLOR`](https://no-color.org/) and\n  [`NODE_DISABLE_COLORS`](https://nodejs.org/api/cli.html#cli_node_disable_colors_1)\n  environment variables.\n- Does not guess colors detection based on the presence of a\n  [`--colors` CLI flag](https://github.com/chalk/supports-color#info). This\n  gives finer control and flexibility over how to expose this as a CLI flag.\n\nPlease note that `chalk` has a similar\n[`level` option](https://github.com/chalk/chalk#chalklevel). However, that\noption is an integer from `0` to `3` which makes it hard to toggle colors while\nstill keeping 256 colors or Truecolor.\n\n#### stream\n\n_Type_:\n[`Stream`](https://nodejs.org/api/stream.html#stream_class_stream_writable)\\\n_Default_: [`process.stdout`](https://nodejs.org/api/process.html#process_process_stdout)\n\nStream used to detect colors support. This should be the file or terminal where\nthe colors are output.\n\n# See also\n\n- [`chalk-string`](https://github.com/ehmicky/chalk-string): Chalk with style\n  strings.\n- [`terminal-theme`](https://github.com/ehmicky/terminal-theme): 🎨 Use a color\n  theme for your code's terminal output.\n\n# Support\n\nFor any question, _don't hesitate_ to [submit an issue on GitHub](../../issues).\n\nEveryone is welcome regardless of personal background. We enforce a\n[Code of conduct](CODE_OF_CONDUCT.md) in order to promote a positive and\ninclusive environment.\n\n# Contributing\n\nThis project was made with ❤️. The simplest way to give back is by starring and\nsharing it online.\n\nIf the documentation is unclear or has a typo, please click on the page's `Edit`\nbutton (pencil icon) and suggest a correction.\n\nIf you would like to help us fix a bug or add a new feature, please check our\n[guidelines](CONTRIBUTING.md). Pull requests are welcome!\n\n\u003c!-- Thanks go to our wonderful contributors: --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003c!--\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://fosstodon.org/@ehmicky\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/8136211?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eehmicky\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/ehmicky/colors-option/commits?author=ehmicky\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#design-ehmicky\" title=\"Design\"\u003e🎨\u003c/a\u003e \u003ca href=\"#ideas-ehmicky\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"https://github.com/ehmicky/colors-option/commits?author=ehmicky\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n--\u003e\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Fcolors-option","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fehmicky%2Fcolors-option","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Fcolors-option/lists"}