diagnostics

Documentation

Index

• Variables
• func AddExtra(diag *hcl.Diagnostic, extra any)
• func AddExtraIfMissing[T any](d Diag, extra T)
• func DiagnosticExtra[T any](diag *hcl.Diagnostic) (_ T, _ bool)
• func DiagnosticsExtra[T any](diags Diag) (val T, found bool)
• func FindByExtra[T any](diags Diag) *hcl.Diagnostic
• func PrintDiags(output io.Writer, diags []*hcl.Diagnostic, fileMap map[string]*hcl.File, ...)
• type Diag
  • func FromErr(err error, summary string) (diags Diag)
  • func FromErrSubj(err error, summary string, subject *hcl.Range) (diags Diag)
  • func FromHcl(diag *hcl.Diagnostic) Diag
  • func (d *Diag) Add(summary, detail string)
  • func (d Diag) AddExtra(extra any)
  • func (d *Diag) AddWarn(summary, detail string)
  • func (d *Diag) Append(diag *hcl.Diagnostic) (addedErrors bool)
  • func (d *Diag) AppendErr(err error, summary string) (haveAddedErrors bool)
  • func (d *Diag) DefaultSubject(rng *hcl.Range)
  • func (d Diag) Error() string
  • func (d *Diag) Extend(diags []*hcl.Diagnostic) (haveAddedErrors bool)
  • func (d Diag) HasErrors() bool
• type GoJQError
• type PathExtra
  • func NewPathExtra(p cty.Path) PathExtra
  • func (p PathExtra) String() string
• type TracebackExtra
  • func NewTracebackExtra() TracebackExtra

Variables

var RepeatedError = &hcl.Diagnostic{
	Severity: hcl.DiagError,
	Extra:    repeatedError{},
}

Invisible to user error, typically used to signal that the initial block evaluation has failed (and already has reported its errors to user).

Functions

func AddExtra

func AddExtra(diag *hcl.Diagnostic, extra any)

Adds extra without replacing existing extras.

func AddExtraIfMissing

func AddExtraIfMissing[T any](d Diag, extra T)

Adds an extra if no extra with the same type is present.

func DiagnosticExtra

func DiagnosticExtra[T any](diag *hcl.Diagnostic) (_ T, _ bool)

func DiagnosticsExtra

func DiagnosticsExtra[T any](diags Diag) (val T, found bool)

func FindByExtra

func FindByExtra[T any](diags Diag) *hcl.Diagnostic

func PrintDiags

func PrintDiags(output io.Writer, diags []*hcl.Diagnostic, fileMap map[string]*hcl.File, colorize bool)

Types

type Diag

type Diag hcl.Diagnostics // Diagnostics does implement error interface, but not, itself, an error.

func FromErr

func FromErr(err error, summary string) (diags Diag)

func FromErrSubj

func FromErrSubj(err error, summary string, subject *hcl.Range) (diags Diag)

func FromHcl

func FromHcl(diag *hcl.Diagnostic) Diag

func (*Diag) Add

func (d *Diag) Add(summary, detail string)

Add new diagnostic error.

func (Diag) AddExtra

func (d Diag) AddExtra(extra any)

Adds extra without replacing existing extras.

func (*Diag) AddWarn

func (d *Diag) AddWarn(summary, detail string)

Add new diagnostic warning.

func (*Diag) Append

func (d *Diag) Append(diag *hcl.Diagnostic) (addedErrors bool)

Appends diag to diagnostics, returns true if the just-appended diagnostic is an error.

func (*Diag) AppendErr

func (d *Diag) AppendErr(err error, summary string) (haveAddedErrors bool)

Creates diagnostic and appends it if err != nil.

func (*Diag) DefaultSubject

func (d *Diag) DefaultSubject(rng *hcl.Range)

Set the subject for diagnostics if it's not already specified.

func (Diag) Error

func (d Diag) Error() string

func (*Diag) Extend

func (d *Diag) Extend(diags []*hcl.Diagnostic) (haveAddedErrors bool)

Appends all diags to diagnostics, returns true if the just-appended diagnostics contain an error.

func (Diag) HasErrors

func (d Diag) HasErrors() bool

HasErrors returns true if the receiver contains any diagnostics of severity DiagError.

type GoJQError

type GoJQError struct {
	Err   error
	Query string
}

Attach this as an .Extra on diagnostic to enhance the error message for gojq errors. Diagnostic must include Subject pointing to the query expression.

type PathExtra

type PathExtra cty.Path

func NewPathExtra

func NewPathExtra(p cty.Path) PathExtra

func (PathExtra) String

func (p PathExtra) String() string

type TracebackExtra

type TracebackExtra = *tracebackExtra

func NewTracebackExtra

func NewTracebackExtra() TracebackExtra