Documentation
¶
Index ¶
- Constants
- type FileResults
- type LineResult
- func (r LineResult) GetEndPosition() *token.Position
- func (r LineResult) GetLine() string
- func (r LineResult) GetSeverity() rule.Severity
- func (r LineResult) GetStartPosition() *token.Position
- func (r LineResult) MarshalJSON() ([]byte, error)
- func (r LineResult) Reason() string
- func (r LineResult) String() string
- type PathResult
- type Result
Constants ¶
const MaxLineLength = 200
MaxLineLength is the max line length that this printer will show the source of the violation and the location within the line of the violation. Helps avoid consuming the console when minified files contain violations.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FileResults ¶
FileResults contains all the Results for the file
func (FileResults) Len ¶ added in v0.1.2
func (fr FileResults) Len() int
Len is part of sort.Interface
func (FileResults) Less ¶ added in v0.1.2
func (fr FileResults) Less(i, j int) bool
Less is part of sort.Interface
func (*FileResults) String ¶
func (fr *FileResults) String() string
func (FileResults) Swap ¶ added in v0.1.2
func (fr FileResults) Swap(i, j int)
Swap is part of sort.Interface
type LineResult ¶ added in v0.1.16
type LineResult struct {
Rule *rule.Rule
Violation string
// Line is the full string of the line, unless it's over MaxLintLength,
// where Line will be an empty string
Line string
StartPosition *token.Position
EndPosition *token.Position
}
LineResult contains data about the result of a broken rule
func NewLineResult ¶ added in v0.1.16
func NewLineResult(r *rule.Rule, violation, filename string, line, startColumn, endColumn int) LineResult
NewLineResult returns a LineResult based on the metadata from a violation
func (LineResult) GetEndPosition ¶ added in v0.1.16
func (r LineResult) GetEndPosition() *token.Position
GetEndPosition returns the start position for the Result
func (LineResult) GetLine ¶ added in v0.1.16
func (r LineResult) GetLine() string
GetLine returns the entire line for the LineResult
func (LineResult) GetSeverity ¶ added in v0.1.16
func (r LineResult) GetSeverity() rule.Severity
GetSeverity returns the rule severity for the Result
func (LineResult) GetStartPosition ¶ added in v0.1.16
func (r LineResult) GetStartPosition() *token.Position
GetStartPosition returns the start position for the Result
func (LineResult) MarshalJSON ¶ added in v0.2.0
func (r LineResult) MarshalJSON() ([]byte, error)
MarshalJSON override to include Reason in the json response
func (LineResult) Reason ¶ added in v0.1.16
func (r LineResult) Reason() string
Reason outputs the suggested alternatives for this rule
func (LineResult) String ¶ added in v0.1.16
func (r LineResult) String() string
type PathResult ¶ added in v0.1.14
type PathResult struct {
LineResult
}
PathResult is a Result meant for showing violations in a file path
func MatchPath ¶ added in v0.1.14
func MatchPath(r *rule.Rule, path string) (rs []PathResult)
MatchPath matches the path against the rule. If it is a match, it will return a PathResult with the line/start column/end column all at 1
func MatchPathRules ¶ added in v0.1.14
func MatchPathRules(rules []*rule.Rule, path string) (rs []PathResult)
MatchPathRules will match the path against all the rules provided
func (PathResult) Reason ¶ added in v0.1.14
func (r PathResult) Reason() string
Reason is the reason for the PathResult violation. It is similar to Result.Reason, but makes it clear that the violation is with the file path and not a line in the file
Source Files