Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Checkstyle ¶
type Checkstyle struct {
// contains filtered or unexported fields
}
func NewCheckstyle ¶
func NewCheckstyle(w io.Writer) *Checkstyle
type CodeClimate ¶
type CodeClimate struct {
// contains filtered or unexported fields
}
func NewCodeClimate ¶
func NewCodeClimate(w io.Writer) *CodeClimate
type CodeClimateIssue ¶
type CodeClimateIssue struct {
Description string `json:"description"`
Severity string `json:"severity,omitempty"`
Fingerprint string `json:"fingerprint"`
Location struct {
Path string `json:"path"`
Lines struct {
Begin int `json:"begin"`
} `json:"lines"`
} `json:"location"`
}
CodeClimateIssue is a subset of the Code Climate spec. https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md#data-types It is just enough to support GitLab CI Code Quality. https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html
type GitHub ¶
type GitHub struct {
// contains filtered or unexported fields
}
type GitHubMatcher ¶
type GitHubMatcher struct {
// Owner an ID field that can be used to remove or replace the problem matcher.
// **required**
Owner string `json:"owner,omitempty"`
// Severity indicates the default severity, either 'warning' or 'error' case-insensitive.
// Defaults to 'error'.
Severity string `json:"severity,omitempty"`
Pattern []GitHubPattern `json:"pattern,omitempty"`
}
GitHubMatcher defines a problem matcher.
type GitHubPattern ¶
type GitHubPattern struct {
// Regexp the regexp pattern that provides the groups to match against.
// **required**
Regexp string `json:"regexp,omitempty"`
// File a group number containing the file name.
File int `json:"file,omitempty"`
// FromPath a group number containing a filepath used to root the file (e.g. a project file).
FromPath int `json:"fromPath,omitempty"`
// Line a group number containing the line number.
Line int `json:"line,omitempty"`
// Column a group number containing the column information.
Column int `json:"column,omitempty"`
// Severity a group number containing either 'warning' or 'error' case-insensitive.
// Defaults to `error`.
Severity int `json:"severity,omitempty"`
// Code a group number containing the error code.
Code int `json:"code,omitempty"`
// Message a group number containing the error message.
// **required** at least one pattern must set the message.
Message int `json:"message,omitempty"`
// Loop whether to loop until a match is not found,
// only valid on the last pattern of a multi-pattern matcher.
Loop bool `json:"loop,omitempty"`
}
GitHubPattern defines a pattern for a problem matcher.
type GitHubProblemMatchers ¶
type GitHubProblemMatchers struct {
Matchers []GitHubMatcher `json:"problemMatcher,omitempty"`
}
GitHubProblemMatchers defines the root of problem matchers. - https://github.com/actions/toolkit/blob/main/docs/problem-matchers.md - https://github.com/actions/toolkit/blob/main/docs/commands.md#problem-matchers
type InspectionInstance ¶
type InspectionInstance struct {
// contains filtered or unexported fields
}
InspectionInstance reports a specific defect, warning, error message. Includes location, description, and various optional and custom attributes. https://www.jetbrains.com/help/teamcity/service-messages.html#Inspection+Instance
type InspectionType ¶
type InspectionType struct {
// contains filtered or unexported fields
}
InspectionType is the unique description of the conducted inspection. Each specific warning or an error in code (inspection instance) has an inspection type. https://www.jetbrains.com/help/teamcity/service-messages.html#Inspection+Type
type JunitXML ¶
type JunitXML struct {
// contains filtered or unexported fields
}
func NewJunitXML ¶
type Printer ¶
type Printer struct {
// contains filtered or unexported fields
}
Printer prints issues
func NewPrinter ¶
NewPrinter creates a new Printer.
type TeamCity ¶
type TeamCity struct {
// contains filtered or unexported fields
}
TeamCity printer for TeamCity format.
func NewTeamCity ¶
NewTeamCity output format outputs issues according to TeamCity service message format.