linter

package
v1.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 17, 2021 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Linter

type Linter interface {
	// Match returns a slice of logical paths to spec files that should be
	// linted from the given resource set configuration.
	Match(*config.ResourceSet) ([]string, error)

	// WithOverride returns a new instance of a Linter with the given configuration.
	WithOverride(ctx context.Context, cfg *config.Linter) (Linter, error)

	// Run executes the linter checks on the given spec files.
	Run(ctx context.Context, files ...string) error
}

A Linter checks that a set of spec files conform to some set of rules and standards.

Directories

Path Synopsis
Package optic supports linting OpenAPI specs with Optic CI and Sweater Comb.
Package optic supports linting OpenAPI specs with Optic CI and Sweater Comb.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL