Flutter控制台输出与样式插件consola的使用

Consola

Consola 是一个用于帮助在 Dart 中开发命令行应用程序的实用库。它提供了屏幕操作、ANSI 转义码等功能。

目录

• 开始使用
• 光标操作
• 屏幕操作
• 颜色
• 尺寸
• 用户输入
• 组件
  • 进度条
• ANSI 转义码
• 模拟

开始使用

在 pubspec.yaml 文件中添加依赖：

dependencies:
  consola: <version>

光标操作

你可以移动光标的位置。

void main() {
  Console.moveUp();
  Console.moveTo(22, 41);
  Console.moveToTopLeft();
}

屏幕操作

你可以清除屏幕的不同部分。

void main() {
  Console.clearScreen();
  Console.clearLine();
  Console.clearCurrentToStartScreen();
}

颜色

你可以为文本添加颜色。

void main() {
  Console.write('Hello ', foregroundColor: SimpleColor.green);
  Console.write('World', backgroundColor: SimpleColor.red);
}

尺寸

你可以获取终端的尺寸。

void main() {
  int width = Console.getWindowWidth();
  int height = Console.getWindowHeight();
}

用户输入

你可以以类型安全的方式读取用户输入。

void main() {
  int? age = Console.readInt(prompt: 'Enter your age: ');
  Console.writeLine('You are $age years old.');
}

组件

有一些组件可以帮助你加快命令行应用的开发。

状态存储在组件中。可以通过调用 Console.draw(component) 来绘制组件。

进度条

这是一个水平进度条。

void main() {
  Console.clearScreen();

  final progressBar = ProgressBar.atPosition(
    total: 50,
    width: 100,
    position: ConsoleCoordinate(1, 2),
    head: 'Progress A: ',
    barFillCharacter: '#',
    tailBuilder: (_, __, percent) => ' ${percent.toStringAsFixed(0)}%',
  );

  for (var i = 0; i <= 50; i++) {
    progressBar.current = i;
    Console.draw(progressBar);
    sleep(Duration(milliseconds: 50));
  }
}

ANSI 转义码

你可以通过访问 ConsoleStrings 类来访问底层的 ANSI 转义码。

void main() {
  String eraseScreen = ConsoleStrings.eraseScreen;
  String esc = ConsoleStrings.escape;
  String csi = ConsoleStrings.csi;
}

模拟

你可以通过将 Console.instance 设置为模拟对象来模拟 Console。

import 'package:your_package/gen/env.g.dart';

class MockConsoleExecutor extends ConsoleExecutor {
  [@override](/user/override)
  void clearScreen({bool resetCursor = true}) {
    print('Screen cleared');
  }
}

void main() {
  Console.clearScreen(); // 清除屏幕
  Console.instance = MockConsoleExecutor();
  Console.clearScreen(); // 打印 "Screen cleared"
}