Themed-cli NPM

themed-cli

Home

Install

yarn add themed-cli

npm install themed-cli --save

Naming conventions used

Badge text refers to the text with a colored background
Message text refers to the text with the transparent background and to the right of the Badge text.

Usage

Message type usage

const { info } = require('themed-cli');

info( <badge-text>, <message-text> ) // 
info( <message-text> )               // 'INFO' is set as <badge-text>
info.b( <only-badge-style-text> )    // Only badge style text, no message text
info.m( <only-message-style-text> )  // Only message style text, no badge text

Same applies to warn, log, error or any custom defined types.

Sample usage

const { info, warn, log, error, indent } = require('themed-cli');

info('Lorem ipsum dolor sit amet');
info('Lorem', 'Lorem ipsum dolor sit amet');
info.m('Lorem ipsum dolor sit amet');
info.b('Lorem ipsum dolor sit amet');

const { info, warn, log, error } = require('themed-cli');

indent

This function is used to position the cursor according to your choice using

nl - newline (/n)
tab - tab (/t)
space - space (' ')

The inner functions are cascaded.

const { indent } = require('themed-cli');

warn.b('Lorem ipsum dolor sit amet');
indent
	.nl(2)     // New Line
	.tab(3)    // Tab Space
	.space(5); // Space 
error.b('Lorem ipsum dolor sit amet');

Indent

Custom message types with color Maps

The new color map gets merged with the default one

const { initialiseThemedCLI } = require('themed-cli');

const customColorMap = {
	error: {
		badge: '#c0392b',
		message: '#e74c3c',
		contrastText: '#fff'
	},
	warn: {
		badge: '#f39c12',
		message: '#f1c40f',
		contrastText: '#fff'
	},
	log: {
		badge: '#2980b9',
		message: '#3498db',
		contrastText: '#fff'
	},
	info: {
		badge: '#27ae60',
		message: '#2ecc71',
		contrastText: '#fff'
	}
};

const { info, warn, log, error, indent } = initialiseThemedCLI(customColorMap)

Only mandatory field for each type is 'message'

Add New types

To add new types like caution etc, just add it to the color Map and viola, ready to import and use.

Sample usage

const { initialiseThemedCLI } = require('themed-cli');

const customColorMap = {
	caution: {
		badge: '#c0392b',
		message: '#e74c3c',
		contrastText: '#fff'
	}
};

const { info, warn, log, error, caution, indent } = initialiseThemedCLI(customColorMap)