Package Exports

cmd-table
cmd-table/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cmd-table) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

cmd-table

A modern, feature-rich, and enterprise-grade CLI table library for Node.js.

Features

Zero Dependencies: Lightweight and fast.
Modern Theming: "Rounded" theme by default, plus honeywell, void, double, dots, and more.
Rich Styling: ANSI color support for headers and columns (defaults to Magenta headers and Cyan keys).
Advanced Layouts: colSpan, rowSpan, auto-sizing, word-wrap, and specific column widths.
Data Visualization:
- Tree View: Visualize hierarchical data with automatic indentation.
- Auto-Merge: Automatically vertically merge identical adjacent cells.
Responsive: Hide or stack columns on smaller screens.
Exports: Export tables to Markdown, CSV, JSON, or HTML.
CLI Tool: Standalone executable to pipe JSON data into formatted tables.

Installation

npm install cmd-table

Basic Usage

The library creates a beautiful "Rounded" table by default.

import { Table } from 'cmd-table';

const table = new Table();

// First column defaults to 'cyan' color for keys
table.addColumn('Name'); 
table.addColumn('Role');
table.addColumn('Status');

table.addRow({ Name: 'Alice', Role: 'Dev', Status: 'Active' });
table.addRow({ Name: 'Bob', Role: 'PM', Status: 'Offline' });

console.log(table.render());

Styling

Customize colors for headers and specific columns.

const table = new Table({
  headerColor: 'blue', // Override default magenta
});

table.addColumn({ name: 'Error', color: 'red' });
table.addColumn({ name: 'Warning', color: 'yellow' });

Advanced Visualization

Tree View (Hierarchical Data)

Visualize nested data structures like file systems or org charts.

import { Table, addTree } from 'cmd-table';

const table = new Table();
table.addColumn('Name');
table.addColumn('Size');

const files = [
  { Name: 'src', Size: '-', children: [{ Name: 'index.ts', Size: '2KB' }] },
  { Name: 'package.json', Size: '1KB' }
];

addTree(table, 'Name', files);
console.log(table.render());

Auto-Merge (Grouping)

Automatically merge vertically adjacent cells with the same content.

import { Table, mergeAdjacent } from 'cmd-table';

const table = new Table();
table.addColumn('Department');
table.addColumn('Employee');

table.addRows([
  { Department: 'Engineering', Employee: 'Alice' },
  { Department: 'Engineering', Employee: 'Bob' },
  { Department: 'HR', Employee: 'Charlie' }
]);

// Merges the 'Engineering' cells vertically
mergeAdjacent(table, ['Department']);
console.log(table.render());

CLI Tool

You can use the library directly from the terminal to format JSON data.

# Pipe JSON data
cat data.json | npx cmd-table

# Specify columns and theme
cat data.json | npx cmd-table --columns=name,age --theme=double

Testing Locally (Before Publishing)

Since the package is not yet published to NPM, you can test the CLI tool using the local build:

# Compile TS to JS
npm run build 

# Run compiled script directly
type data.json | node dist/cli.js

Exports

Export your table data to various formats.

import { MarkdownRenderer, CsvRenderer } from 'cmd-table';

const md = new MarkdownRenderer().render(table);
const csv = new CsvRenderer().render(table);

License

MIT