Popularity
3.0
Growing
Activity
6.9
Growing
188
8
19

Description

Pipe JSON or CSV to tty-table and get a table output to your terminal, import tty-table as a module for your own cli application, or use it in the browser.

Code Quality Rank: L4
Monthly Downloads: 0
Programming language: JavaScript
License: GNU Lesser General Public License v3.0 only
Latest version: v3.0

tty-table alternatives and similar modules

Based on the "Command Line Apps" category

Do you think we are missing an alternative of tty-table or a related project?

Add another 'Command Line Apps' Module

README

tty-table 甡传打字台

Build Status NPM version


Display your data in a table using a terminal, browser, or browser console.


[Examples](examples/)

[See here for complete example list](examples/)

Terminal (Static)

[examples/styles-and-formatting.js](examples/styles-and-formatting.js)

Static

Terminal (Streaming)

$ node examples/data/fake-stream.js | tty-table --format json --header examples/config/header.js

Streaming

  • See the built-in help for the terminal version of tty-table with: $ tty-table -h

Browser & Browser Console

  • [examples/browser-example.html](examples/browser-example.html)

Browser Console Example

Working Example in Browser

Note that neither ASCI colors nor default borders are rendered in the browser. An alternative border style, as shown below, should be used by setting the following option:

borderStyle : "dashed"

API Reference

<!--API-REF-->

Table(header array, rows array, options object)

Param Type Description
header array Per-column configuration. An array of objects, one object for each column. Each object contains properties you can use to configure that particular column. See available properties
rows array Your data. An array of arrays or objects. See examples
options object Global table configuration. See available properties

header array of objects

Param Type Description
alias string Text to display in column header cell
align string default: "center"
color string default: terminal default color
footerAlign string default: "center"
footerColor string default: terminal default color
formatter function Runs a callback on each cell value in the parent column
headerAlign string default: "center"
headerColor string default: terminal's default color
marginLeft integer default: 0
marginTop integer default: 0
width string \ \
paddingBottom integer default: 0
paddingLeft integer default: 1
paddingRight integer default: 1
paddingTop integer default: 0
value string Name of the property to display in each cell when data passed as an array of objects

Example

let header = [
  {
    alias: "my items",
    value: "item",
    headerColor: "cyan",
    color: "white",
    align: "left",
    paddingLeft: 5,
    width: 30
  },
  {
    value: "price", // if not set, alias will default to "price"
    color: "red",
    width: 10,
    formatter: function(value) {
      var str = `$${value.toFixed(2)}`
      if(value > 5) {
        str = chalk.underline.green(str)
      }
      return str
    }
  }
]

rows array

Example

  • each row an array js const rows = [ ["hamburger",2.50], ]
  • each row an object js const rows = [ { item: "hamburger", price: 2.50 } ]

options object

Param Type Description
borderStyle string default: "solid". "solid", "dashed", "none"
borderColor string default: terminal default color
color string default: terminal default color
compact boolean default: false Removes horizontal lines when true.
defaultErrorValue mixed default: 'ERROR!'
defaultValue mixed default: '?'
errorOnNull boolean default: false
truncate mixed default: false When this property is set to a string, cell contents will be truncated by that string instead of wrapped when they extend beyond of the width of the cell. For example if: "truncate":"..." the cell will be truncated with "..."

Example

const options = {
  borderStyle: 1,
  borderColor: "blue",
  headerAlign: "center",
  align: "left",
  color: "white",
  truncate: "..."
}

Table.render() β‡’ String

Add method to render table to a string

Example

const out = Table(header,rows,options).render()
console.log(out); //prints output

<!--END-API-REF-->

Installation

  • [Terminal](docs/terminal.md):
$ npm install tty-table -g
  • Node Module
$ npm install tty-table
  • Browser
<script src="tty-table.bundle.min.js"></script>
<script>
 const Table = require('tty-table');
 ...
</script>

Running tests

$ npx grunt test

Saving the output of new unit tests

$ npx grunt st
  • Because:

node script.js --color=always

Dev Tips

  • To generate vim tags (make sure jsctags is installed globally)
$ npx grunt tags
  • To generate vim tags on file save
$ npx grunt watch

[Packaging as a distributable](packaging.md)

License

MIT License

Copyright 2015-2019, Tecfu.


*Note that all licence references and agreements mentioned in the tty-table README section above are relevant to that project's source code only.