stringd-colors

Extends a stringd object with ansi styles

Features

• Supports stringd parsing functionality
• Extends any object with styles defined here

Installing

Via NPM:

npm install stringd-colors

Usage

// Node CommonJS
const cStringd = require('stringd-colors');
// Or ES6
import cStringd from 'stringd-colors';

<!-- Or in the Browser -->
<script src="index.js"></script>

Example

// CommonJS
const { log } = console;

log(cStringd(
  ':{color:bgGreen}:{color:red}:{greeting}:{color:close}:{color:bgClose}',
  { greeting: 'Hello World' }
));

Result

API

cStringd(template[, objects])

• template: <string>
• objects: <object>
• Returns: <string>

Parse the template with the colors in cStringd.raw and variables in objects if provided

cStringd(':{color:green}Hi There:{color:close}');
// '\u001b[32mHi There\u001b[39m'

cStringd.extend([objects])

• objects: <object>
• Returns: <string>

Return an extension of object with cStringd.raw, hence appending the ansi colors to the object, the absence of object would return cStringd.raw

const stringd = require('stringd');
const cStringd = require('stringd-colors');
stringd(':{color:green}:{name}:{color:close}', cStringd.extend({name: 'Jon Bellion'}));
// '\u001b[32mJon Bellion\u001b[39m'

cStringd.raw

An object for stringd parsing of ansi styles defined here

Styles

ANSI style documentation here

Modifiers

To close modifiers, append :close the key name e.g :{color:underline:close}

• color:reset
• color:bold
• color:dim
• color:italic
• color:underline
• color:inverse
• color:hidden
• color:strikethrough
• color:visible

Colors

Use :{color:close} to close these

• color:black
• color:red
• color:green
• color:yellow
• color:blue
• color:magenta
• color:cyan
• color:white
• color:gray
• color:redBright
• color:greenBright
• color:yellowBright
• color:blueBright
• color:magentaBright
• color:cyanBright
• color:whiteBright

Background colors

Use :{color:bgClose} to close these

• color:bgBlack
• color:bgRed
• color:bgGreen
• color:bgYellow
• color:bgBlue
• color:bgMagenta
• color:bgCyan
• color:bgWhite
• color:bgBlackBright
• color:bgRedBright
• color:bgGreenBright
• color:bgYellowBright
• color:bgBlueBright
• color:bgMagentaBright
• color:bgCyanBright
• color:bgWhiteBright

Development

Tests are executed with Jest. To use it, simple run npm install, it will install Jest and its dependencies in your project's node_modules directory followed by npm test.

To run the tests:

npm install
npm test

License

Apache 2.0 © Miraculous Owonubi (@miraclx) <omiraculous@gmail.com>