diagnostic

Documentation

Index

• type Diagnostic
• type WithContext
  • func (w *WithContext) FormatPlain(out io.Writer)
  • func (w *WithContext) FormatToTerminal(out io.Writer)

Types

type Diagnostic

type Diagnostic struct {
	Message string
}

A Diagnostic represents one specific problem diagnosed by a check.

type WithContext

type WithContext struct {
	Diagnostic  Diagnostic
	Check       string
	Remediation string
	Object      lintcontext.Object
}

WithContext puts a diagnostic in the context of which check emitted it, and which object it applied to.

func (*WithContext) FormatPlain

func (w *WithContext) FormatPlain(out io.Writer)

FormatPlain prints out the result to the given writer, without colors/special formatting.

func (*WithContext) FormatToTerminal

func (w *WithContext) FormatToTerminal(out io.Writer)

FormatToTerminal writes the result to the given writer, which is expected to support terminal-based formatting.