colorprint

colorprint

Print ansi-colored message to stdout/stderr.

Table of Contents

• How to
  • Usage
  • Install
• Using via cli
  • CLI Usage
  • Install global for CLI usage.
• Customizing
  • Customize the whole module.
  • Create new context to customize.
• Links
  • Website
  • Documents
  • Reports
• License
• About this project
  • Author
  • Donation

How to

Usage

var colorpint = require('colorpint');
colorpint.info('This is INFO'); //Pipe to stdout with green color.
colorpint.debug('This is DEBUG'); //Pipe to stdout with  color.
colorpint.trace('This is TRACE'); //Pipe to stdout with white color.
colorpint.error('This is ERROR'); //Pipe to stderr with red color.
colorpint.fatal('This is FATAL'); //Pipe to stderr with bgRed color.

Fore more detail, see API Guide of colorpint functions.

Install

$ npm install colorprint --save

Using via cli

CLI Usage

#!/bin/bash

colorpint info "This is INFO from CLI" # Pipe to stdout with green color.
colorpint debug "This is DEBUG from CLI" # Pipe to stdout with  color.
colorpint trace "This is TRACE from CLI" # Pipe to stdout with white color.
colorpint error "This is ERROR from CLI" # Pipe to stderr with red color.
colorpint fatal "This is FATAL from CLI" # Pipe to stderr with bgRed color.

Fore more detail, see API Guide of colorpint functions.

Install global for CLI usage.

$ npm install colorprint --g

Customizing

Customize the whole module.

var colorprint = require('colorprint');
colorprint.PREFIX='Yeah!';
colorprint.INFO_COLOR='blue';
colorprint.info('This will be blue with prefix.');

Create new context to customize.

var Colorprint = require('colorprint/lib/colorprint');
var colorprint = new Colorprint({
    PREFIX: '[Foo]',
    INFO_COLOR: 'blue'
});
colorprint.info('This will be blue with prefix.');

colorpint is using cli-color for coloring and you can see available colors here.

Links

Website

• colorprint
• colorprint @npm
• colorprint @github

Documents

• API Guide

Reports

• Build Status @travis
• Analysis Result @codeclimate
• Issues @github
• Coverage Report

License

This software is released under the MIT License.

About this project

Author

• Taka Okunishi

Donation

Support this project and others by okunishinishi via gratipay.