feat: enable jumping to "not formatted" files from VisualStudio error list #1517
Conversation
… list - adds --msbuild-format parameter to format error message according to standard error/warning format of MSBuild. See https://learn.microsoft.com/en-us/visualstudio/msbuild/msbuild-diagnostic-format-for-tasks?view=vs-2022
| new Option( | ||
| ["--msbuild-format"], | ||
| "Formats messages in standard error/warning format for MSBuild." | ||
| ), |
There was a problem hiding this comment.
There have been requests for other log formats. I'm thinking this should be --log-format and accept a string/enum. Just msbuild and default (or maybe call it console?) for now.
There was a problem hiding this comment.
Renamed Startparameter and used enum as suggested.
Src/CSharpier.Cli/FileIssueLogger.cs
Outdated
| { | ||
| public void WriteError(string value, Exception? exception = null) | ||
| { | ||
| logger.LogError(exception, $"{this.GetPath()} - {value}"); | ||
| if (isMsBuildFormat) | ||
| logger.LogError("{Path}: error: {Message}", this.GetPath(), value); |
There was a problem hiding this comment.
I think the WriteWarning message should also use msbuild format. Although I don't recall what is considered a warning by CSharpier, and we turn on warningsAsErrors at work. Maybe that would cause issues.
There was a problem hiding this comment.
Also made WriteWarning() obey the --log-format parameter.
Also added a TODO comment for adding a test as soon as it is clear in which situations CSharpier will output warnings.
| private const bool IsMsBuildFormat = true; | ||
| private const bool IsNotMsBuildFormat = false; |
There was a problem hiding this comment.
These don't appear to be used and should be removed.
There was a problem hiding this comment.
Removed leftovers :)
|
I couldn't get csharpier.msbuild to ever log a warning. I believe at one time it would log warnings for files that could not be compiled but the logic around how msbuild runs has changed over time and I couldn't get it to trigger. The other two code paths that would write a warning wouldn't ever occur with using msbuild. Thanks for the contribution! |
…oormaster/csharpier into feat/add-msbuild-format-output
--msbuild-format--out-format <console|msBuild>parameter to format error message according to standard error/warning format of MSBuildEnables to double click on "was not formatted" message in error list of Visual Studio to jump to the file affected.