constyle
Version:
A simple and performant console styling library for Node.js
117 lines (88 loc) • 3.07 kB
Markdown
# ConStyle
A simple and performant console styling library for Node.js.
[](https://badge.fury.io/js/constyle)
[](https://opensource.org/licenses/Apache-2.0)
Constyle provides an easy-to-use API for adding colors, styles (bold, italic, underline, etc.), and background colors to your console output. It's designed to be lightweight and highly optimized for performance.
## Installation
```bash
npm install constyle@latest
```
## Usage
```javascript
const style = require('constyle');
console.log(style.red('This is red text.'));
console.log(style.green.bold('This is bold green text.'));
console.log(style.bgBlue.white('This is white text on a blue background.'));
console.log(style.yellow.dim('This is dim yellow text.'));
console.log(style.magenta.italic.underline('This is italic, underlined magenta text.'));
console.log(style.cyan.inverse('This is inversed cyan text.'));
console.log(style.black.hidden('This text is hidden.')); // You won't see this
console.log(style.white.strikethrough('This is strikethrough white text.'));
console.log(style.redBright('This is bright red text.'));
console.log(style.bgGreenBright.black('This is black text on a bright green background.'));
console.log(style.grey('This is grey text'));
console.log(style.bgGrey.black('This is black text on a grey background'));
console.log(style.reset('This text is reset to default.')); // Resets all styles
// Chaining multiple styles:
console.log(style.blue.bold.underline('This is bold, underlined blue text.'));
// Using template literals:
const name = 'World';
console.log(`Hello, ${style.green(name)}!`);
```
## API
Constyle uses a fluent API, allowing you to chain styles together.
### Colors
* `black`
* `red`
* `green`
* `yellow`
* `blue`
* `magenta`
* `cyan`
* `white`
* `gray` / `grey`
* `blackBright`
* `redBright`
* `greenBright`
* `yellowBright`
* `blueBright`
* `magentaBright`
* `cyanBright`
* `whiteBright`
### Background Colors
* `bgBlack`
* `bgRed`
* `bgGreen`
* `bgYellow`
* `bgBlue`
* `bgMagenta`
* `bgCyan`
* `bgWhite`
* `bgGray` / `bgGrey`
* `bgBlackBright`
* `bgRedBright`
* `bgGreenBright`
* `bgYellowBright`
* `bgBlueBright`
* `bgMagentaBright`
* `bgCyanBright`
* `bgWhiteBright`
### Styles
* `bold`
* `dim`
* `italic`
* `underline`
* `inverse`
* `hidden`
* `strikethrough`
### Reset
* `reset`: Resets all styles to the default console appearance.
## Performance
Styler is designed with performance in mind. It pre-calculates escape codes, minimizing runtime overhead and making it suitable for high-performance applications.
## Contributing
Contributions are welcome\! Please open an issue or submit a pull request.
## License
Apache-2.0
## Support
**For help or support, join our community on Discord.**
[](https://discord.gg/OpenDevsFlow/6UGYjhSS5v)