https://github.com/privatenumber/cli-simple-table
Simple CLI table for simple people
https://github.com/privatenumber/cli-simple-table
cli minimal simple table
Last synced: 7 months ago
JSON representation
Simple CLI table for simple people
- Host: GitHub
- URL: https://github.com/privatenumber/cli-simple-table
- Owner: privatenumber
- License: mit
- Created: 2020-06-09T07:27:55.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2022-04-01T15:33:32.000Z (over 3 years ago)
- Last Synced: 2025-03-01T19:51:31.899Z (7 months ago)
- Topics: cli, minimal, simple, table
- Language: TypeScript
- Homepage:
- Size: 929 KB
- Stars: 10
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Simple CLI table for simple people
### Install
```sh
npm i cli-simple-table
```
### Basic usage
```js
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
```js
const table = new SimpleTable()
table.header(
'Name',
{
text: 'Age',
align: 'right'
}
)
table.row('Steve', 26)
console.log(table.toString())
```
### Max column width
```js
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` `` (`10`) - Number of characters to pad the column content with
- `headerSeparator` `` (`1`) - Number of lines that separate the header from the table body