终端输出 Table？不要再用 console.table 了！这个 Node.js 库值得尝试下~

五月君

发布于 2024-03-19 14:46:49

1760

发布于 2024-03-19 14:46:49

使用 Table 将一组数据打印在终端，你最先想到的是什么？console.table()？

以前我是这样做的！近期发现了一个有意思的 NPM 库 voici.js 在输出到终端时可以将数据做一些格式化，当一组数据特别大时，使用该库的效果会更加的理想。

voici.js 是用 TypeScript 编写的一个 Node.js 库，相比于 Node.js 原生的 console.table()，它提供的功能会更多些。主要功能包括：文本、列和行样式设置、高亮显示和过滤、动态列、列大小调整、最大和最小值计算、表格导出、类型系统、排序等。

示例一

一个简单的示例，输出为左对齐且设置表头颜色。

import { Table } from 'voici.js'
const data = [
  { firstname: 'Homer', lastname: 'Simpson', age: 39 },
  { firstname: 'Marge', lastname: 'Simpson', age: 36 },
  { firstname: 'Bart', lastname: 'Simpson', age: 10 },
  { firstname: 'Lisa', lastname: 'Simpson', age: 8 },
  { firstname: 'Maggie', lastname: 'Simpson', age: 1 }
];
const config = {
  align: 'LEFT',
  header: {
    bgColor: '#6184D8',
    textColor: '#d8b561'
  }
};
const table = new Table(data, config);
table.print();

示例二

在处理一些大文本或者说列的内容较多时，通过设置列宽让其强制换行。下例中我还为此加上了 border。

const data = [
  {
    small: 'Lorem ipsum dolor sit amet',
    medium: 'At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet',
    large: 'Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.'
  },
  {
    small: 'Lorem ipsum dolor sit amet',
    medium: 'At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet',
    large: 'Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.'
  }
];
const config = {
  header: { width: 30 },
  border: { horizontal: '-', vertical: '|' }
};
const table = new Table(data, config);
table.print();

示例三

指定下排序规则并对某些列的值做一些高亮显示，最后使用其提供的 .exportFile() 方法将表格导出为 .txt 格式的文件

import { Table } from 'voici.js'
const data = [
  { firstname: 'Marge', lastname: 'Simpson', age: 36 },
  { firstname: 'Homer', lastname: 'Simpson', age: 39 },
  { firstname: 'Peter', lastname: 'Griffin', age: 42 },
  { firstname: 'Lois', lastname: 'Griffin', age: 43 }
];
const config = {
  sort: {
    columns: ['lastname', 'age'],
    directions: ['asc', 'desc']
  },
  body: {
    highlightCell: {
      textColor: '#F39B6D',
      func: (cell) => cell === "Marge" || cell === "Griffin"
    }
  }
};

const table = new Table(data, config);
table.print();
table.exportFile('export.txt');