cake-contrib/cake.issues.reporting.console

:cake: :jigsaw: :mag_right: Addin for reporting issues to the console

Console reporting for Cake.Issues Addin

This addin for the Cake Build Automation System allows you to report issues found using any code analyzer or linter with the Cake Issues addin to the console.

It is built using Errata.

For more information about this addin see the Cake.Issues website and for general information about the Cake build automation system see the Cake website.

Information

	Stable	Pre-release
GitHub Release	-
NuGet

Build Status

	Develop	Main
AppVeyor Windows
Azure DevOps Windows

Code Coverage

Quick Links

• Documentation

Discussion

For questions and to discuss ideas & feature requests, use the GitHub discussions on the Cake GitHub repository, under the Extension Q&A category.

Contributing

Contributions are welcome. See Contribution Guidelines.

cake.issues.reporting.console's Issues

Show rule url

Show rule url if available

Support file level issues

Print issues without line information to the console

Exception if no issues are passed and ShowProviderSummary is enabled

When ShowProviderSummary is enabled and an empty list of issues is passed an exception is thrown:

An error occurred when executing task 'Default'.
Error: System.InvalidOperationException: Sequence contains no elements
   at System.Linq.ThrowHelper.ThrowNoElementsException()
   at System.Linq.Enumerable.Max[TSource](IEnumerable`1 source, Func`2 selector)
   at Spectre.Console.BarChart.Render(RenderContext context, Int32 maxWidth) in /_/src/Spectre.Console/Widgets/Charts/BarChart.cs:line 71
   at Spectre.Console.Rendering.Renderable.Spectre.Console.Rendering.IRenderable.Render(RenderContext context, Int32 maxWidth) in /_/src/Spectre.Console/Rendering/Renderable.cs:line 22
   at Spectre.Console.RenderableExtensions.GetSegments(IAnsiConsole console, RenderContext options, IEnumerable`1 renderables) in /_/src/Spectre.Console/Extensions/RenderableExtensions.cs:line 39
   at Spectre.Console.RenderableExtensions.GetSegments(IRenderable renderable, IAnsiConsole console) in /_/src/Spectre.Console/Extensions/RenderableExtensions.cs:line 33
   at Spectre.Console.AnsiBuilder.Build(IAnsiConsole console, IRenderable renderable) in /_/src/Spectre.Console/Internal/Backends/Ansi/AnsiBuilder.cs:line 20
   at Spectre.Console.AnsiConsoleBackend.Write(IRenderable renderable) in /_/src/Spectre.Console/Internal/Backends/Ansi/AnsiConsoleBackend.cs:line 32
   at Spectre.Console.AnsiConsoleFacade.Write(IRenderable renderable) in /_/src/Spectre.Console/Internal/Backends/AnsiConsoleFacade.cs:line 43
   at Spectre.Console.AnsiConsole.Write(IRenderable renderable) in /_/src/Spectre.Console/AnsiConsole.Rendering.cs:line 32
   at Cake.Issues.Reporting.Console.ConsoleIssueReportGenerator.PrintSummary(IEnumerable`1 issues)
   at Cake.Issues.Reporting.Console.ConsoleIssueReportGenerator.InternalCreateReport(IEnumerable`1 issues)
   at Cake.Issues.Reporting.IssueReportFormat.CreateReport(IEnumerable`1 issues)
   at Cake.Issues.Reporting.IssueReportCreator.CreateReport(IEnumerable`1 issues, IIssueReportFormat reportFormat, ICreateIssueReportSettings settings)
   at Cake.Issues.Reporting.Aliases.CreateIssueReport(ICakeContext context, IEnumerable`1 issues, IIssueReportFormat reportFormat, ICreateIssueReportSettings settings)
   at Cake.Issues.Reporting.Aliases.CreateIssueReport(ICakeContext context, IEnumerable`1 issues, IIssueReportFormat reportFormat, DirectoryPath repositoryRoot, FilePath outputFilePath)
   at DefaultTask.Run(BuildContext context) in C:\git\swissgrc\doc.main\build\Program.cs:line 270
   at Cake.Frosting.FrostingTask`1.Cake.Frosting.IFrostingTask.RunAsync(ICakeContext context)
   at Cake.Core.CakeTask.Execute(ICakeContext context)
   at Cake.Core.DefaultExecutionStrategy.ExecuteAsync(CakeTask task, ICakeContext context)
   at Cake.Core.CakeEngine.ExecuteTaskAsync(ICakeContext context, IExecutionStrategy strategy, Stopwatch stopWatch, CakeTask task, CakeReport report)
   at Cake.Core.CakeEngine.ExecuteTaskAsync(ICakeContext context, IExecutionStrategy strategy, Stopwatch stopWatch, CakeTask task, CakeReport report)
   at Cake.Core.CakeEngine.ExecuteTaskAsync(ICakeContext context, IExecutionStrategy strategy, Stopwatch stopWatch, CakeTask task, CakeReport report)
   at Cake.Core.CakeEngine.RunTask(ICakeContext context, IExecutionStrategy strategy, CakeTask task, String target, Stopwatch stopWatch, CakeReport report)
   at Cake.Core.CakeEngine.RunTargetAsync(ICakeContext context, IExecutionStrategy strategy, ExecutionSettings settings)
   at Cake.Cli.BuildScriptHost`1.RunTargetAsync(String target)
   at Cake.Core.Scripting.ScriptHost.RunTarget(String target)
   at Cake.Frosting.Internal.FrostingEngine`1.Run(String target)
   at Cake.Frosting.Internal.DefaultCommand.Execute(CommandContext context, DefaultCommandSettings settings)

Support line level issues

Print issues with line, but without column information, to console

Multi-Target .NET Core 3.1, 5 & 6 instead of .NET Standard 2.0

Since Cake 2.0 has dropped support for .NET Framework and .NET Core < 3.1, we should also follow best-practices and multi-target .NET Core 3.1, 5 & 6

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• Update dependency Errata to v0.11.0

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update Cake.Issues to v3.0.0 (Cake.Issues, Cake.Issues.Reporting, Cake.Issues.Testing)
• Update dependency cake.tool to v3

Detected dependencies

cake

recipe.cake

• Cake.Recipe 3.0.1

nuget

.config/dotnet-tools.json

• cake.tool 1.3.0

src/Cake.Issues.Reporting.Console.Tests/Cake.Issues.Reporting.Console.Tests.csproj

• xunit.runner.visualstudio 2.5.0
• xunit 2.5.0
• Microsoft.NET.Test.Sdk 17.6.3
• StyleCop.Analyzers 1.1.118
• Shouldly 4.2.1
• Cake.Testing 3.0.0
• Cake.Issues.Testing 3.0.0-beta0002
• Cake.Issues.Reporting 3.0.0-beta0002
• Cake.Issues 3.0.0-beta0002

src/Cake.Issues.Reporting.Console/Cake.Issues.Reporting.Console.csproj

• StyleCop.Analyzers 1.1.118
• Microsoft.CodeAnalysis.NetAnalyzers 7.0.3
• Errata 0.10.0
• Cake.Issues.Reporting 3.0.0-beta0002
• Cake.Issues 3.0.0-beta0002
• Cake.Core 3.0.0

---

• Check this box to trigger a request for Renovate to run again on this repository

Target .NET Standard 2.0

Addin currently requires .NET 5 because of Errata. Next version of Errata will also support .NET Standard 2.0

Use different colors for individual bars in provider chart

The individual bars in the provider chart are currently all in the same color. Using a different color would make the chart more readable

Update to Cake 3.0

Update to Cake 3.0

Possibility to group issues by rule

Add setting to group issues by rule and create only one diagnostic for all issues of a rule

Build against Cake.Issues 2.0

Build against Cake.Issues 2.0

Support issues with line & column information

Print issues with line & column information to the console

Build against Cake.Issues 3.0

Build against Cake.Issues 3.0

Update to Cake 2.0

Build against Cake 2.0

ConsoleIssueReportFormatSettings.ShowPrioritySummary does not work

ConsoleIssueReportFormatSettings.ShowPrioritySummary does not toggle priority report, instead ShowProviderSummary is used.

Add setting to toggle if diagnostics should be reported or not

Same as we have a setting for the individual summary reports, there should be a setting available to toggle if diagnosticts should be printed or not.

Show additional information

Show additional information of issues if they are available

Multi-Target .NET 6 & 7 instead of .NET Core 3.1, 5 & 6

Since Cake 3.0 has dropped support for .NET Core 3.1 and .NET 5, we should also follow best-practices and multi-target .NET 5 & 6

Show summary tables

Show summary table at the end with numbers of issues per provider/run and and priority

Show project information

It would be nice to have project information shown in console output

Wrong repository link in NuGet packages

Repository link is wrong in NuGet packages

Add support for compact mode

Errata supports a compact mode (spectreconsole/errata@402225c). We should also support it through a setting.