CLI Table 3: Pretty Unicode Tables

Common errors

• TypeError: Table is not a constructor

  cause Attempting to use named import syntax (`import { Table } from 'cli-table3';`) for the main `Table` class, which is a default export.
  fix Use the correct default import syntax: `import Table from 'cli-table3';`.

• Error: cli-table3 requires Node.js version 10.* || >= 12.*

  cause Running `cli-table3` on an unsupported Node.js version, specifically older than 10.x or between 10.x and 12.x.
  fix Upgrade your Node.js runtime to version 10.* or >= 12.*. You can use tools like `nvm` (Node Version Manager) to manage multiple Node.js versions.

• Property 'href' does not exist on type 'CellOptions'

  cause Attempting to use the `href` property within `CellOptions` (for hyperlink support) with an older version of `cli-table3` or outdated TypeScript type definitions.
  fix Ensure you are using `cli-table3` version 0.6.2 or higher, as `href` support was added in this version. Update your package and regenerate `node_modules/@types` if necessary.

Warnings

• breaking Node.js version requirements were updated in v0.5.0. Projects using older Node.js runtimes (prior to 10.* or 12.*) will encounter errors.
  Fix: Ensure your Node.js environment is version 10.* or >= 12.*. Update your `engines` field in `package.json` accordingly if deploying.
• gotcha cli-table3 is the maintained successor to the unmaintained `cli-table` and `cli-table2` packages. While API compatible, always install `cli-table3` to receive ongoing updates and bug fixes.
  Fix: Always use `npm install cli-table3` or `yarn add cli-table3`. Avoid the older, unmaintained packages to prevent security vulnerabilities and unpatched bugs.
• breaking The initial release of `cli-table3` (v0.4.0) introduced breaking changes compared to `cli-table2` (e.g., removal of 'lodash' dependency, internal refactors). While API compatible at a high level, direct migration from `cli-table2` might require minor adjustments if relying on specific internals or removed dependencies.
  Fix: Review the changelog for v0.4.0 and higher when migrating from `cli-table2`. Test your application thoroughly after upgrading.

Install

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

Imports

• Table
  wrong:

  import { Table } from 'cli-table3';

  correct:

  import Table from 'cli-table3';

  The primary `Table` class is exported as a default export in ESM. CommonJS uses `require('cli-table3')` directly.
• Table.TableOptions
  wrong:

  import { Table, TableOptions } from 'cli-table3';

  correct:

  import Table, { TableOptions } from 'cli-table3';

  Type definitions like `TableOptions` are available as named exports. Ensure you still use the default import for the `Table` class.
• CellOptions
  wrong:

  import { CellOptions } from 'cli-table3';

  correct:

  import type { CellOptions } from 'cli-table3';

  Import types using `import type` for clarity and to avoid bundling issues in some build setups.

Quickstart

Demonstrates creating a horizontal table with headers, custom column widths, and cell styling, including a column span. It also shows a basic vertical table setup.

import Table, { TableOptions, CellOptions } from 'cli-table3';

interface MyRow {
  header1: string | CellOptions;
  header2: string | CellOptions;
}

const tableConfig: TableOptions = {
  head: ['Project', 'Status', 'Progress'],
  colWidths: [30, 15, 20],
  wordWrap: true,
  style: {
    'header': ['cyan', 'bold'],
    'border': ['grey'],
    'compact': true
  }
};

const table = new Table(tableConfig);

// Add rows
table.push(
  ['CLI Table 3', { content: 'Active', style: { fg: 'green' } }, '100%'],
  ['Feature A', 'In Development', { content: '60%', style: { fg: 'yellow' } }],
  ['Feature B', { content: 'On Hold', style: { fg: 'red' } }, '10%'],
  [{ content: 'Total tasks: 3', colSpan: 3, hAlign: 'center' }]
);

console.log(table.toString());

// Example of a vertical table
const verticalTable = new Table();
verticalTable.push(
  { 'Name': 'Alice' },
  { 'Age': '30' },
  { 'City': 'New York' }
);
console.log('\n--- Vertical Table ---\n');
console.log(verticalTable.toString());