couleurs
Version:
Add some color and styles to your Node.JS strings.
292 lines (131 loc) • 6.04 kB
Markdown
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
[](#)
# couleurs
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://travis-ci.org/IonicaBizau/node-couleurs/) [](https://www.npmjs.com/package/couleurs) [](https://www.npmjs.com/package/couleurs) [](https://www.codementor.io/@johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
> Add some color and styles to your Node.JS strings.
[](#)
## :cloud: Installation
```sh
# Using npm
npm install --save couleurs
# Using yarn
yarn add couleurs
```
## :clipboard: Example
```js
const colors = require("couleurs")
, FlatColors = require("flat-colors")
;
// Basic usage using a random flat color
let colored = new colors("Hello World").fg(FlatColors());
console.log(colored.toString());
// Other ways to color the strings
console.log(colors.fg("Red", [255, 0, 0]));
console.log(colors("Red foreground", [255, 0, 0]));
console.log(colors.fg("Yellow", 255, 255, 0));
console.log(colors.fg("Blue", "#2980b9"));
console.log(colors.bg("Blue Background", "#2980b9"));
console.log(colors("Blue & Underline").fg("#2980b9").bold().underline().toString());
console.log(colors.bold("Bold"));
console.log(colors.italic("Italic"));
// Modify prototype
colors.proto();
console.log("Underline".underline());
console.log("Inverse".inverse());
console.log("Strikethrough".strike());
console.log("All combined"
.fg("#d35400")
.bold()
.italic()
.underline()
.inverse()
.strike()
);
```
## :question: Get Help
There are few ways to get help:
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
## :memo: Documentation
### `Couleurs(setStringProto, fg)`
#### Params
- **Boolean|undefined** `setStringProto`: If `true`, the prototype of String class will be modified.
- **String|Array** `fg`: An optional foreground color.
#### Return
- **String|Object** The colored string if the `fg` argument was provided or an object containing the following methods:
- `proto`
- `toString`
- `fg`
- `bg`
- `bold`
- `italic`
- `underline`
- `inverse`
- `strike`
### `toString()`
Converts the internal object into string.
#### Return
- **String** Stringifies the couleurs internal data using ANSI styles.
### `proto()`
Modifies the `String` prototype to contain the `Couleurs` methods.
## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].
## :sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
- Starring and sharing the projects you like :rocket:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
- **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
Thanks! :heart:
## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:
- `3abn`
- `@phaticusthiccy/image-to-text`
- `@well-crafted/git-unsaved`
- `asciify-image`
- `asciify-pixel`
- `bible`
- `birthday`
- `bloggify-tools`
- `bug-killer`
- `cli-confeti`
- `cli-confetti`
- `cli-gh-cal`
- `cli-github`
- `cli-pie`
- `cli-sunset`
- `closeheat`
- `color-it`
- `csk-cli`
- `cute-logger`
- `fb-falafel`
- `git-issues`
- `git-issues1`
- `git-stats-colors`
- `git-unsaved`
- `github-emojify`
- `github-stats`
- `idea`
- `image-asciify-cli`
- `overlap`
- `terminal-rush`
- `tithe`
## :scroll: License
[MIT][license] © [Ionică Bizău][website]
[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW