Skip to content
This repository has been archived by the owner. It is now read-only.
:octocat: Pretty unicode tables for the command line
JavaScript
Branch: master
Clone or download
Pull request Compare This branch is 2 commits behind jamestalmage:master.
mmurphy and jamestalmage Fix wordWrap with colSpan (jamestalmage#29)
wrap across the colSpan width and not just the first column
Latest commit 187c6ae Dec 23, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
lib lib: Remove unused lodash import Aug 3, 2016
src Fix wordWrap with colSpan (jamestalmage#29) Dec 23, 2017
test Fix wordWrap with colSpan (jamestalmage#29) Dec 23, 2017
.gitignore
.travis.yml
LICENSE
README.md
advanced-usage.md Add wordWrap prelim Dec 20, 2014
basic-usage.md
gulpfile.js gulp: Remove unused lodash import Aug 3, 2016
index.js Add index.js. Update Readme Dec 20, 2014
package.json Merge pull request jamestalmage#26 from Turbo87/npmignore Sep 21, 2016

README.md

CLI Table 2 npm version Build Status Coverage Status

This utility allows you to render unicode-aided tables on the command line from your node.js scripts. Based on (and api compatible with) the original cli-table, cli-table2 is nearly a complete rewrite to accommodate column and row spanning. It passes the entire original cli-table test suite, and should be a drop in replacement for nearly all users.

Screenshot

Features not in the original cli-table

  • Ability to make cells span columns and/or rows.
  • Ability to set custom styles per cell (border characters/colors, padding, etc).
  • Vertical alignment (top, bottom, center).
  • Automatic word wrapping.
  • More robust truncation of cell text that contains ansi color characters.
  • Better handling of text color that spans multiple lines.
  • API compatible with the original cli-table.
  • Exhaustive test suite including the entire original cli-table test suite.
  • Lots of examples auto-generated from the tests (basic, advanced).

Features

  • Customizable characters that constitute the table.
  • Color/background styling in the header through colors.js
  • Column width customization
  • Text truncation based on predefined widths
  • Text alignment (left, right, center)
  • Padding (left, right)
  • Easy-to-use API

Installation

npm install cli-table2

How to use

A portion of the unit test suite is used to generate examples:

  • basic-usage - covers basic uses.
  • advanced - covers using the new column and row span features.

This package is api compatible with the original cli-table. So all the original documentation still applies (copied below).

Horizontal Tables

var Table = require('cli-table2');

// instantiate
var table = new Table({
    head: ['TH 1 label', 'TH 2 label']
  , colWidths: [100, 200]
});

// table is an Array, so you can `push`, `unshift`, `splice` and friends
table.push(
    ['First value', 'Second value']
  , ['First value', 'Second value']
);

console.log(table.toString());

Vertical Tables

var Table = require('cli-table2');
var table = new Table();

table.push(
    { 'Some key': 'Some value' }
  , { 'Another key': 'Another value' }
);

console.log(table.toString());

Cross Tables

Cross tables are very similar to vertical tables, with two key differences:

  1. They require a head setting when instantiated that has an empty string as the first header
  2. The individual rows take the general form of { "Header": ["Row", "Values"] }
var Table = require('cli-table2');
var table = new Table({ head: ["", "Top Header 1", "Top Header 2"] });

table.push(
    { 'Left Header 1': ['Value Row 1 Col 1', 'Value Row 1 Col 2'] }
  , { 'Left Header 2': ['Value Row 2 Col 1', 'Value Row 2 Col 2'] }
);

console.log(table.toString());

Custom styles

The chars property controls how the table is drawn:

var table = new Table({
  chars: { 'top': '' , 'top-mid': '' , 'top-left': '' , 'top-right': ''
         , 'bottom': '' , 'bottom-mid': '' , 'bottom-left': '' , 'bottom-right': ''
         , 'left': '' , 'left-mid': '' , 'mid': '' , 'mid-mid': ''
         , 'right': '' , 'right-mid': '' , 'middle': '' }
});

table.push(
    ['foo', 'bar', 'baz']
  , ['frob', 'bar', 'quuz']
);

console.log(table.toString());
// Outputs:
//
//╔══════╤═════╤══════╗
//║ foo  │ bar │ baz  ║
//╟──────┼─────┼──────╢
//║ frob │ bar │ quuz ║
//╚══════╧═════╧══════╝

Empty decoration lines will be skipped, to avoid vertical separator rows just set the 'mid', 'left-mid', 'mid-mid', 'right-mid' to the empty string:

var table = new Table({ chars: {'mid': '', 'left-mid': '', 'mid-mid': '', 'right-mid': ''} });
table.push(
    ['foo', 'bar', 'baz']
  , ['frobnicate', 'bar', 'quuz']
);

console.log(table.toString());
// Outputs: (note the lack of the horizontal line between rows)
//┌────────────┬─────┬──────┐
//│ foo        │ bar │ baz  │
//│ frobnicate │ bar │ quuz │
//└────────────┴─────┴──────┘

By setting all chars to empty with the exception of 'middle' being set to a single space and by setting padding to zero, it's possible to get the most compact layout with no decorations:

var table = new Table({
  chars: { 'top': '' , 'top-mid': '' , 'top-left': '' , 'top-right': ''
         , 'bottom': '' , 'bottom-mid': '' , 'bottom-left': '' , 'bottom-right': ''
         , 'left': '' , 'left-mid': '' , 'mid': '' , 'mid-mid': ''
         , 'right': '' , 'right-mid': '' , 'middle': ' ' },
  style: { 'padding-left': 0, 'padding-right': 0 }
});

table.push(
    ['foo', 'bar', 'baz']
  , ['frobnicate', 'bar', 'quuz']
);

console.log(table.toString());
// Outputs:
//foo        bar baz
//frobnicate bar quuz

Build Targets

Clone the repository and run npm install to install all its submodules, then run one of the following commands:

Run the tests with coverage reports.
$ gulp coverage
Run the tests every time a file changes.
$ gulp watch-test
Run the examples and print the output to the command line.
$ gulp example

Other build targets are available, check gulpfile.js for a comprehensive list.

Credits

License

(The MIT License)

Copyright (c) 2014 James Talmage <james.talmage@jrtechnical.com>

Original cli-table code/documentation: Copyright (c) 2010 LearnBoost <dev@learnboost.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

You can’t perform that action at this time.