This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Issues.

Summary

Base class for all log file format implementations.

Assembly

Cake.Issues.dll

Namespace

Cake.Issues

Interfaces

ILogFileFormat<TIssueProvider, TSettings>

Base Types

Object

Derived Types

graph BT Type-->Base0["Object"] Type-.->Interface0["ILogFileFormat<TIssueProvider, TSettings>"] Type["BaseLogFileFormat<TIssueProvider, TSettings>"] class Type type-node Derived0["BaseEsLintLogFileFormat"]-->Type click Derived0 "/api/Cake.Issues.EsLint/BaseEsLintLogFileFormat" Derived1["BaseMsBuildLogFileFormat"]-->Type click Derived1 "/api/Cake.Issues.MsBuild/BaseMsBuildLogFileFormat" Derived2["BaseMarkdownlintLogFileFormat"]-->Type click Derived2 "/api/Cake.Issues.Markdownlint/BaseMarkdownlintLogFileFormat"

Syntax

public abstract class BaseLogFileFormat<TIssueProvider, TSettings> : 
    ILogFileFormat<TIssueProvider, TSettings>
    
    where TIssueProvider : BaseMultiFormatIssueProvider<TSettings, TIssueProvider> where TSettings : BaseMultiFormatIssueProviderSettings<TIssueProvider, TSettings>

Type Parameters

Name	Description
TIssueProvider	Type of the issue provider.
TSettings	Type of the settings.

Constructors

Name	Summary
BaseLogFileFormat(ICakeLog)	Initializes a new instance of the `BaseLogFileFormat<TIssueProvider, TSettings>` class.

Properties

Name	Value	Summary
Log	ICakeLog	Gets the Cake log instance.

Methods

Name	Value	Summary
ReadIssues(TIssueProvider, IRepositorySettings, TSettings)	IEnumerable<IIssue>	Gets all issues.

Extension Methods

Name	Value	Summary
Dump<BaseLogFileFormat<TIssueProvider, TSettings>>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<BaseLogFileFormat<TIssueProvider, TSettings>>(BaseLogFileFormat<TIssueProvider, TSettings>[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<BaseLogFileFormat<TIssueProvider, TSettings>>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<BaseLogFileFormat<TIssueProvider, TSettings>>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<BaseLogFileFormat<TIssueProvider, TSettings>>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<BaseLogFileFormat<TIssueProvider, TSettings>>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin