Flutter命令行表格生成插件cli_table的使用

cli_table 是一个 Dart 包，它通过在终端中显示静态表格数据来增强用户体验。以下是该包的主要功能和一些使用示例。

Features

• 在终端内以表格格式显示数据。
• 提供易于使用的API。
• 通过chalkdart对表头进行颜色/背景样式设置。
• 自定义列宽。
• 支持列和行单元格跨越。
• 根据预定义宽度的内容截断。
• 水平内容对齐（左/中/右）。
• 垂直内容对齐（顶/中/底）。
• 内边距（左右）。
• 单词换行选项。
• 每个单元格的自定义。

Basic Example

import 'package:cli_table/cli_table.dart';

void main() {
  final table = Table(
    header: ['Rel', 'Change', "By", "When"], // Set headers
    columnWidths: [10, 20, 20, 30], // Optionally set column widths
  );

  // Table class extends dart List,
  // so you're free to use all the usual List methods
  table
    ..add(['v0.1', 'First test', 'someone@gmail.com', '9 minutes ago'])
    ..add(['v0.1', 'Second test', 'other@gmail.com', '13 minutes ago']);

  // Call `toString()` to render the final table for output
  print(table.toString());
}

Table Types and Layouts

Horizontal Tables

final table = Table(
  header: ['Index', 'Name'],
);

table.addAll([
  ['1.', 'First'],
  ['2.', 'Second'],
]);

print(table.toString());

Vertical Tables

final table = Table();

table.addAll([
  {'Some key': 'Some value'},
  {'Another key': 'Another value'},
]);

print(table.toString());

Cross Tables

final table = Table(header: ["", "Top Header 1", "Top Header 2"]);

table.addAll([
  {
    'Left Header 1': ['Value Row 1 Col 1', 'Value Row 1 Col 2']
  },
  {
    'Left Header 2': ['Value Row 2 Col 1', 'Value Row 2 Col 2']
  }
]);

print(table.toString());

Other Usage Examples with Different Table Options

Wrap Text on Word Boundaries

final table = Table(
  style: TableStyle(
    border: [], // Clear border style/color (default is ["gray"])
    header: [], // Clear header style/color (defaults to ['red'])
  ),
  columnWidths: [7, 9], // Requires fixed column widths
  wordWrap: true,
);

table.addAll([
  [
    'Hello how are you?',
    'I am fine thanks! Looooooong',
    ['Words that exceed', 'the columnWidth will', 'be truncated.'].join('\n'),
    ['Text is only', 'wrapped for', 'fixed width', 'columns.'].join('\n'),
  ]
]);

print(table.toString());

Use columnSpan to Span Columns

final table = Table();

table.addAll([
  [{'colSpan': 2, 'content': 'First'}], // Set custom column span
  [{'colSpan': 2, 'content': 'Second'}],
  ['Third', 'Fourth']
]);

Use rowSpan to Span Rows

final table = Table();

table.addAll([
  [
    {'rowSpan': 2, 'content': 'First'}, // Set custom row span
    {'rowSpan': 2, 'content': 'Second', 'vAlign': VerticalAlign.center}, // Set custom horizontal alignment
    'hello'
  ],
  ['howdy']
]);

Credits

• Automattic/cli-table
• jamestalmage/cli-table2
• cli-table/cli-table3

示例代码

下面是一个更复杂的例子，展示了如何使用 cli_table 和 chalkdart 来创建一个带有样式和跨行/列功能的测试覆盖率报告。

import 'package:chalkdart/chalk.dart';
import 'package:cli_table/cli_table.dart';

void main() {
  // 1. Instantiate Table instance and set options
  final table = Table(
    header: [
      {
        'content': 'Test Coverage Report',
        'colSpan': 6,
        'hAlign': HorizontalAlign.center
      },
    ],
    style: TableStyle(header: ['blue']),
  );

  // 2. Add table data
  table.addAll([
    [
      'Module',
      'Component',
      'Test Cases',
      'Failures',
      'Durations',
      'Success Rate'
    ],
    [
      {
        'rowSpan': 2,
        'content': chalk.grey('Services'),
        'vAlign': VerticalAlign.center
      },
      'User',
      50,
      4,
      '3m 7s',
      chalk.bgGreen.black(' 92.0% ')
    ],
    ['Payment', 100, 80, '7m 15s', chalk.yellow(' 80.0% ')],
    [
      {
        'content': chalk.underline.grey('Subtotal'),
        'colSpan': 2,
        'hAlign': HorizontalAlign.right
      },
      150,
      84,
      '10m 22s',
      chalk.bgRed.black(' 38.3% ')
    ],
    [
      {
        'rowSpan': 2,
        'content': chalk.grey('Controllers'),
        'vAlign': VerticalAlign.center
      },
      'User',
      24,
      18,
      '1m 30s',
      chalk.yellow(' 75.0% ')
    ],
    ['Payment', 30, 2, '50s', chalk.bgGreen.black(' 98.9% ')],
    [
      {
        'content': chalk.underline.grey('Subtotal'),
        'colSpan': 2,
        'hAlign': HorizontalAlign.right
      },
      54,
      42,
      '2m 20s',
      chalk.yellow(' 77.3% ')
    ],
    [
      {
        'content': chalk.underline.bold('TOTAL'),
        'colSpan': 2,
        'hAlign': HorizontalAlign.right
      },
      chalk.bold(204),
      152,
      '12m 42s',
      chalk.yellow(' 74.5% ')
    ],
  ]);

  // 3. Output to console
  print(table.toString());
}

这个示例展示了如何使用 cli_table 创建一个详细的测试覆盖率报告，并利用 chalkdart 添加颜色和样式。希望这些信息对你有帮助！