ShellProgressBar 5.2.0

ShellProgressBar

在控制台应用程序中可视化（并发）进度

这是一个很好的小库，可以可视化长时间运行的命令行任务。

.NET Core 兼容！

它还支持启动子进度条，这允许您非常不错地可视化依赖关系和并发。

已在 OSX 上进行测试

和 Windows 上

（PowerShell 也可以，请参阅下面的示例）

安装

在 NuGet 上获取它： https://nuget.net.cn/packages/ShellProgressBar/

使用方法

使用方法非常简单

const int totalTicks = 10;
var options = new ProgressBarOptions
{
    ProgressCharacter = '─',
    ProgressBarOnBottom = true
};
using (var pbar = new ProgressBar(totalTicks, "Initial message", options))
{
    pbar.Tick(); //will advance pbar to 1 out of 10.
    //we can also advance and update the progressbar text
    pbar.Tick("Step 2 of 10"); 
}

报告进度

有两种方法可以报告进度。您可以使用上面描述的 Tick() 函数。或者，您可以通过调用进度条对象的 AsProgress<T>() 以获得 IProgress<T> 实例来报告进度。

对于进度类型是介于 0.0 和 1.0 之间的 float 值的简单情况，表示完成百分比，请使用 progressBar.AsProgress<float>()

using ProgressBar progressBar = new ProgressBar(10000, "My Progress Message");
IProgress progress = progressBar.AsProgress<float>();
progress.Report(0.25); // Advances the progress bar to 25%

请在 src/ShellProgressBar.Example/Examples 目录中的 IntegrationWithIProgressExample.cs 和 IntegrationWithIProgressPercentageExample.cs 中查看完整示例。

选项

进度条位置

const int totalTicks = 10;
var options = new ProgressBarOptions
{
	ProgressCharacter = '─',
	ProgressBarOnBottom = true
};
using (var pbar = new ProgressBar(totalTicks, "progress bar is on the bottom now", options))
{
	TickToCompletion(pbar, totalTicks, sleep: 500);
}

默认情况下，进度条位于顶部，消息位于底部。如果需要，可以将其翻转。

样式更改

const int totalTicks = 10;
var options = new ProgressBarOptions
{
	ForegroundColor = ConsoleColor.Yellow,
	ForegroundColorDone = ConsoleColor.DarkGreen,
	BackgroundColor = ConsoleColor.DarkGray,
	BackgroundCharacter = '\u2593'
};
using (var pbar = new ProgressBar(totalTicks, "showing off styling", options))
{
	TickToCompletion(pbar, totalTicks, sleep: 500);
}

可以样式化的方面很多，包括前景色、背景（非活动部分）以及完成时的颜色变化。

无实时更新

默认情况下，计时器每500毫秒绘制屏幕一次。您可以将进度条配置为仅在调用.Tick()时绘制。

const int totalTicks = 5;
var options = new ProgressBarOptions
{
	DisplayTimeInRealTime = false
};
using (var pbar = new ProgressBar(totalTicks, "only draw progress on tick", options))
{
	TickToCompletion(pbar, totalTicks, sleep:1750);
}

如果您查看经过的时间，您会看到它跳过了02:00。

后代进度条

进度条可以产生子进度条，每个子进度条都可以产生自己的进度条。每个子进度条都有自己的样式选项。

这对于可视化并发运行的任务来说非常出色。

const int totalTicks = 10;
var options = new ProgressBarOptions
{
	ForegroundColor = ConsoleColor.Yellow,
	BackgroundColor = ConsoleColor.DarkYellow,
	ProgressCharacter = '─'
};
var childOptions = new ProgressBarOptions
{
	ForegroundColor = ConsoleColor.Green,
	BackgroundColor = ConsoleColor.DarkGreen,
	ProgressCharacter = '─'
};
using (var pbar = new ProgressBar(totalTicks, "main progressbar", options))
{
	TickToCompletion(pbar, totalTicks, sleep: 10, childAction: () =>
	{
		using (var child = pbar.Spawn(totalTicks, "child actions", childOptions))
		{
			TickToCompletion(child, totalTicks, sleep: 100);
		}
	});
}

默认情况下，子进度条完成时会折叠，为新的/并行的进度条腾出空间。

您可以指定CollapseWhenFinished = false来保留它们。

var childOptions = new ProgressBarOptions
{
	ForegroundColor = ConsoleColor.Green,
	BackgroundColor = ConsoleColor.DarkGreen,
	ProgressCharacter = '─',
	CollapseWhenFinished = false
};

FixedDurationBar

ProgressBar非常适合可视化未知运行时间的任务。如果您有一个您知道需要固定时间量的任务，还有一个名为FixedDurationBar的子类。FixedDurationBar将自动调用Tick()，但除此之外，所有选项和用法都是相同的。但除了它依赖于实时更新功能，禁用该功能将引发错误。

FixedDurationBar公开了一个IsCompleted和CompletedHandle。

致谢

初始实现受到了这篇文章的启发。[链接](http://www.bytechaser.com/en/articles/ckcwh8nsyt/display-progress-bar-in-console-application-in-c.aspx)

显然，任何向此存储库发送PR的人 😍