buflint

package

v0.55.0 Latest Latest Go to latest Published: Sep 7, 2021 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/bufbuild/buf

Documentation ¶

Overview ¶

Package buflint contains the linting functionality.

The primary entry point to this package is the Handler.

Index ¶

Variables
type Handler
- func NewHandler(logger *zap.Logger) Handler

Constants ¶

This section is empty.

Variables ¶

View Source

var AllFormatStrings = append(
	bufanalysis.AllFormatStrings,
	"config-ignore-yaml",
)

AllFormatStrings are all format strings.

Functions ¶

This section is empty.

Types ¶

type Handler ¶

type Handler interface {
	// Check runs the lint checks.
	//
	// The image should have source code info for this to work properly.
	//
	// Images should be filtered with regards to imports before passing to this function.
	Check(
		ctx context.Context,
		config *buflintconfig.Config,
		image bufimage.Image,
	) ([]bufanalysis.FileAnnotation, error)
}

Handler handles the main lint functionality.

func NewHandler ¶

func NewHandler(logger *zap.Logger) Handler

NewHandler returns a new Handler.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
buflintconfig
internal
buflintbuild Package buflintbuild contains the RuleBuilders used by buflintv*.	Package buflintbuild contains the RuleBuilders used by buflintv*.
buflintcheck Package buflintcheck impelements the check functions.	Package buflintcheck impelements the check functions.
buflintv1 Package buflintv1 contains the VersionSpec for v1.	Package buflintv1 contains the VersionSpec for v1.
buflintv1beta1 Package buflintv1beta1 contains the VersionSpec for v1beta1.	Package buflintv1beta1 contains the VersionSpec for v1beta1.

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