Kurukuru 终端旋转器库使用教程

Kurukuru 终端旋转器库使用教程

Kurukuru Terminal Spinner for .NET platform 项目地址: https://gitcode.com/gh_mirrors/ku/Kurukuru

1. 项目介绍

Kurukuru 是一个为 .NET 平台设计的终端旋转器库，适用于 .NET Framework、.NET Standard 和 .NET 5。该库的主要功能是在终端中显示旋转器动画，以指示正在进行的操作。Kurukuru 的设计灵感来自于 cli-spinners、ora 和 CLISpinner 等项目。

主要特性

• 非 Unicode 编码页支持：在 Windows 环境下，如果终端使用非 Unicode 编码页（如 CP437:EN-US、CP932:JA-JP），库会默认使用 ASCII 字符旋转器。
• 非交互式上下文自动禁用旋转器：当标准输出被重定向时（例如在 CI 环境中），旋转器会自动禁用，仅显示结果文本。

2. 项目快速启动

安装

你可以通过 NuGet 包管理器或 dotnet 命令行工具安装 Kurukuru。

使用 NuGet 包管理器

Install-Package Kurukuru

使用 dotnet 命令行工具

dotnet add package Kurukuru

基本使用

以下是一个简单的示例，展示如何在 .NET 项目中使用 Kurukuru 显示旋转器。

using Kurukuru;
using System;
using System.Threading;

class Program
{
    static void Main(string[] args)
    {
        // 启动旋转器并执行操作
        Spinner.Start("处理中...", spinner =>
        {
            Thread.Sleep(3000); // 模拟长时间操作
            spinner.Text = "阶段 2...";
            Thread.Sleep(3000);
            spinner.Fail("出错了");
        });
    }
}

异步使用

Kurukuru 也支持异步操作，使用 StartAsync 方法可以方便地与异步代码集成。

using Kurukuru;
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        await Spinner.StartAsync("处理中...", async spinner =>
        {
            await Task.Delay(3000); // 模拟长时间操作
            spinner.Text = "阶段 2...";
            await Task.Delay(3000);
            spinner.Fail("出错了");
        });
    }
}

3. 应用案例和最佳实践

应用案例

Kurukuru 适用于需要长时间运行的命令行工具或后台任务。例如，在构建工具、CI/CD 流水线或数据处理脚本中，可以使用 Kurukuru 提供友好的用户反馈。

最佳实践

• 自定义旋转器样式：Kurukuru 允许你自定义旋转器的样式，包括旋转器的图案和颜色。你可以根据应用场景选择合适的样式。
• 错误处理：在旋转器中处理异常时，使用 Fail 方法可以清晰地向用户展示操作失败。
• 多阶段任务：对于多阶段任务，可以在不同阶段更新旋转器的文本，以提供更详细的进度信息。

4. 典型生态项目

Kurukuru 作为一个终端旋转器库，可以与其他 .NET 生态项目结合使用，提升用户体验。以下是一些典型的生态项目：

• Spectre.Console：一个功能强大的 .NET 终端 UI 库，可以与 Kurukuru 结合使用，提供更丰富的终端交互体验。
• Serilog：一个流行的 .NET 日志库，可以与 Kurukuru 结合使用，提供详细的日志记录和友好的终端输出。
• CommandLineParser：一个命令行参数解析库，可以与 Kurukuru 结合使用，提供命令行工具的完整解决方案。

通过结合这些生态项目，你可以构建功能更强大、用户体验更好的 .NET 命令行工具。

Kurukuru Terminal Spinner for .NET platform 项目地址: https://gitcode.com/gh_mirrors/ku/Kurukuru