{"id":16208504,"url":"https://github.com/ehmicky/chalk-string","last_synced_at":"2025-03-19T08:30:50.457Z","repository":{"id":61506365,"uuid":"552096780","full_name":"ehmicky/chalk-string","owner":"ehmicky","description":"Chalk with style strings.","archived":false,"fork":false,"pushed_at":"2024-02-14T20:48:31.000Z","size":4529,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-03-14T22:24:05.586Z","etag":null,"topics":["ansi","bash","chalk","cli","color","colors","config","configuration","console","javascript","library","nodejs","option","rgb","shell","terminal","theme","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}},"created_at":"2022-10-15T20:05:07.000Z","updated_at":"2024-04-22T20:27:39.962Z","dependencies_parsed_at":"2024-02-14T21:50:36.416Z","dependency_job_id":null,"html_url":"https://github.com/ehmicky/chalk-string","commit_stats":{"total_commits":156,"total_committers":3,"mean_commits":52.0,"dds":0.03205128205128205,"last_synced_commit":"5190da62a35412d7c829a55a218e8e2228891fea"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":"ehmicky/template-javascript","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fchalk-string","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fchalk-string/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fchalk-string/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fchalk-string/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ehmicky","download_url":"https://codeload.github.com/ehmicky/chalk-string/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243976478,"owners_count":20377691,"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","console","javascript","library","nodejs","option","rgb","shell","terminal","theme","tty","typescript","windows"],"created_at":"2024-10-10T10:17:19.718Z","updated_at":"2025-03-19T08:30:50.027Z","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/chalk-string)\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/chalk-string)\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\nChalk with style strings.\n\n[Chalk](https://github.com/chalk/chalk) adds styles to terminal strings.\n`chalk-string` is a thin wrapper around it which allows specifying those styles\nas a string. This enables user-defined or dynamic styling.\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 chalkString from 'chalk-string'\n\nconst addStyles = chalkString()\n\naddStyles('red', 'input') // Same as: chalk.red('input')\naddStyles('red bold', 'input') // Same as: chalk.red.bold('input')\naddStyles('hex-ffffff', 'input') // Same as: chalk.hex('ffffff')('input')\naddStyles('rgb-10-20-30', 'input') // Same as: chalk.rgb(10, 20, 30)('input')\n\naddStyles('invalidStyle', 'input') // Invalid styles throw an error\n```\n\n# Install\n\n```bash\nnpm install chalk-string\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## chalkString(options?)\n\n`options` [`Options?`](#options)\\\n_Return value_: [`addStyles()`](#addstylesstyles-input)\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\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### addStyles(styles, input)\n\n`styles` [`stylesString`](#available-styles)\\\n`input` `string`\\\n_Return value_: `string`\n\nApply [styles](#available-styles) to `input` then return it.\n\n# Available styles\n\n```sh\n# Standard styles\nbold underline inverse reset\n\n# Those styles do not always work on Windows\ndim italic hidden strikethrough\n\n# Hidden when the terminal does not support colors\nvisible\n\n# Basic colors\nblack red green yellow blue magenta cyan white gray\nblackBright redBright greenBright yellowBright blueBright\nmagentaBright cyanBright whiteBright\n\n# Advanced colors\nhex-ffffff\nrgb-255-255-255\n\n# Background colors\nbgBlack bgRed bgGreen bgYellow bgBlue bgMagenta bgCyan bgWhite bgGray\nbgBlackBright bgRedBright bgGreenBright bgYellowBright bgBlueBright\nbgMagentaBright bgCyanBright bgWhiteBright\nbgHex-* bgRgb-*\n```\n\n# Related projects\n\n- [`colors-option`](https://github.com/ehmicky/colors-option): Let users toggle\n  colors.\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 --\u003e\n\u003c!--\n\u003ctable\u003e\u003ctr\u003e\u003ctd align=\"center\"\u003e\u003ca href=\"https://fosstodon.org/@ehmicky\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/8136211?v=4\" width=\"100px;\" alt=\"ehmicky\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eehmicky\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/ehmicky/chalk-string/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/chalk-string/commits?author=ehmicky\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e\n --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Fchalk-string","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fehmicky%2Fchalk-string","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Fchalk-string/lists"}