cli-tableau

library2.0.1jsnpmunverified

cli-tableau is a robust JavaScript library designed for rendering pretty, highly customizable tables in command-line interfaces using Unicode characters. It offers extensive control over table structure, including options for horizontal, vertical, and cross-table layouts, and allows for detailed customization of borders, column widths, and styling characters. The current stable version, 2.0.1, indicates a mature codebase. Its release cadence appears to be relatively slow, focusing on stability. A key differentiator is its granular control over the `chars` property, enabling developers to define every single line and intersection character, from full Unicode borders to completely invisible separators, offering unparalleled flexibility in visual output compared to simpler table rendering utilities. It is primarily used within Node.js environments for CLI tools.

devops http-networking web-framework

npm install cli-tableau

github ↗package ↗

INSTALL

IMPORT

SIG · CLI-TABLEAU

cli-tableau

devopsjavascriptv2.0.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Table

✓ const Table = require('cli-tableau');

✗ import Table from 'cli-tableau';

cli-tableau is primarily a CommonJS module. Direct ES module imports may not work without a CommonJS wrapper or bundler configuration, or specific Node.js settings.

Table (named import - incorrect)

✓ const Table = require('cli-tableau'); // Only a default export

✗ import { Table } from 'cli-tableau';

The library exports a default constructor function, not named exports. Attempting a named import like `{ Table }` will result in `Table` being `undefined` in ES modules.

Demonstrates creating a basic horizontal table with custom headers, column widths, and basic styling, then populating it with data rows for console output.

const Table = require('cli-tableau'); const table = new Table({ head: ['Task Description', 'Status', 'Due Date'], colWidths: [40, 15, 20], style: { 'padding-left': 1, 'padding-right': 1, 'head': ['cyan'], 'border': ['grey'], 'compact': true // Makes rows more compact } }); table.push( ['Implement feature X', 'In Progress', '2024-05-01'], ['Fix bug Y in module Z', 'Pending Review', '2024-04-28'], ['Write documentation for API V2', 'Not Started', '2024-05-15'] ); console.log(table.toString());

Debug

Known issues

gotchacli-tableau is predominantly a CommonJS (CJS) library. While it works seamlessly in Node.js CJS projects, direct ES module (ESM) `import` statements may require specific Node.js configurations, bundler setups, or a CJS wrapper to function correctly in pure ESM projects. Consider using `createRequire` if mixing CJS into ESM.

fix

For ESM projects, you might need `import { createRequire } from 'module'; const require = createRequire(import.meta.url); const Table = require('cli-tableau');` or configure your bundler to handle CJS modules.

affects: >=1.0.0

gotchaCustom character styles (`chars`) are powerful but can lead to unexpected visual output if not all necessary characters are defined or if they conflict with `borders` and `style` settings. Setting certain `chars` properties to empty strings will remove corresponding lines or intersections.

fix

Always test your custom `chars` configuration with various data inputs. Refer to the documentation examples for common patterns, such as removing horizontal lines between rows by clearing `mid`, `left-mid`, `mid-mid`, `right-mid`.

affects: >=1.0.0

Errors

Common errors & fixes

TypeError: Table is not a constructor

Attempting to use `Table` as a constructor after an incorrect ES module named import (e.g., `import { Table } from 'cli-tableau';`), or if `require` returned an unexpected value.

fix

Ensure you are using the CommonJS `const Table = require('cli-tableau');` pattern, as the library exports its main constructor as the default CommonJS export.

Cannot read properties of undefined (reading 'push')

This typically occurs if the `table` instance was not correctly created, often due to an issue with the `Table` constructor call, or if `Table` itself was `undefined` (e.g., from a failed import).

fix

Verify that `require('cli-tableau')` successfully returned the Table constructor and that `new Table()` was called correctly. Check for typos in the import path or symbol, and ensure the module loaded as expected.

Upgrade

Version history

2.0.1latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

16 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/Keymetrics/cli-table ↗

packagehttps://www.npmjs.com/package/cli-tableau ↗