Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add diagnostic logging to console reporter #1016

Merged
merged 1 commit into from
Jan 16, 2025
Merged

Add diagnostic logging to console reporter #1016

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions src/Cake.Issues.Reporting.Console/ConsoleIssueReportGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,24 +32,36 @@ public ConsoleIssueReportGenerator(ICakeLog log, ConsoleIssueReportFormatSetting
protected override FilePath InternalCreateReport(IEnumerable<IIssue> issues)
{
var enumeratedIssues = issues.ToList();
this.Log.Verbose("Starting rendering of console output for {0} issues", enumeratedIssues.Count);

if (this.consoleIssueReportFormatSettings.ShowDiagnostics)
{
// Filter to issues from existing files
var countBefore = enumeratedIssues.Count;
var diagnosticIssues =
enumeratedIssues
.Where(x =>
x.AffectedFileRelativePath != null &&
File.Exists(this.Settings.RepositoryRoot.CombineWithFilePath(x.AffectedFileRelativePath).FullPath))
.ToList();
this.Log.Verbose(
"{0} issue(s) were filtered because they either don't belong to a file or the file does not exist.",
countBefore - enumeratedIssues.Count);

// Filter to issues with line and column information
// Errata currently doesn't support file or line level diagnostics.
// https://github.com/cake-contrib/Cake.Issues.Reporting.Console/issues/4
// https://github.com/cake-contrib/Cake.Issues.Reporting.Console/issues/5
countBefore = enumeratedIssues.Count;
diagnosticIssues =
diagnosticIssues
.Where(x => x.Line.HasValue && x.Column.HasValue)
.ToList();
this.Log.Verbose(
"{0} issue(s) were filtered because they don't contain line or column information.",
countBefore - diagnosticIssues.Count);

this.Log.Verbose("{0} issue to write after filtering", diagnosticIssues.Count);

var report = new Report(new FileSystemRepository(this.Settings));

Expand Down
Loading