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
Description of an issue.
- Assembly
- Cake
.Issues .dll - Namespace
- Cake
.Issues - Implementing Types
graph BT
Type["IIssue"]
class Type type-node
Implementing0["Issue"]-.->Type
click Implementing0 "/api/Cake.Issues/Issue"
Syntax
public interface IIssue
Properties
Name | Value | Summary |
---|---|---|
Additional |
IReadOnlyDictionary |
Gets a dictionary with additional information regarding the issue.
|
Affected |
FilePath |
Gets the path to the file affected by the issue.
The path is relative to the repository root.
Can be
null if issue is not related to a change in a file.
|
Column | Nullable |
Gets the column in the file where the issues have occurred.
null if the issue affects the whole file or an assembly.
|
EndColumn | Nullable |
Gets the end of the column range in the file where the issues have occurred.
null if the issue affects the whole file, an assembly or only a single column.
|
EndLine | Nullable |
Gets the end of the line range in the file where the issues have occurred.
null if the issue affects the whole file, an assembly or only a single line.
|
FileLink | Uri |
Gets or sets a link to the position in the file where the issue occurred.
null if FileLinkSettings was not set while reading issue.
|
Identifier | string |
Gets the identifier for the message.
The identifier can be used to identify the same issue across multiple runs.
|
Line | Nullable |
Gets the line in the file where the issues have occurred.
null if the issue affects the whole file or an assembly.
|
MessageHtml | string |
Gets the message of the issue in HTML format.
|
MessageMarkdown | string |
Gets the message of the issue in Markdown format.
|
MessageText | string |
Gets the message of the issue in text format.
|
Priority | Nullable |
Gets the priority of the message. A higher value indicates a higher priority.
null if no priority was assigned.
|
PriorityName | string |
Gets the human friendly name of the priority.
null or System.String.Empty if no priority was assigned.
|
Project |
FilePath |
Gets the path to the project to which the file affected by the issue belongs.
The path is relative to the repository root.
Can be
null if issue is not related to a project.
|
ProjectName | string |
Gets the name of the project to which the file affected by the issue belongs.
Can be
null or System.String.Empty if issue is not related to a project.
|
ProviderName | string |
Gets the human friendly name of the issue provider.
|
ProviderType | string |
Gets the type of the issue provider.
|
RuleId | string |
Gets the id of the rule of the issue.
Can be
null or System.String.Empty if the issue provider provides no rule.
|
RuleName | string |
Gets the name of the rule of the issue.
Can be
null or System.String.Empty if the issue provider provides no rule.
|
RuleUrl | Uri |
Gets the URL containing information about the failing rule.
Can be
null if the issue provider provides no URL.
|
Run | string |
Gets or sets the description of the run.
Can be
null or System.String.Empty if no run information is provided.
|
Extension Methods
Name | Value | Summary |
---|---|---|
Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
FileDirectory |
string |
Returns the directory of the
AffectedFileRelativePath .
From IIssueExtensions
Requires the Cake.Issues addin
|
FileName |
string |
Returns the name of the file of the
AffectedFileRelativePath .
From IIssueExtensions
Requires the Cake.Issues addin
|
FilePath |
string |
Returns the full path of the
AffectedFileRelativePath .
From IIssueExtensions
Requires the Cake.Issues addin
|
GetExpandoObject |
ExpandoObject |
Returns a dynamic object containing the properties of an issue.
From IIssueExtensions
Requires the Cake.Issues.Reporting.Generic addin
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
LineRange |
string |
Returns the line range in the format
{Line}:{Column}-{EndLine}:{EndColumn} .
From IIssueExtensions
Requires the Cake.Issues addin
|
LineRange |
string |
Returns the line and column range in the format
{Line}:{Column}-{EndLine}:{EndColumn} .
From IIssueExtensions
Requires the Cake.Issues addin
|
Message |
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.
From IIssueExtensions
Requires the Cake.Issues addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
ProjectDirectory |
string |
Returns the directory of the
ProjectFileRelativePath .
From IIssueExtensions
Requires the Cake.Issues addin
|
ProjectPath |
string |
Returns the full path of
ProjectFileRelativePath or null .
From IIssueExtensions
Requires the Cake.Issues addin
|
Rule |
string |
Returns the name or id of the rule.
From IIssueExtensions
Requires the Cake.Issues addin
|
SerializeToJsonFile |
void |
Serializes an
IIssue to a JSON file.
Requires the Cake.Issues addin
|
Serialize |
string |
Serializes an
IIssue to a JSON string.
Requires the Cake.Issues addin
|
ThrowIfNull |
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 |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
To |
string |
Returns the string value or a
Not set > markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|