privatenumber/cli-simple-table

Simple CLI table for simple people

Simple CLI table for simple people

Install

npm i cli-simple-table

Basic usage

import SimpleTable from 'cli-simple-table'
import chalk from 'chalk'

const table = new SimpleTable()

table.header('Name', 'Emoji')

table.row(chalk.red('Squid'), '🦑')
table.row(chalk.green('Frog'), '🐸')
table.row(chalk.yellow('Tiger'), '🐯')
table.row(chalk.blue('Whale'), '🐳')
table.row(chalk.magenta('Unicorn'), '🦄')
table.row(chalk.cyan('Dolphin'), '🐬')
table.row(chalk.white('Panda'), '🐼')

console.log(table.toString())

Alignment

const table = new SimpleTable()

table.header(
    'Name',
    {
        text: 'Age',
        align: 'right'
    }
)

table.row('Steve', 26)

console.log(table.toString())

Max column width

const table = new SimpleTable()

table.header(
    {
        text: 'Long text',
        maxWidth: 25
    },
    {
        text: 'Long long text',
        maxWidth: 25
    }
)

table.row('Truncates really really long text', chalk.magenta('Colored long long text too'))

console.log(table.toString())

Options

• columnPadding <Number> (10) - Number of characters to pad the column content with

• headerSeparator <Number> (1) - Number of lines that separate the header from the table body

cli-simple-table's Issues

Make empty line below header optional

First, thanks for sharing this code!

Second, it'd be great if this line were optional:

cli-simple-table/index.js

Line 60 in 319cbf2

'',

Or perhaps a function to return an object like:

{"header": "...",
 "rows": ["...", "..."]}

So it could be further formatted by a template engine or whatever.

Just a thought. 😄

Thanks, again!
🎩

1.1.0 breaks require() usage

Looks like the build process changes between 1.0.0 and 1.1.0 broke the ability to use this as a Common JS module. Here's what I get post upgrade:

TypeError: SimpleTable is not a constructor

or sometimes

Cannot find module 'cli-simple-table'

or from eslint

import/no-unresolved: Unable to resolve path to module 'cli-simple-table'.

Versions:
NPM: 6.14.13
Node: v14.17.3