Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

Task Description
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Build Builds the solution
Clean
Task[with]markup Handles [brackets]

51 changes: 51 additions & 0 deletions src/Cake.Cli.Tests/Unit/DescriptionScriptHostTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using Cake.Core;
using NSubstitute;
using Spectre.Console.Testing;

namespace Cake.Cli.Tests.Unit;

public class DescriptionScriptHostTests
{
public sealed class TheConstructor
{
[Fact]
public void Should_Throw_If_Console_Is_Null()
{
// Given
var engine = Substitute.For<ICakeEngine>();
var context = Substitute.For<ICakeContext>();

// When
var result = Record.Exception(() => new DescriptionScriptHost(engine, context, null));

// Then
AssertEx.IsArgumentNullException(result, "console");
}
}

[Fact]
public async Task RunTargetAsync_Prints_Task_Descriptions()
{
// Given
var console = new TestConsole();
var engine = Substitute.For<ICakeEngine>();
IReadOnlyList<ICakeTaskInfo> tasks =
[
new CakeTask("Build") { Description = "Builds the solution" },
new CakeTask("Clean") { Description = null },
new CakeTask("Task[with]markup") { Description = "Handles [brackets]" },
];
engine.Tasks.Returns(tasks);
var host = new DescriptionScriptHost(engine, Substitute.For<ICakeContext>(), console);

// When
await host.RunTargetAsync("Build");

// Then
await Verify(console.Output);
}
}
39 changes: 17 additions & 22 deletions src/Cake.Cli/Hosts/DescriptionScriptHost.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
using System.Threading.Tasks;
using Cake.Core;
using Cake.Core.Scripting;
using Spectre.Console;

namespace Cake.Cli;

Expand All @@ -15,20 +16,19 @@ namespace Cake.Cli;
/// </summary>
public class DescriptionScriptHost : ScriptHost
{
private readonly IConsole _console;
private readonly Dictionary<string, string> _descriptions;
private readonly IAnsiConsole _console;

/// <summary>
/// Initializes a new instance of the <see cref="DescriptionScriptHost"/> class.
/// </summary>
/// <param name="engine">The engine.</param>
/// <param name="context">The context.</param>
/// <param name="console">The console.</param>
public DescriptionScriptHost(ICakeEngine engine, ICakeContext context, IConsole console)
public DescriptionScriptHost(ICakeEngine engine, ICakeContext context, IAnsiConsole console)
: base(engine, context)
{
_console = console ?? throw new ArgumentNullException(nameof(console));
_descriptions = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
ArgumentNullException.ThrowIfNull(console);
_console = console;
}

/// <inheritdoc/>
Expand All @@ -49,27 +49,22 @@ public override Task<CakeReport> RunTargetsAsync(IEnumerable<string> targets)

private void PrintTaskDescriptions()
{
var maxTaskNameLength = 29;
var rowStyle = new Style(ConsoleColor.White);

foreach (var task in Tasks)
{
if (task.Name.Length > maxTaskNameLength)
{
maxTaskNameLength = task.Name.Length;
}

_descriptions.Add(task.Name, task.Description);
}
var table = new Table().Border(TableBorder.SimpleHeavy);
table.Width(100);
table.BorderStyle(Style.Plain.Foreground(ConsoleColor.Green));

maxTaskNameLength++;
string lineFormat = "{0,-" + maxTaskNameLength + "}{1}";
table.AddColumn(new TableColumn(new Text("Task", rowStyle)).PadRight(10));
table.AddColumn(new TableColumn(new Text("Description", rowStyle)));

_console.WriteLine();
_console.WriteLine(lineFormat, "Task", "Description");
_console.WriteLine(new String('=', maxTaskNameLength + 50));
foreach (var (key, value) in _descriptions)
foreach (var task in Tasks)
{
_console.WriteLine(lineFormat, key, value);
table.AddRow(
new Markup(task.Name.EscapeMarkup(), rowStyle),
new Markup((task.Description ?? string.Empty).EscapeMarkup(), rowStyle));
}

_console.Write(table);
}
}
Loading