IIssueExtensions Class

Summary

Extensions for IIssue.
Assembly
Cake.Issues.dll
Namespace
Cake.Issues
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["IIssueExtensions"] class Type type-node

Syntax

public static class IIssueExtensions

Methods

Name Value Summary
FileDirectory(IIssue) string
Returns the directory of the AffectedFileRelativePath.
static
FileName(IIssue) string
Returns the name of the file of the AffectedFileRelativePath.
static
FilePath(IIssue) string
Returns the full path of the AffectedFileRelativePath.
static
LineRange(IIssue, bool) string
Returns the line range in the format {Line}:{Column}-{EndLine}:{EndColumn}.
static
LineRange(IIssue) string
Returns the line and column range in the format {Line}:{Column}-{EndLine}:{EndColumn}.
static
Message(IIssue, IssueCommentFormat) string
Gets the message of the issue in a specific format. If the message is not available in the specific format, the message in text format will be returned.
static
ProjectDirectory(IIssue) string
Returns the directory of the ProjectFileRelativePath.
static
ProjectPath(IIssue) string
Returns the full path of ProjectFileRelativePath or null.
static
ReplaceIssuePattern(string, IIssue) string
Returns a string with all patterns replaced by the values of issue.
static
Rule(IIssue) string
Returns the name or id of the rule.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin