cli-table

What is cli-table?

The cli-table npm package is a utility for rendering unicode-aided tables on the command line from your node.js scripts. It allows for easy table creation with customizable column widths, alignments, colors, and more, making it highly useful for CLI tools that need to display data in a structured format.

What are cli-table's main functionalities?

Basic Table Creation

This feature allows for the creation of a simple table with rows of data. The example demonstrates how to instantiate a table, add rows, and then print it to the console.

const Table = require('cli-table');
let table = new Table();
table.push(
    ['First row', 'Some data'],
    ['Second row', 'More data']
);
console.log(table.toString());

Customized Table

This feature showcases the ability to customize the table with headers and column widths. The code sample creates a table with specified headers and column widths, adds rows of data, and prints the table.

const Table = require('cli-table');
let table = new Table({
    head: ['ID', 'Name', 'Age'],
    colWidths: [10, 20, 10]
});
table.push(
    [1, 'John Doe', 30],
    [2, 'Jane Doe', 25]
);
console.log(table.toString());

Table with Colored and Aligned Text

This feature demonstrates the ability to add colored and aligned text within table cells. The example shows how to align text horizontally and vertically within cells.

const Table = require('cli-table');
let table = new Table();
table.push(
    [{content: 'Left align', hAlign: 'left', vAlign: 'top'}, 'Some data'],
    [{content: 'Right align', hAlign: 'right'}, 'More data']
);
console.log(table.toString());

Other packages similar to cli-table

table

The 'table' package provides similar functionality for creating and rendering tables in the command line. It offers a more extensive API for customization compared to cli-table, including border styles, text wrapping, and cell padding.

ascii-table

Ascii-table is another package for creating ASCII tables in node.js applications. It is simpler and more lightweight than cli-table, focusing on basic table creation without the extensive customization options.

README

CLI Table

This utility allows you to render unicode-aided tables on the command line from your node.js scripts.

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-table

How to use

Horizontal Tables

import Table from 'cli-table';

// instantiate
const 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

const Table = require('cli-table');
const 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"] }

import Table from 'cli-table';
const 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:

const 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:

const 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:

const 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

Running tests

Clone the repository with all its submodules and run:

$ make test

How to contribute

Contribution are welcome! If you spot a bug or want to request an improvement, you are encouraged to submit a PR.

1. Keep PRs as atomic and limited in scope as possible. Will make reviewing easier and faster.
2. Want to submit multiple fixes/improvements? Please submit one PR each.
3. Always add tests for your PRs; this will ensure future changes won't break your code.

Credits

• Guillermo Rauch <[e-mail]> (Guille)

License

(The MIT License)

Copyright (c) 2010 LearnBoost <[e-mail]>

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.