diagnostics

Documentation

Index

• type ClientNotifier
• type DiagnosticSource
• type Diagnostics
  • func NewDiagnostics() Diagnostics
  • func (d Diagnostics) Append(src string, diagsMap map[string]hcl.Diagnostics) Diagnostics
  • func (d Diagnostics) EmptyRootDiagnostic() Diagnostics
• type Notifier
  • func NewNotifier(clientNotifier ClientNotifier, logger *log.Logger) *Notifier
  • func (n *Notifier) PublishHCLDiags(ctx context.Context, dirPath string, diags Diagnostics)

Types

type ClientNotifier

type ClientNotifier interface {
	Notify(ctx context.Context, method string, params interface{}) error
}

type DiagnosticSource

type DiagnosticSource string

type Diagnostics

type Diagnostics map[string]map[DiagnosticSource]hcl.Diagnostics

func NewDiagnostics

func NewDiagnostics() Diagnostics

func (Diagnostics) Append

func (d Diagnostics) Append(src string, diagsMap map[string]hcl.Diagnostics) Diagnostics

func (Diagnostics) EmptyRootDiagnostic

func (d Diagnostics) EmptyRootDiagnostic() Diagnostics

EmptyRootDiagnostic allows emptying any diagnostics for the whole directory which were published previously.

type Notifier

type Notifier struct {
	// contains filtered or unexported fields
}

Notifier is a type responsible for queueing HCL diagnostics to be converted and sent to the client

func NewNotifier

func NewNotifier(clientNotifier ClientNotifier, logger *log.Logger) *Notifier

func (*Notifier) PublishHCLDiags

func (n *Notifier) PublishHCLDiags(ctx context.Context, dirPath string, diags Diagnostics)

PublishHCLDiags accepts a map of HCL diagnostics per file and queues them for publishing. A dir path is passed which is joined with the filename keys of the map, to form a file URI.