Flutter控制台调试插件dart_console3的使用

Flutter控制台调试插件dart_console3的使用

A Dart library for building console applications.

该库包含一系列用于控制台应用程序开发的有用功能，包括：

• 读取当前窗口尺寸（高度、宽度）
• 读取和设置光标位置
• 设置前景色和背景色
• 将控制台切换到“原始模式”，这允许比默认的dart:io库更高级的键盘输入处理。
• 从键盘读取键和控制序列
• 在屏幕上写入对齐文本

该库已被用于实现一个Dart版本的Kilo文本编辑器；编译为Dart时会生成一个独立的kilo可执行文件。该库足以支持一组相当完整的用法，包括readline风格的CLI和基本的文字游戏。

该库假定终端能够识别并实现常见的ANSI转义序列。该包已在macOS、Linux和Windows 10上进行了测试。Windows支持是初步的——该库在Windows Terminal和cmd上进行了测试，但在不支持ANSI转义序列的老版本Windows上，某些功能将无法工作。

该库使用win32包通过FFI访问Win32 API。该包包含许多使用Dart FFI进行复杂示例的案例。

使用

简单示例

import 'package:dart_console3/dart_console.dart';

void main() {
  final console = Console();

  console.clearScreen(); // 清除屏幕
  console.resetCursorPosition(); // 重置光标位置

  console.writeLine(
    'Console size is ${console.windowWidth} 列和 ${console.windowHeight} 行。',
    TextAlignment.center, // 文本居中对齐
  );

  console.writeLine(); // 换行

  return 0;
}

更全面的示例

以下提供了更多关于Console类的综合演示示例：

完整示例DEMO

以下是一个完整的示例DEMO，展示了如何使用dart_console3插件进行控制台调试。

import 'package:dart_console3/ansi_writer/ansi_writer.dart';
import 'package:dart_console3/console/impl.dart';
import 'package:dart_console3/console/interface.dart';
import 'package:dart_console3/terminal/terminal_lib_auto.dart';

void main() {
  final console = SneathConsoleImpl(
    terminal: auto_sneath_terminal(),
  );

  // 设置背景颜色为蓝色
  console.set_background_color(
    const DarkAnsiBackgroundColorAdapter(
      NamedAnsiColorBlueImpl(),
    ),
  );

  // 设置前景色为白色
  console.set_foreground_color(
    const DarkAnsiForegroundColorAdapter(
      NamedAnsiColorWhiteImpl(),
    ),
  );

  // 写入居中对齐的文本
  console.write_line(
    '简单演示',
    ConsoleTextAlignments.center,
  );

  // 重置颜色属性
  console.reset_color_attributes();

  // 换行
  console.write_line();

  // 输出控制台的宽度和高度
  console.write_line(
    '此控制台窗口有 ${console.dimensions.width} 列和 ${console.dimensions.height} 行。',
  );

  // 换行
  console.write_line();

  // 左对齐文本
  console.write_line(
    '这是左对齐的文本。',
    ConsoleTextAlignments.left,
  );

  // 居中对齐文本
  console.write_line(
    '这是居中对齐的文本。',
    ConsoleTextAlignments.center,
  );

  // 右对齐文本
  console.write_line(
    '这是右对齐的文本。',
    ConsoleTextAlignments.right,
  );

  // 遍历颜色列表并设置前景色
  for (final color in const [
    DarkAnsiForegroundColorAdapter(NamedAnsiColorBlackImpl()),
    DarkAnsiForegroundColorAdapter(NamedAnsiColorRedImpl()),
    DarkAnsiForegroundColorAdapter(NamedAnsiColorGreenImpl()),
    DarkAnsiForegroundColorAdapter(NamedAnsiColorYellowImpl()),
    DarkAnsiForegroundColorAdapter(NamedAnsiColorBlueImpl()),
    DarkAnsiForegroundColorAdapter(NamedAnsiColorMagentaImpl()),
    DarkAnsiForegroundColorAdapter(NamedAnsiColorCyanImpl()),
    DarkAnsiForegroundColorAdapter(NamedAnsiColorWhiteImpl()),
    BrightAnsiForegroundColorAdapter(NamedAnsiColorBlackImpl()),
    BrightAnsiForegroundColorAdapter(NamedAnsiColorRedImpl()),
    BrightAnsiForegroundColorAdapter(NamedAnsiColorGreenImpl()),
    BrightAnsiForegroundColorAdapter(NamedAnsiColorYellowImpl()),
    BrightAnsiForegroundColorAdapter(NamedAnsiColorBlueImpl()),
    BrightAnsiForegroundColorAdapter(NamedAnsiColorMagentaImpl()),
    BrightAnsiForegroundColorAdapter(NamedAnsiColorCyanImpl()),
    BrightAnsiForegroundColorAdapter(NamedAnsiColorWhiteImpl()),
  ]) {
    console.set_foreground_color(color);
    console.write_line(color.name);
  }

  // 重置颜色属性
  console.reset_color_attributes();
}