metarhia / concolor

Colouring template strings using tags with annotations 🎨

Concolor

Concolor is a simple library for Node.js for coloring templated strings using tags with annotations

Usage

• Install: npm install concolor
• Require: const concolor = require('concolor');
• Now you have 4 use cases:
  • string template tag
  • tag factory
  • style function
  • themes

String tag

console.log(concolor`text ${expression}(styles)`);

Examples:

console.log(concolor`Ave ${'World'}(blue) blue`);
console.log(concolor`Ave ${'World'}(/red) on red`);
console.log(concolor`Ave ${'World'}(white/yellow,b) bold white on yellow`);
console.log(concolor`Ave ${'World'}(b) bold`);
console.log(concolor`Ave ${'World'}(b,/blue) bold on blue`);
console.log(concolor`Ave ${'World'}(b,u,yellow) bold underline yellow`);
console.log(concolor`Ave ${'World'}(blue,u) blue underline`);
console.log(concolor`Ave ${'World'}(b,black/green) bold black on green`);

console.log(concolor`
  Client on ${'192.168.1.1'}(black/green)
  connected to ${'SERVER'}(b,red)
  at ${new Date().toUTCString()}(b,blue)
`);

Tag factory

const tag = concolor(styles);
console.log(tag`text`);

Examples:

const warn = concolor('b,yellow');
const err = concolor('b,yellow/red');
const inf = concolor('i,white');

console.log(warn`test1 ${'text2'} text3`);
console.log(err`test4 ${'text5'} text6`);
console.log(inf`test7 ${'text8'} text9`);

Style function

const style = concolor(styles);
console.log(style('text'));

Examples:

const warn = concolor('b,yellow');
const err = concolor('b,yellow/red');
const inf = concolor('i,white');

console.log(warn(`test1 ${'text2'} text3`));
console.log(err(`test4 ${'text5'} text6`));
console.log(inf(`test7 ${'text8'} text9`));

Themes

const theme = concolor({
  caption: 'b,white',
  text: 'green',
  link: 'u,yellow',
});

const caption = 'Caption';
const text = 'Here is a text';
const link = 'http://metarhia.com';

console.log(theme`  ${{ caption }}
  ${{ text }}
  ${{ link }}`);

Themes as functions

const theme = concolor({
  caption: 'b,white',
  text: 'green',
  link: 'u,yellow',
});

console.log(theme.caption('Caption example'));

License & Contributors

Copyright (c) 2017-2023 Metarhia contributors. Concolor is MIT licensed.
Concolor is a part of Metarhia technology stack.

concolor's Issues

Remove codacy badge

Add default styles

concolor.em, concolor.success, concolor.fail, concolor.b, concolor.red etc.

Add support for TypeScript

Type declarations do not work with TypeScript. I rewrote them and published here.

Changes are described here (in Ukrainian).

Use tag as a function

Now concolor have 2 different syntax:

// String tag:
console.log(concolor`text ${expression}(styles)`);

// Tag factory:
const tag = concolor(styles);
console.log(tag`text`);

But we need another additional usage syntax:

const style = concolor(styles);
console.log(style('text'));

Use theme tags as functions

const theme = concolor({
  caption: 'b,white',
  text: 'green',
  link: 'u,yellow'
});

console.log(theme.caption('Caption example'));

Implement themes

const theme = concolor({
  caption: 'b,white',
  text: 'green',
  link: 'u,yellow'
});