cli-format

A command line formatting that makes it easy to manage word wrapping, indents, padding, columns, and more. Also works with ansi-encoding libraries chalk, colors, and others.

Installation

To install with npm

npm install cli-format

Features

1. Word wrapping at any width you choose
2. Line output (words in an array)
3. Column output
4. Ansi formatting (on or off)
5. First line indent
6. Hanging indent
7. Trim start or end of line independently
8. Automatic available width detection
9. Hard breaks for long words
10. Reusable utilities

Example Usage

Simple Word Wrap

var cliFormat = require('cli-format');
var result = cliFormat.wrap('This line will automatically wrap at column 20', { width: 20 });
console.log(result);

/*
This line will
automatically wrap at
column 20
*/

Lines for Word Wrap

var cliFormat = require('cli-format');
var config = {
    width: 20,
    filler: false,
    ansi: false
};
var result = cliFormat.lines('This line will automatically wrap at column 20', config);
console.log(result);

/*
[ "This line will", "automatically wrap at", "column 20" ]
*/

Column Wrapping

var str = 'T' + colors.underline('he') +
      ' quick brown fox jumped over the ' +
    colors.bold('lazy dog') +
    ' and the cow said moo to you too.';

var config = {
    width: [20, 20, null],
    paddingLeft: '>',
    paddingRight: '<',
    paddingMiddle: ' | ',
    hangingIndent: '...',
    filler: '.'
};
    
var result = format.columns(str, str, str, config);
console.log(result);

/*
>The quick brown fox | The quick brown.. | The quick brown fox jumped over the.<
>...jumped over the. | ...fox jumped.... | ...lazy dog and the cow said moo to.<
>...lazy dog and the | ...over the lazy. | ...you too..........................<
>...cow said moo to. | ...dog and the... | ....................................<
>...you too......... | ...cow said moo.. | ....................................<
>................... | ...to you too.... | ....................................<
*/

Formatting Options

The functions .wrap(), .lines(), and .columns() each use a configuration object to define how the output should be provided. Below you'll see what configuration options exist.

API

The following methods and properties are exposed using require('cli-format'):

Ansi

The require('cli-format').ansi object has the following properties that may be of use to you. Generally you won't need to change these properties but you can if you want different behavior than what is default.

Config

The require('cli-format').config object has the following properties that may be of use to you. Generally you won't need to change these properties but you can if you want different behavior than what is default.