IIssueProvider Interface

Summary

Interface describing a provider for issues.
graph BT Type-.->Interface0["IBaseIssueComponent<IReadIssuesSettings>"] Type["IIssueProvider"] class Type type-node Implementing0["BaseMultiFormatIssueProvider<TSettings, TIssueProvider>"]-.->Type click Implementing0 "/api/Cake.Issues/BaseMultiFormatIssueProvider_2" Implementing1["EsLintIssuesProvider"]-.->Type click Implementing1 "/api/Cake.Issues.EsLint/EsLintIssuesProvider" Implementing2["FakeConfigurableIssueProvider"]-.->Type click Implementing2 "/api/Cake.Issues.Testing/FakeConfigurableIssueProvider" Implementing3["FakeIssueProvider"]-.->Type click Implementing3 "/api/Cake.Issues.Testing/FakeIssueProvider" Implementing4["MsBuildIssuesProvider"]-.->Type click Implementing4 "/api/Cake.Issues.MsBuild/MsBuildIssuesProvider" Implementing5["FakeMultiFormatIssueProvider"]-.->Type click Implementing5 "/api/Cake.Issues.Testing/FakeMultiFormatIssueProvider" Implementing6["BaseIssueProvider"]-.->Type click Implementing6 "/api/Cake.Issues/BaseIssueProvider" Implementing7["BaseConfigurableIssueProvider<T>"]-.->Type click Implementing7 "/api/Cake.Issues/BaseConfigurableIssueProvider_1" Implementing8["MarkdownlintIssuesProvider"]-.->Type click Implementing8 "/api/Cake.Issues.Markdownlint/MarkdownlintIssuesProvider"

Syntax

public interface IIssueProvider : IBaseIssueComponent<IReadIssuesSettings>

Properties

Name Value Summary
ProviderName string
Gets the human friendly name of the issue provider.
ProviderType string
Gets the type of the issue provider.

Methods

Name Value Summary
ReadIssues() IEnumerable<IIssue>
Gets all issues.

Extension Methods

Name Value Summary
NotNull<IIssueProvider>(string) void
Throws an exception if the specified parameter's value is null.
GitHub