Documentation
¶
Overview ¶
Package result records rule results and provides reports and summary text on those results.
Index ¶
- type Type
- func (results *Type) AddProjectSummary(lintedProject project.Type)
- func (results *Type) AddSummary()
- func (results *Type) Initialize()
- func (results Type) JSONReport() string
- func (results Type) Passed() bool
- func (results Type) ProjectSummaryText(lintedProject project.Type) string
- func (results *Type) Record(lintedProject project.Type, ruleConfiguration ruleconfiguration.Type, ...) string
- func (results Type) SummaryText() string
- func (results Type) WriteReport() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Type ¶
type Type struct {
Configuration toolConfigurationReportType `json:"configuration"`
Projects []projectReportType `json:"projects"`
Summary summaryReportType `json:"summary"`
}
Type is the type for the rule results data
var Results Type
Results is the global instance of the rule results result.Type struct
func (*Type) AddProjectSummary ¶
AddProjectSummary summarizes the results of all rules on the given project and adds it to the report.
func (*Type) AddSummary ¶
func (results *Type) AddSummary()
AddSummary summarizes the rule results for all projects and adds it to the report.
func (*Type) Initialize ¶
func (results *Type) Initialize()
Initialize adds the tool configuration data to the results data.
func (Type) JSONReport ¶
JSONReport returns a JSON formatted report of rules on all projects in string encoding.
func (Type) ProjectSummaryText ¶
ProjectSummaryText returns a text summary of the rule results for the given project.
func (*Type) Record ¶
func (results *Type) Record(lintedProject project.Type, ruleConfiguration ruleconfiguration.Type, ruleResult ruleresult.Type, ruleOutput string) string
Record records the result of a rule and returns a text summary for it.
func (Type) SummaryText ¶
SummaryText returns a text summary of the cumulative rule results.
func (Type) WriteReport ¶
WriteReport writes a report for all projects to the specified file.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package feedback provides feedback to the user.
|
Package feedback provides feedback to the user. |
|
Package outputformat defines the output formats
|
Package outputformat defines the output formats |