InspectCode output analysis

[pascalberger]

Starting from version 2024.1, the default output format of InspectCode is Static Analysis Results Interchange Format (SARIF). The XML format, which was the default in previous versions, will soon be deprecated and currently requires manually setting the -f="xml" parameter which is not part of the settings class.
See https://www.jetbrains.com/help/resharper/InspectCode.html for details.

By default the InspectCode alias runs some analysis if an output file is defined. This no longer works with InspectCode >= 2024.1, where the default format is SARIF.

My suggestions going forward:

1. Introduce possibility to define format

   Introduce a new InspectCodeSettings.Format setting of type InspectCodeFormat[], with possible values
   InspectCodeFormat.Html, InspectCodeFormat.Text and InspectCodeFormat.Xml. Default value would be not
   have the setting set, resulting in SARIF format being created (no -f passed)

2. Introduce new Output parameter

   When multiple output formats are specified an output directory path instead of a file path can be passed.
   For this we can introduce a new InspectCodeSettings.OutputDirectory parameter of type DirectoryPath which also sets the --output parameter.

   A check should be added to throw an exception in case InspectCodeSettings.OutputFile and InspectCodeSettings.OutputDirectory are set

3. Run analysis only for XML format

   Change code in InspectCode runner to run AnalyseResultsFile only in case XML format is created and only on XML file.

4. Deprecate analysis

   With the announcement that XML output will be deprecated and with Cake.Issues addin a solution available to parse and process either XML or SARIF output from InspectCode we can remove the code from Cake.Common in next major version. First step would be to deprecate InspectCodeSettings.ThrowExceptionOnFindingViolations and InspectCodeSettings.SkipOutputAnalysis with a link to Cake.Issues addin.

[devlead]

Suggestion sounds good to me 👍