cli-table3

这个工具允许你在命令行中从Node.js脚本渲染带有Unicode辅助的表格。

cli-table3基于（并且API兼容）原始的cli-table和cli-table2，这两个项目都已不再维护。cli-table3包含了cli-table2的所有附加功能。

原始cli-table中没有的功能

能够使单元格跨列和/或跨行。
能够为每个单元格设置自定义样式（边框字符/颜色、内边距等）。
垂直对齐（顶部、底部、居中）。
自动换行选项。
更强大的包含ANSI颜色字符的单元格文本截断。
更好地处理跨多行的文本颜色。
与原始cli-table API兼容。
全面的测试套件，包括整个原始cli-table测试套件。
大量从测试自动生成的示例（基础、高级）。

功能

可自定义构成表格的字符。
通过@colors/colors在表头中进行颜色/背景样式设置。
列宽自定义。
基于预定义宽度的文本截断。
文本对齐（左对齐、右对齐、居中）。
内边距（左、右）。
易于使用的API。

安装

npm install cli-table3

如何使用

部分单元测试套件用于生成示例：

基础用法 - 涵盖基本用法。
高级用法 - 涵盖使用新的列和行跨度功能。

这个包与原始的cli-table在API上兼容。因此所有原始文档仍然适用（如下所示）。

横向表格

var Table = require('cli-table3');

// 实例化
var table = new Table({
    head: ['表头1', '表头2']
  , colWidths: [100, 200]
});

// table是一个数组，所以你可以使用`push`、`unshift`、`splice`等方法
table.push(
    ['第一个值', '第二个值']
  , ['第一个值', '第二个值']
);

console.log(table.toString());

纵向表格

var Table = require('cli-table3');
var table = new Table();

table.push(
    { '某个键': '某个值' }
  , { '另一个键': '另一个值' }
);

console.log(table.toString());

交叉表格

交叉表格与纵向表格非常相似，但有两个主要区别：

实例化时需要设置head，且第一个表头为空字符串
单个行的一般形式为 { "表头": ["行", "值"] }

var Table = require('cli-table3');
var table = new Table({ head: ["", "顶部表头1", "顶部表头2"] });

table.push(
    { '左侧表头1': ['第1行第1列值', '第1行第2列值'] }
  , { '左侧表头2': ['第2行第1列值', '第2行第2列值'] }
);

console.log(table.toString());

自定义样式

chars 属性控制表格的绘制方式：

var table = new Table({
  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': '│' }
});

table.push(
    ['foo', 'bar', 'baz']
  , ['frob', 'bar', 'quuz']
);

console.log(table.toString());
// 输出:
//
//╔══════╤═════╤══════╗
//║ foo  │ bar │ baz  ║
//╟──────┼─────┼──────╢
//║ frob │ bar │ quuz ║
//╚══════╧═════╧══════╝

空的装饰线将被跳过。要避免垂直分隔行，只需将 'mid'、'left-mid'、'mid-mid'、'right-mid' 设置为空字符串：

var table = new Table({ chars: {'mid': '', 'left-mid': '', 'mid-mid': '', 'right-mid': ''} });
table.push(
    ['foo', 'bar', 'baz']
  , ['frobnicate', 'bar', 'quuz']
);

console.log(table.toString());
// 输出: (注意行之间缺少水平线)
//┌────────────┬─────┬──────┐
//│ foo        │ bar │ baz  │
//│ frobnicate │ bar │ quuz │
//└────────────┴─────┴──────┘

通过将所有字符设置为空，只将 'middle' 设置为单个空格，并将内边距设置为零，可以得到最紧凑的布局，没有任何装饰：

var table = new Table({
  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: { 'padding-left': 0, 'padding-right': 0 }
});

table.push(
    ['foo', 'bar', 'baz']
  , ['frobnicate', 'bar', 'quuz']
);

console.log(table.toString());
// 输出:
//foo        bar baz
//frobnicate bar quuz

调试

cli-table3 的后续版本支持调试表格数据。

启用并使用调试：

var table = new Table({ debug: 1 });
table.push([{}, {},}); // 等等

console.log(table.toString());
table.messages.forEach((message) => console.log(message));

如果你在调试模式下渲染多个表格，请在渲染每个表格后运行 Table.reset()。