Giter Club home page Giter Club logo

caroline's Introduction

caroline

Build Status

A small terminal color library and logger for Node.js based on ANSI escape codes.

Installation

npm install caroline

Example

var logger = require('caroline');
console.log(logger.bg.red(logger.color.cyan(logger.style.italic('Test'))));

logger.print('Text', {
  color : 'white',
  background : 'green',
  bold : true,
  italic : true
});

API Documentation

caroline.style

  • bold(text)
  • italic(text)
  • underline(text)

caroline.color

  • black(text)
  • red(text)
  • green(text)
  • yellow(text)
  • blue(text)
  • magenta(text)
  • cyan(text)
  • white(text)
  • gray(text)

caroline.background

  • black(text)
  • red(text)
  • green(text)
  • yellow(text)
  • blue(text)
  • magenta(text)
  • cyan(text)
  • white(text)

caroline.print(text, [options])

var logger = require('caroline');
logger.print('Italic text', {
  italic : true
});

logger.print('Underline text', {
  underline : true
});

logger.print('Bold text', {
  bold : true
});

Log messages

  • caroline.log('Log message', [arg1, args2 ...])
  • caroline.info('Info message', [arg1, args2 ...])
  • caroline.warn('Warn message', [arg1, args2 ...])
  • caroline.error('Error message', [arg1, args2 ...])

Convenience methods

  • caroline.enable()
  • caroline.disable() - Enable/disable logging
  • caroline.disableColors() - Disable the coloring of the output
  • caroline.enableColors()
  • caroline.hidePrefixes() - Don't show the LOG|INFO etc. prefix
  • caroline.showPrefixes()
  • caroline.hideTimestamps() - Don't display the timestamp
  • caroline.showTimestamps()

Run the tests

npm test

caroline's People

Contributors

beatfactor avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.