spectral

Documentation

Index

• type Spectral
  • func New(ctx context.Context, cfg *config.SpectralLinter) (*Spectral, error)
  • func (s *Spectral) Match(rcConfig *config.ResourceSet) ([]string, error)
  • func (s *Spectral) Run(ctx context.Context, _ string, paths ...string) error
  • func (s *Spectral) WithOverride(ctx context.Context, override *config.Linter) (linter.Linter, error)

Types

type Spectral

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

Spectral runs spectral on collections of files with a set of rules.

func New

func New(ctx context.Context, cfg *config.SpectralLinter) (*Spectral, error)

New returns a new Spectral instance.

func (*Spectral) Match

func (s *Spectral) Match(rcConfig *config.ResourceSet) ([]string, error)

Match implements linter.Linter.

func (*Spectral) Run

func (s *Spectral) Run(ctx context.Context, _ string, paths ...string) error

Run runs spectral on the given paths. Linting output is written to standard output by spectral. Returns an error when lint fails configured rules.

func (*Spectral) WithOverride

func (s *Spectral) WithOverride(ctx context.Context, override *config.Linter) (linter.Linter, error)

WithOverride implements linter.Linter.