check

Documentation

Index

• type Operation
  • func NewOperation(specAssembler SpecAssembler, specChecker SpecChecker, ...) *Operation
  • func (s *Operation) Behave(ctx context.Context, maxWarnings int) (models.Check, error)
• type ReferenceRender
• type SpecAssembler
• type SpecChecker

Types

type Operation

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

func NewOperation

func NewOperation(
	specAssembler SpecAssembler,
	specChecker SpecChecker,
	referenceRender ReferenceRender,
	highlightCodePreview bool,
) *Operation

func (*Operation) Behave

func (s *Operation) Behave(ctx context.Context, maxWarnings int) (models.Check, error)

type ReferenceRender

type ReferenceRender interface {
	SourceCode(ref models.CodeReference, highlight bool) []byte
}

type SpecAssembler

type SpecAssembler interface {
	Assemble() (speca.Spec, error)
}

type SpecChecker

type SpecChecker interface {
	Check(ctx context.Context, spec speca.Spec) (models.CheckResult, error)
}