console-report

Console Report (Console Tables)

This plugin helps to create tables on terminal from JS objects and arrays of objects.

Usage

Block of code:

const cTable = require('console-tables');
 
cTable.generate(testObj, [{name:'Name', value:'firstName'},{name:'Surname', value:'lastName'},{name:'Year of Birth', value:'year'}], {print:true});

Result:

┌──────┬───────┬─────────────┐
│Name  │Surname│Year of Birth│
├──────┼───────┼─────────────┤
│Ivanov│Ivan   │         1992│
└──────┴───────┴─────────────┘

Syntax

Plugin has one function 'generate':

cTable.generate(data, mapping, [options])

data - object or array of objects for porting to table

mapping - array of map objects:

• name - column's label
• value - name of field in data object which contains value for column
• max [optional] - max width of columns

options - optional parameter:

• print [boolean] - if true table printing in terminal else cTable.generate returning body of table as string.
• compact [boolean] - if true table printing in compact format (without lines between rows).
• colored [boolean] - coloring table in different colors

Examples

Table from single object

const cTable = require('console-tables');
 
const testObj = {
    firstName: 'Ivanov',
    lastName: 'Ivan',
    year: 1992
};
 
cTable.generate(testObj, [{name:'Name', value:'firstName'},{name:'Surname', value:'lastName'},{name:'Year of Birth', value:'year'}], {print:true});

Result:

┌──────┬───────┬─────────────┐
│Name  │Surname│Year of Birth│
├──────┼───────┼─────────────┤
│Ivanov│Ivan   │         1992│
└──────┴───────┴─────────────┘

Table from array of objects

const cTable = require('console-tables');
 
const testArr = [{
    firstName: 'Ivanov',
    lastName: 'Ivan',
    year: 1992
},{
    firstName: 'Petrov',
    lastName: 'Petr',
    year: 1991
},{
    firstName: 'Sidorov',
    lastName: 'Petr',
    year: 1995
}];
 
cTable.generate(testArr, [{name:'Name', value:'firstName'},{name:'Surname', value:'lastName'},{name:'Year of Birth', value:'year'}], {print:true});

Result:

┌───────┬───────┬─────────────┐
│Name   │Surname│Year of Birth│
├───────┼───────┼─────────────┤
│Ivanov │Ivan   │         1992│
├───────┼───────┼─────────────┤
│Petrov │Petr   │         1991│
├───────┼───────┼─────────────┤
│Sidorov│Petr   │         1995│
└───────┴───────┴─────────────┘

Compact table

// The same initial data
 
cTable.generate(testArr, [{name:'Name', value:'firstName'},{name:'Surname', value:'lastName'},{name:'Year of Birth', value:'year'}], {print:true,compact:true});

Result

┌───────┬───────┬─────────────┐
│Name   │Surname│Year of Birth│
├───────┼───────┼─────────────┤
│Ivanov │Ivan   │         1992│
│Petrov │Petr   │         1991│
│Sidorov│Petr   │         1995│
└───────┴───────┴─────────────┘

Table with fixed columns widths

const testArr2 = [{
    year: 2000,
    text: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.'
},{
    year: 2001,
    text: 'Lorem ipsum dolor sit amet'
}];
cTable.generate(testArr2, [{name:'Year', value:'year', max: 10},{name:'Text', value:'text', max: 60}], {print:true, colored:true});

Result:

┌────┬────────────────────────────────────────────────────────────┐
│Year│Text                                                        │
├────┼────────────────────────────────────────────────────────────┤
│2000│Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed│
│    │ do eiusmod tempor incididunt ut labore et dolore magna aliq│
│    │ua. Ut enim ad minim veniam, quis nostrud exercitation ullam│
│    │co laboris nisi ut aliquip ex ea commodo consequat. Duis aut│
│    │e irure dolor in reprehenderit in voluptate velit esse cillu│
│    │m dolore eu fugiat nulla pariatur. Excepteur sint occaecat c│
│    │upidatat non proident, sunt in culpa qui officia deserunt mo│
│    │llit anim id est laborum.                                   │
├────┼────────────────────────────────────────────────────────────┤
│2001│Lorem ipsum dolor sit amet                                  │
└────┴────────────────────────────────────────────────────────────┘