PrcaAliases.

ReadIssues(ICakeContext, IEnumerable<ICodeAnalysisProvider>, ReadIssuesSettings) Method

Summary

Reads issues from issue providers using the specified settings.
Assembly
Cake.Prca.dll
Namespace
Cake.Prca
Containing Type
PrcaAliases

Syntax

public static IEnumerable<ICodeAnalysisIssue> ReadIssues(this ICakeContext context, IEnumerable<ICodeAnalysisProvider> issueProviders, ReadIssuesSettings settings)

Examples

Read code analysis issues reported as MsBuild warnings and issues reported by JetBrains inspect code with comments formatted as Markdown:

 var settings =
         new ReadIssuesSettings(new DirectoryPath("c:\repo"))
         {
             Format = PrcaCommentFormat.Markdown
         };

     var issues = ReadIssues(
         new List<ICodeAnalysisProvider>
         {
             MsBuildCodeAnalysisFromFilePath(
                 @"C:\build\msbuild.log",
                 MsBuildXmlFileLoggerFormat),
             InspectCodeFromFilePath(
                 @"C:\build\inspectcode.log",
                 MsBuildXmlFileLoggerFormat)
         },
         settings));

Attributes

Type Description
CakeMethodAliasAttribute

Parameters

Name Type Description
context ICakeContext The context.
issueProviders IEnumerable<T> The list of provider for issues.
settings ReadIssuesSettings The settings.

Return Value

Type Description
IEnumerable<T> Issues reported by all issue providers.
GitHub