chalk-string

[![Node](https://img.shields.io/badge/-Node.js-808080?logo=node.js&colorA=404040&logoColor=66cc33)](https://www.npmjs.com/package/chalk-string) [![TypeScript](https://img.shields.io/badge/-Typed-808080?logo=typescript&colorA=404040&logoColor=0096ff)](/src/main.d.ts) [![Codecov](https://img.shields.io/badge/-Tested%20100%25-808080?logo=codecov&colorA=404040)](https://codecov.io/gh/ehmicky/chalk-string) [![Mastodon](https://img.shields.io/badge/-Mastodon-808080.svg?logo=mastodon&colorA=404040&logoColor=9590F9)](https://fosstodon.org/@ehmicky) [![Medium](https://img.shields.io/badge/-Medium-808080.svg?logo=medium&colorA=404040)](https://medium.com/@ehmicky) Chalk with style strings. [Chalk](https://github.com/chalk/chalk) adds styles to terminal strings. `chalk-string` is a thin wrapper around it which allows specifying those styles as a string. This enables user-defined or dynamic styling. # Example ```js import chalkString from 'chalk-string' chalkString('red')('input') // Same as: chalk.red('input') chalkString('red bold')('input') // Same as: chalk.red.bold('input') chalkString('hex-ffffff')('input') // Same as: chalk.hex('ffffff')('input') chalkString('rgb-10-20-30')('input') // Same as: chalk.rgb(10, 20, 30)('input') chalkString('invalidStyle')('input') // Invalid styles throw an error ``` # Install ```bash npm install chalk-string ``` This package works in Node.js >=18.18.0. This is an ES module. It must be loaded using [an `import` or `import()` statement](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c), not `require()`. If TypeScript is used, it must be configured to [output ES modules](https://www.typescriptlang.org/docs/handbook/esm-node.html), not CommonJS. # API ## chalkString(styles, options?) `styles` [`stylesString`](#available-styles)\ `options` [`Options?`](#options)\ _Return value_: [`addStyles()`](#addstylesinput) ### Options #### colors _Type_: `boolean`\ _Default_: `undefined` Whether colors should be enabled/disabled, regardless of terminal support. Colors support is automatically detected, so this is only meant to override that default behavior. #### stream _Type_: [`Stream`](https://nodejs.org/api/stream.html#stream_class_stream_writable)\ _Default_: [`process.stdout`](https://nodejs.org/api/process.html#process_process_stdout) Stream used to detect colors support. This should be the file or terminal where the colors are output. ### addStyles(input) `input` `string`\ _Return value_: `string` Apply [styles](#available-styles) to `input` then return it. # Available styles ```sh # Standard styles bold underline inverse reset # Those styles do not always work on Windows dim italic hidden strikethrough # Hidden when the terminal does not support colors visible # Basic colors black red green yellow blue magenta cyan white gray blackBright redBright greenBright yellowBright blueBright magentaBright cyanBright whiteBright # Advanced colors hex-ffffff rgb-255-255-255 # Background colors bgBlack bgRed bgGreen bgYellow bgBlue bgMagenta bgCyan bgWhite bgGray bgBlackBright bgRedBright bgGreenBright bgYellowBright bgBlueBright bgMagentaBright bgCyanBright bgWhiteBright bgHex-* bgRgb-* ``` # Related projects - [`colors-option`](https://github.com/ehmicky/colors-option): Let users toggle colors. - [`terminal-theme`](https://github.com/ehmicky/terminal-theme): 🎨 Use a color theme for your code's terminal output # Support For any question, _don't hesitate_ to [submit an issue on GitHub](../../issues). Everyone is welcome regardless of personal background. We enforce a [Code of conduct](CODE_OF_CONDUCT.md) in order to promote a positive and inclusive environment. # Contributing This project was made with ❤️. The simplest way to give back is by starring and sharing it online. If the documentation is unclear or has a typo, please click on the page's `Edit` button (pencil icon) and suggest a correction. If you would like to help us fix a bug or add a new feature, please check our [guidelines](CONTRIBUTING.md). Pull requests are welcome!