diagnostics

package

v0.0.0-...-e560ebb Latest Latest Go to latest Published: Jul 13, 2021 License: BSD-3-Clause Imports: 5 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

Package diagnostics provides utilities to collect diagnostics for lint.

This section is empty.

This section is empty.

This section is empty.

type Result struct {
	Errors errors.MultiError
	// contains filtered or unexported fields
}

Result contains diagnostic messages from lint.

func (r *Result) AppendError(f string, args ...interface{})

AppendError appends an error to result, prefixed with current context.

func (r *Result) Display() []string

Display returns a user-friendly display of diagnostics from a Result.

func (r *Result) IsValid() bool

IsValid returns false if the result contains any validation errors, true otherwise.

func (r *Result) Merge(o Result)

Merge merges another result into the current result.

Diagnostic messages from the incoming Result are prefixed with the current Result's context. Context from the incoming Result is ignored.

func (r *Result) PushContext(c string) (popContext func())

PushContext adds context to be prepended to all diagnostic messages.

Contexts can be stacked by calling PushContext() repeatedly. Returns a function to pop the pushed context.