Have ideas to improve npm?Join in the discussion! »

    concolor
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.1 • Public • Published

    Concolor

    ci status codacy snyk npm version npm downloads/month npm downloads

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

    Usage

    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'));

    Contributors

    Copyright (c) 2017-2020 concolor contributors

    Install

    npm i concolor

    DownloadsWeekly Downloads

    171

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    10.8 kB

    Total Files

    7

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar