mirror of
https://github.com/nsnail/spectre.console.git
synced 2025-06-20 13:48:16 +08:00
Use file scoped namespace declarations
This commit is contained in:
Patrik Svensson
committed by
Phil Scott
Phil Scott
parent
1dbaf50935
commit
ec1188b837
@ -1,127 +1,126 @@
|
||||
using System;
|
||||
using System.Threading.Tasks;
|
||||
|
||||
namespace Spectre.Console
|
||||
namespace Spectre.Console;
|
||||
|
||||
/// <summary>
|
||||
/// Represents a status display.
|
||||
/// </summary>
|
||||
public sealed class Status
|
||||
{
|
||||
private readonly IAnsiConsole _console;
|
||||
|
||||
/// <summary>
|
||||
/// Represents a status display.
|
||||
/// Gets or sets the spinner.
|
||||
/// </summary>
|
||||
public sealed class Status
|
||||
public Spinner? Spinner { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the spinner style.
|
||||
/// </summary>
|
||||
public Style? SpinnerStyle { get; set; } = new Style(foreground: Color.Yellow);
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets a value indicating whether or not status
|
||||
/// should auto refresh. Defaults to <c>true</c>.
|
||||
/// </summary>
|
||||
public bool AutoRefresh { get; set; } = true;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="Status"/> class.
|
||||
/// </summary>
|
||||
/// <param name="console">The console.</param>
|
||||
public Status(IAnsiConsole console)
|
||||
{
|
||||
private readonly IAnsiConsole _console;
|
||||
_console = console ?? throw new ArgumentNullException(nameof(console));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the spinner.
|
||||
/// </summary>
|
||||
public Spinner? Spinner { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the spinner style.
|
||||
/// </summary>
|
||||
public Style? SpinnerStyle { get; set; } = new Style(foreground: Color.Yellow);
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets a value indicating whether or not status
|
||||
/// should auto refresh. Defaults to <c>true</c>.
|
||||
/// </summary>
|
||||
public bool AutoRefresh { get; set; } = true;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="Status"/> class.
|
||||
/// </summary>
|
||||
/// <param name="console">The console.</param>
|
||||
public Status(IAnsiConsole console)
|
||||
/// <summary>
|
||||
/// Starts a new status display.
|
||||
/// </summary>
|
||||
/// <param name="status">The status to display.</param>
|
||||
/// <param name="action">The action to execute.</param>
|
||||
public void Start(string status, Action<StatusContext> action)
|
||||
{
|
||||
var task = StartAsync(status, ctx =>
|
||||
{
|
||||
_console = console ?? throw new ArgumentNullException(nameof(console));
|
||||
action(ctx);
|
||||
return Task.CompletedTask;
|
||||
});
|
||||
|
||||
task.GetAwaiter().GetResult();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Starts a new status display.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The result type.</typeparam>
|
||||
/// <param name="status">The status to display.</param>
|
||||
/// <param name="func">The action to execute.</param>
|
||||
/// <returns>The result.</returns>
|
||||
public T Start<T>(string status, Func<StatusContext, T> func)
|
||||
{
|
||||
var task = StartAsync(status, ctx => Task.FromResult(func(ctx)));
|
||||
return task.GetAwaiter().GetResult();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Starts a new status display.
|
||||
/// </summary>
|
||||
/// <param name="status">The status to display.</param>
|
||||
/// <param name="action">The action to execute.</param>
|
||||
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
|
||||
public async Task StartAsync(string status, Func<StatusContext, Task> action)
|
||||
{
|
||||
if (action is null)
|
||||
{
|
||||
throw new ArgumentNullException(nameof(action));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Starts a new status display.
|
||||
/// </summary>
|
||||
/// <param name="status">The status to display.</param>
|
||||
/// <param name="action">The action to execute.</param>
|
||||
public void Start(string status, Action<StatusContext> action)
|
||||
_ = await StartAsync<object?>(status, async statusContext =>
|
||||
{
|
||||
var task = StartAsync(status, ctx =>
|
||||
{
|
||||
action(ctx);
|
||||
return Task.CompletedTask;
|
||||
});
|
||||
await action(statusContext).ConfigureAwait(false);
|
||||
return default;
|
||||
}).ConfigureAwait(false);
|
||||
}
|
||||
|
||||
task.GetAwaiter().GetResult();
|
||||
/// <summary>
|
||||
/// Starts a new status display and returns a result.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The result type of task.</typeparam>
|
||||
/// <param name="status">The status to display.</param>
|
||||
/// <param name="func">The action to execute.</param>
|
||||
/// <returns>A <see cref="Task{T}"/> representing the asynchronous operation.</returns>
|
||||
public async Task<T> StartAsync<T>(string status, Func<StatusContext, Task<T>> func)
|
||||
{
|
||||
if (func is null)
|
||||
{
|
||||
throw new ArgumentNullException(nameof(func));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Starts a new status display.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The result type.</typeparam>
|
||||
/// <param name="status">The status to display.</param>
|
||||
/// <param name="func">The action to execute.</param>
|
||||
/// <returns>The result.</returns>
|
||||
public T Start<T>(string status, Func<StatusContext, T> func)
|
||||
// Set the progress columns
|
||||
var spinnerColumn = new SpinnerColumn(Spinner ?? Spinner.Known.Default)
|
||||
{
|
||||
var task = StartAsync(status, ctx => Task.FromResult(func(ctx)));
|
||||
return task.GetAwaiter().GetResult();
|
||||
}
|
||||
Style = SpinnerStyle ?? Style.Plain,
|
||||
};
|
||||
|
||||
/// <summary>
|
||||
/// Starts a new status display.
|
||||
/// </summary>
|
||||
/// <param name="status">The status to display.</param>
|
||||
/// <param name="action">The action to execute.</param>
|
||||
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
|
||||
public async Task StartAsync(string status, Func<StatusContext, Task> action)
|
||||
var progress = new Progress(_console)
|
||||
{
|
||||
if (action is null)
|
||||
{
|
||||
throw new ArgumentNullException(nameof(action));
|
||||
}
|
||||
FallbackRenderer = new FallbackStatusRenderer(),
|
||||
AutoClear = true,
|
||||
AutoRefresh = AutoRefresh,
|
||||
};
|
||||
|
||||
_ = await StartAsync<object?>(status, async statusContext =>
|
||||
{
|
||||
await action(statusContext).ConfigureAwait(false);
|
||||
return default;
|
||||
}).ConfigureAwait(false);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Starts a new status display and returns a result.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The result type of task.</typeparam>
|
||||
/// <param name="status">The status to display.</param>
|
||||
/// <param name="func">The action to execute.</param>
|
||||
/// <returns>A <see cref="Task{T}"/> representing the asynchronous operation.</returns>
|
||||
public async Task<T> StartAsync<T>(string status, Func<StatusContext, Task<T>> func)
|
||||
progress.Columns(new ProgressColumn[]
|
||||
{
|
||||
if (func is null)
|
||||
{
|
||||
throw new ArgumentNullException(nameof(func));
|
||||
}
|
||||
|
||||
// Set the progress columns
|
||||
var spinnerColumn = new SpinnerColumn(Spinner ?? Spinner.Known.Default)
|
||||
{
|
||||
Style = SpinnerStyle ?? Style.Plain,
|
||||
};
|
||||
|
||||
var progress = new Progress(_console)
|
||||
{
|
||||
FallbackRenderer = new FallbackStatusRenderer(),
|
||||
AutoClear = true,
|
||||
AutoRefresh = AutoRefresh,
|
||||
};
|
||||
|
||||
progress.Columns(new ProgressColumn[]
|
||||
{
|
||||
spinnerColumn,
|
||||
new TaskDescriptionColumn(),
|
||||
});
|
||||
});
|
||||
|
||||
return await progress.StartAsync(async ctx =>
|
||||
{
|
||||
var statusContext = new StatusContext(ctx, ctx.AddTask(status), spinnerColumn);
|
||||
return await func(statusContext).ConfigureAwait(false);
|
||||
}).ConfigureAwait(false);
|
||||
}
|
||||
return await progress.StartAsync(async ctx =>
|
||||
{
|
||||
var statusContext = new StatusContext(ctx, ctx.AddTask(status), spinnerColumn);
|
||||
return await func(statusContext).ConfigureAwait(false);
|
||||
}).ConfigureAwait(false);
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,76 +1,75 @@
|
||||
using System;
|
||||
|
||||
namespace Spectre.Console
|
||||
namespace Spectre.Console;
|
||||
|
||||
/// <summary>
|
||||
/// Represents a context that can be used to interact with a <see cref="Status"/>.
|
||||
/// </summary>
|
||||
public sealed class StatusContext
|
||||
{
|
||||
private readonly ProgressContext _context;
|
||||
private readonly ProgressTask _task;
|
||||
private readonly SpinnerColumn _spinnerColumn;
|
||||
|
||||
/// <summary>
|
||||
/// Represents a context that can be used to interact with a <see cref="Status"/>.
|
||||
/// Gets or sets the current status.
|
||||
/// </summary>
|
||||
public sealed class StatusContext
|
||||
public string Status
|
||||
{
|
||||
private readonly ProgressContext _context;
|
||||
private readonly ProgressTask _task;
|
||||
private readonly SpinnerColumn _spinnerColumn;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the current status.
|
||||
/// </summary>
|
||||
public string Status
|
||||
{
|
||||
get => _task.Description;
|
||||
set => SetStatus(value);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the current spinner.
|
||||
/// </summary>
|
||||
public Spinner Spinner
|
||||
{
|
||||
get => _spinnerColumn.Spinner;
|
||||
set => SetSpinner(value);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the current spinner style.
|
||||
/// </summary>
|
||||
public Style? SpinnerStyle
|
||||
{
|
||||
get => _spinnerColumn.Style;
|
||||
set => _spinnerColumn.Style = value;
|
||||
}
|
||||
|
||||
internal StatusContext(ProgressContext context, ProgressTask task, SpinnerColumn spinnerColumn)
|
||||
{
|
||||
_context = context ?? throw new ArgumentNullException(nameof(context));
|
||||
_task = task ?? throw new ArgumentNullException(nameof(task));
|
||||
_spinnerColumn = spinnerColumn ?? throw new ArgumentNullException(nameof(spinnerColumn));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Refreshes the status.
|
||||
/// </summary>
|
||||
public void Refresh()
|
||||
{
|
||||
_context.Refresh();
|
||||
}
|
||||
|
||||
private void SetStatus(string status)
|
||||
{
|
||||
if (status is null)
|
||||
{
|
||||
throw new ArgumentNullException(nameof(status));
|
||||
}
|
||||
|
||||
_task.Description = status;
|
||||
}
|
||||
|
||||
private void SetSpinner(Spinner spinner)
|
||||
{
|
||||
if (spinner is null)
|
||||
{
|
||||
throw new ArgumentNullException(nameof(spinner));
|
||||
}
|
||||
|
||||
_spinnerColumn.Spinner = spinner;
|
||||
}
|
||||
get => _task.Description;
|
||||
set => SetStatus(value);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the current spinner.
|
||||
/// </summary>
|
||||
public Spinner Spinner
|
||||
{
|
||||
get => _spinnerColumn.Spinner;
|
||||
set => SetSpinner(value);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the current spinner style.
|
||||
/// </summary>
|
||||
public Style? SpinnerStyle
|
||||
{
|
||||
get => _spinnerColumn.Style;
|
||||
set => _spinnerColumn.Style = value;
|
||||
}
|
||||
|
||||
internal StatusContext(ProgressContext context, ProgressTask task, SpinnerColumn spinnerColumn)
|
||||
{
|
||||
_context = context ?? throw new ArgumentNullException(nameof(context));
|
||||
_task = task ?? throw new ArgumentNullException(nameof(task));
|
||||
_spinnerColumn = spinnerColumn ?? throw new ArgumentNullException(nameof(spinnerColumn));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Refreshes the status.
|
||||
/// </summary>
|
||||
public void Refresh()
|
||||
{
|
||||
_context.Refresh();
|
||||
}
|
||||
|
||||
private void SetStatus(string status)
|
||||
{
|
||||
if (status is null)
|
||||
{
|
||||
throw new ArgumentNullException(nameof(status));
|
||||
}
|
||||
|
||||
_task.Description = status;
|
||||
}
|
||||
|
||||
private void SetSpinner(Spinner spinner)
|
||||
{
|
||||
if (spinner is null)
|
||||
{
|
||||
throw new ArgumentNullException(nameof(spinner));
|
||||
}
|
||||
|
||||
_spinnerColumn.Spinner = spinner;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user