# table-layout > Stylable text tables, handling ansi colour. Useful for console output. Latest version **4.1.1** (published 2024-07-31) · MIT license · 0 weekly downloads ## Install ```sh npm install table-layout pnpm add table-layout yarn add table-layout bun add table-layout ``` ## Health **Score 30/100 (F)** — status: abandoned. Positive: esm support; no vulnerabilities. Warnings: low downloads; no types. Negative: abandoned. ## Facts | | | |---|---| | Version | 4.1.1 | | Published | 2024-07-31 | | First published | 2016-05-15 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | ESM | | Node | >=12.17 | | Dependencies | 2 | | Unpacked size | 60.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 24 | | Author | Lloyd Brookes | | Maintainers | 75lb | | Keywords | wrap, columns, format, json, command line, table, view | ## Links - npm: https://www.npmjs.com/package/table-layout - Repository: https://github.com/75lb/table-layout - Homepage: https://github.com/75lb/table-layout#readme - Issues: https://github.com/75lb/table-layout/issues - npm.io page: https://npm.io/package/table-layout ## Dependencies (2) - [array-back](https://npm.io/package/array-back.md) ^6.2.2 - [wordwrapjs](https://npm.io/package/wordwrapjs.md) ^5.1.0 ## Alternatives - [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads - [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads - [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads - [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads - [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads ## Recent versions - 4.1.1 (latest) — 2024-07-31 - 4.1.0 — 2024-07-18 - 4.0.0 — 2024-06-29 - 3.0.2 — 2023-03-06 - 3.0.1 — 2023-02-15 - 3.0.0 — 2021-09-05 - 2.1.0 — 2021-03-23 - 2.0.3 — 2021-03-23 - 2.0.2 — 2021-03-07 - 2.0.1 — 2021-03-07 - 2.0.0 — 2021-03-07 - 1.0.2 — 2021-03-07 - 1.0.1 — 2020-03-14 - 1.0.0 — 2019-06-26 - 0.4.5 — 2019-06-25 - … 12 more at https://npm.io/package/table-layout/versions ## README [![view on npm](https://badgen.net/npm/v/table-layout)](https://www.npmjs.org/package/table-layout) [![npm module downloads](https://badgen.net/npm/dt/table-layout)](https://www.npmjs.org/package/table-layout) [![Gihub repo dependents](https://badgen.net/github/dependents-repo/75lb/table-layout)](https://github.com/75lb/table-layout/network/dependents?dependent_type=REPOSITORY) [![Gihub package dependents](https://badgen.net/github/dependents-pkg/75lb/table-layout)](https://github.com/75lb/table-layout/network/dependents?dependent_type=PACKAGE) [![Node.js CI](https://github.com/75lb/table-layout/actions/workflows/node.js.yml/badge.svg)](https://github.com/75lb/table-layout/actions/workflows/node.js.yml) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard) # table-layout Styleable plain-text table generator. Useful for formatting console output. Available as both a [command-line tool](https://github.com/75lb/table-layout-cli) and isomorphic Javascript library. ## Install as a library Add table-layout to your project: ``` $ npm install --save table-layout ``` ## Display an array of objects as a table Trivial example. Read a JSON file from disk and output a table with a maximum width (in characters) of 60. ```js import Table from 'table-layout' import { promises as fs } from 'fs' const issues = await fs.readFile('./issues.json', 'utf8') const table = new Table(JSON.parse(issues), { maxWidth: 60 }) console.log(table.toString()) ``` This is the example input file: ```json [ { "number": 15134, "title": "Coveralls has no source available ", "login": "ndelangen", "comments": 0 }, { "number": 15133, "title": "Fixing --preserve-symlinks. Enhancing node to exploit.", "login": "phestermcs", "comments": 0 }, { "number": 15131, "title": "Question - Confused about NPM's local installation philosophy", "login": "the1mills", "comments": 0 }, { "number": 15130, "title": "Question - global npm cache directory if user is root?", "login": "ORESoftware", "comments": 0 } ] ``` This is the output: ``` 15134 Coveralls has no source available ndelangen 0 15133 Fixing --preserve-symlinks. phestermcs 0 Enhancing node to exploit. 15131 Question - Confused about NPM's the1mills 0 local installation philosophy 15130 Question - global npm cache ORESoftware 0 directory if user is root? 15127 how to installa gulp fontfacegen aramgreat 0 on Windows 10 15097 Cannot install package from mastertinner 3 tarball out of package.json entry generated by npm 15067 npm "SELF_SIGNED_CERT_IN_CHAIN" LegendsLyfe 3 error when installing discord.js with .log ``` ## Cherry-picked and computed values Sometimes, your input data might contain a deeper structure or you want to transform or compute some values. Some example input data with structural depth and large numbers you'd like to reformat: ```json [ { "country": { "name": "USA" }, "GDP": 19485394000000, "population": 325084756 }, { "country": { "name": "China" }, "GDP": 12237700479375, "population": 1421021791 }, { "country": { "name": "Japan" }, "GDP": 4872415104315, "population": 127502725 } ] ``` Example usage of the column getter function: ```js import Table from 'table-layout' import { promises as fs } from 'fs' const rows = JSON.parse(await fs.readFile('./example/deep-data/gdp.json', 'utf8')) const germanCurrency = new Intl.NumberFormat('de-DE', { style: 'currency', currency: 'EUR' }) const germanNumber = new Intl.NumberFormat('de-DE', { notation: 'compact', maximumSignificantDigits: 3, maximumFractionDigits: 0 }) const table = new Table(rows, { maxWidth: 60, columns: [ { name: 'country', get: (cellValue) => cellValue.name }, { name: 'GDP', get: (cellValue) => germanCurrency.format(cellValue) }, { name: 'population', get: (cellValue) => germanNumber.format(cellValue) }, ] }) console.log(table.toString()) ``` Output. ``` $ node example/computed-values.js USA 19.485.394.000.000,00 € 325 Mio. China 12.237.700.479.375,00 € 1,42 Mrd. Japan 4.872.415.104.315,00 € 128 Mio. ``` ## Colour-scale conditional formatting See [this file](https://github.com/75lb/table-layout/blob/master/example/colour-scale-formatting.js) for a example of colour-scale formatting (increasing intensity of red/green for more positive/negative values). ## API Reference For the full API documentation, see [here](https://github.com/75lb/table-layout/blob/master/docs/API.md). ## Load anywhere This library is compatible with Node.js, the Web and any style of module loader. It can be loaded anywhere, natively without transpilation. Within a Node.js CommonJS Module: ```js const Table = require('table-layout') ``` Within a Node.js ECMAScript Module: ```js import Table from 'table-layout' ``` Within a modern browser ECMAScript Module: ```js import Table from './node_modules/table-layout/dist/index.mjs' ``` ## See Also * [gfmt](https://github.com/75lb/gfmt): A github-flavoured-markdown table generator. * * * © 2015-24 [Lloyd Brookes](https://github.com/75lb) \<75pound@gmail.com\>. Isomorphic test suite by [test-runner](https://github.com/test-runner-js/test-runner). Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown). --- _Source: https://npm.io/package/table-layout · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._