CLI Table 2

Common errors

• TypeError: cli_table2_1.Table is not a constructor

  cause Attempting to use ES Modules import syntax (`import Table from 'cli-table2';`) with a CommonJS package in a TypeScript or modern JavaScript environment.
  fix Change your import statement to `const Table = require('cli-table2');` and ensure your environment is configured to properly handle CommonJS modules.

• TypeError: Table is not a constructor (when using destructuring)

  cause Using destructuring assignment (`const { Table } = require('cli-table2');`) for a CommonJS module that exports a single constructor directly as `module.exports`.
  fix Access the exported constructor directly without destructuring: `const Table = require('cli-table2');`.

• ReferenceError: require is not defined

  cause Attempting to use CommonJS `require` in an ES Module context (e.g., in a file where `type: module` is set in `package.json` or a `.mjs` file) without proper transpilation or configuration.
  fix If your project uses ES Modules, consider rewriting your application to use an alternative library that supports ESM, or configure your build system (e.g., Webpack, Rollup) to transpile CommonJS modules for browser/ESM compatibility.

Warnings

• breaking This package is effectively abandoned and unmaintained since its 0.2.0 release in 2016. Users may encounter compatibility issues with newer Node.js versions or unpatched security vulnerabilities due to a lack of ongoing development and bug fixes.
  Fix: Consider migrating to actively maintained alternatives for critical applications or fork and maintain the package yourself if absolutely necessary.
• gotcha This package is a CommonJS module and does not natively support ES Modules (`import`). Attempting to `import` it will result in runtime errors in an ESM environment.
  Fix: Use CommonJS `require()` syntax: `const Table = require('cli-table2');` Ensure your project configuration or build tools are set up to handle CommonJS modules.
• gotcha The package's documentation explicitly mentions styling through `colors.js`. The `colors.js` library experienced a severe supply chain attack in January 2022, leading to potential breaking changes and the introduction of malicious code in certain versions. While `cli-table2` predates this incident, relying on `colors.js` for styling in projects that also use `cli-table2` could expose applications to risks.
  Fix: Carefully review your project's dependency tree to ensure no malicious versions of `colors.js` are installed. If `colors.js` is used, consider removing it or switching to safer, actively maintained alternatives like `chalk` or `colorette` for CLI coloring.

Install

• npm install cli-table2 npm
• yarn add cli-table2 yarn
• pnpm add cli-table2 pnpm

Imports

• Table
  wrong:

  import Table from 'cli-table2';

  correct:

  const Table = require('cli-table2');

  cli-table2 is a CommonJS module and exports the Table constructor directly as its `module.exports`. ESM 'import' syntax is not supported in this version.
• Table (destructuring)
  wrong:

  const { Table } = require('cli-table2');

  correct:

  const Table = require('cli-table2');

  The package exports the Table constructor directly, not an object containing a 'Table' property. Using destructuring assignment like `{ Table }` will result in 'Table' being `undefined`.
• Configuration Options
  wrong:

  import { head, chars } from 'cli-table2';

  correct:

  const table = new Table({ head: ['Header'], chars: { /* ... */ } });

  Table configuration options (e.g., `head`, `chars`, `colWidths`) are properties of the options object passed to the `Table` constructor, not separate module exports.

Quickstart

Demonstrates the creation of horizontal, vertical, and cross-tabulated CLI tables, including basic data insertion, column width specification, and custom character styling.

const Table = require('cli-table2');

// --- Horizontal Table ---
const horizontalTable = new Table({
    head: ['TH 1 label', 'TH 2 label', 'TH 3 Label'],
    colWidths: [20, 30, 15] // Example widths
});

horizontalTable.push(
    ['First value A', 'Second value B', 'Third value C'],
    ['More data 1', 'More data 2', 'More data 3']
);
console.log('--- Horizontal Table ---');
console.log(horizontalTable.toString());
console.log('\n'); // Add a newline for separation

// --- Vertical Table ---
const verticalTable = new Table();
verticalTable.push(
    { 'Some key': 'Some value' },
    { 'Another key': 'Another value with a longer string to demonstrate wrapping' }
);
console.log('--- Vertical Table ---');
console.log(verticalTable.toString());
console.log('\n');

// --- Cross Table ---
const crossTable = new Table({ head: ["", "Top Header 1", "Top Header 2"] });
crossTable.push(
    { 'Left Header 1': ['Value Row 1 Col 1', 'Value Row 1 Col 2'] },
    { 'Left Header 2 with a long name': ['Value Row 2 Col 1', 'Value Row 2 Col 2'] }
);
console.log('--- Cross Table ---');
console.log(crossTable.toString());
console.log('\n');

// --- Custom Styles Example ---
const customTable = new Table({
  head: ['Styled Header 1', 'Styled Header 2'],
  chars: { 'top': '═' , 'top-mid': '╤' , 'top-left': '╔' , 'top-right': '╗'
         , 'bottom': '═' , 'bottom-mid': '╧' , 'bottom-left': '╚' , 'bottom-right': '╝'
         , 'left': '║' , 'left-mid': '╟' , 'mid': '─' , 'mid-mid': '┼'
         , 'right': '║' , 'right-mid': '╢' , 'middle': '│' },
  style: { 'header': [], 'border': ['cyan'], 'compact': false } // Example style
});
customTable.push(
    ['Custom Data 1', 'Custom Data 2']
);
console.log('--- Custom Styled Table ---');
console.log(customTable.toString());