result

package

v0.1.4 Latest Latest Go to latest Published: Aug 28, 2020 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type FileResults struct {
	Filename string
	Results  []Result
}

FileResults contains all the Results for the file

func (fr *FileResults) String() string

type Result struct {
	Rule          *rule.Rule
	Violation     string
	StartPosition *token.Position
	EndPosition   *token.Position
}

Result contains data about the result of a broken rule

func FindResults(r *rule.Rule, filename, text string, line int) (rs []Result)

FindResults returns the results that match the rule for the given text. filename and line are only used for the Position

func (r *Result) Reason() string

Reason outputs the suggested alternatives for this rule

func (r *Result) String() string

type Results struct {
	Results []Result
}

Results contains a list of Result

func (rs *Results) Add(r *Result)

Add adds a single Result object onto the Results stack

func (rs *Results) Output()

Output is the logger output of results

func (rs *Results) Push(r ...Result)

Push pushes a list of Result objects onto the Results stack

func (rs *Results) String() string