[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url]
[![Dependency Status][daviddm-image]][daviddm-url] [![devDependency Status][daviddm-dev-image]][daviddm-dev-url]

chalker

Set ansi colors in strings using <> markers and [chalk].

Usage

``js
const chalker = require("chalker");

console.log(chalker("Red on Green Text"));

// with template string tagging
console.log(chalkerhello world);
`

A typical use case is to easily manage colors for logs that could go to console or log servers.

`js
const msg = some error occurred...;

// log to console for visual with colors
if (!production) console.log(chalker(msg));

// log to log server with colors removed
logger.log(chalker.remove(msg));
`

Install

`
npm i --save chalker
`

Demo

![demo][demo]

Marker Details

- Color markers has the red text format. You can use any valid methods [chalk] supports.

- For example, blue bold text will colorize blue bold text with chalk.blue.bold.
- Closing marker can be simply

- The following HTML entities escapes are supported:

| Entity | Character | Entity | Character |
| -------- | --------- | -------- | ------------------ |
| < | < | > | > |
| & | & |   | non-breaking space |
| ' | ' | © | © |
| " | " | ® | ® |

- HTML escape using code points also works:

- Hex - &#xhhhh; where hhhh is the Hex code point.
- Decimal - &#nnnn; where nnnn is the Decimal code point.
- ie: �� makes 👩

#### Advanced Chalk Colors

[Chalk advanced colors] can be applied with:

| [chalk] API | chalker marker | [chalk] API | chalker marker |
| --------------- | --------------------------------------------- | ----------------- | ---------------------------------------------------- |
| chalk.rgb | <(255, 10, 20)>, | chalk.bgRgb | , |
| chalk.hex | <#FF0000>, | chalk.bgHex | , |
| chalk.keyword | , <(orange)>, | chalk.bgKeyword | , , |
| chalk.hsl | | chalk.bgHsl | |
| chalk.hsv | | chalk.bgHsv | |
| chalk.hwb | | chalk.bgHwb | |

##### More details

- a marker is tried with chalk.keyword if:

- it's not detected as hex value
- it doesn't contain params enclosed in ()
- it's not found as a basic color that chalk supports
- for example, this is a chalk color keyword:
- If it's prefixed with "bg-" then it's tried using chalk.bgKeyword

- ie:

- All markers can be comined with . in any order as long as they work with [chalk]

- ie: <#FF0000.bg#0000FF.bg-orange.keyword(red)>

APIs

$3

`js
chalker(str, [chalkInstance]);
`

- str - String with chalker color markers
- chalkInstance - Optional custom instance of [chalk].
- ie: created from new chalk.constructor({level: 2})

Returns: A string with terminal/ansi color codes

> If chalk.supportsColor is false, then it will simply remove the <> markers and decode HTML entities only.

$3

`js
chalker.remove(str, keepHtml);
`

- str - String with chalker color markers
- keepHtml - If true, then don't decode HTML entity escapes.

Simply remove all chalker markers and return the plain text string, with HTML escapes decoded.

Returns: A plain text string without chalker color markers

$3

`js
chalker.decodeHtml(str);
`

- str` - String to decode HTML entities

Returns: String with HTML entities escapes decoded

License

Copyright (c) 2019-present, Joel Chen

Licensed under the Apache License, Version 2.0.

---

[demo]: ./images/demo.png
[chalk]: https://www.npmjs.com/package/chalk
[chalk advanced colors]: https://github.com/chalk/chalk#256-and-truecolor-color-support
[travis-image]: https://travis-ci.org/jchip/chalker.svg?branch=master
[travis-url]: https://travis-ci.org/jchip/chalker
[npm-image]: https://badge.fury.io/js/chalker.svg
[npm-url]: https://npmjs.org/package/chalker
[daviddm-image]: https://david-dm.org/jchip/chalker/status.svg
[daviddm-url]: https://david-dm.org/jchip/chalker
[daviddm-dev-image]: https://david-dm.org/jchip/chalker/dev-status.svg
[daviddm-dev-url]: https://david-dm.org/jchip/chalker?type=dev