bufcheck

package

v0.53.0 Latest Latest Go to latest Published: Aug 25, 2021 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bufbuild/buf

Links

Open Source Insights

Documentation ¶

Overview ¶

Package bufcheck contains the implementations of the lint and breaking change detection rules.

There is a lot of shared logic between the two, and originally they were actually combined into one logical entity (where some checks happened to be linters, and some checks happen to be breaking change detectors), so some of this is historical.

Index ¶

Variables
func PrintRules(writer io.Writer, rules []Rule, formatString string) (retErr error)
type Rule

Constants ¶

This section is empty.

Variables ¶

View Source

var AllRuleFormatStrings = []string{
	"text",
	"json",
}

AllRuleFormatStrings is all rule format strings.

Functions ¶

func PrintRules ¶ added in v0.34.0

func PrintRules(writer io.Writer, rules []Rule, formatString string) (retErr error)

PrintRules prints the rules to the writer.

The empty string defaults to text.

Types ¶

type Rule ¶ added in v0.34.0

type Rule interface {
	json.Marshaler

	// ID returns the ID of the Rule.
	//
	// UPPER_SNAKE_CASE.
	ID() string
	// Categories returns the categories of the Rule.
	//
	// UPPER_SNAKE_CASE.
	// Sorted.
	Categories() []string
	// Purpose returns the purpose of the Rule.
	//
	// Full sentence.
	Purpose() string
}

Rule is a rule.

Source Files ¶

View all Source files

bufcheck.go

Directories ¶

Path	Synopsis
bufbreaking Package bufbreaking contains the breaking change detection functionality.	Package bufbreaking contains the breaking change detection functionality.
internal/bufbreakingbuild Package bufbreakingbuild contains the RuleBuilders used by bufbreakingv*.	Package bufbreakingbuild contains the RuleBuilders used by bufbreakingv*.
internal/bufbreakingcheck Package bufbreakingcheck impelements the check functions.	Package bufbreakingcheck impelements the check functions.
internal/bufbreakingv1 Package bufbreakingv1 contains the VersionSpec for v1.	Package bufbreakingv1 contains the VersionSpec for v1.
internal/bufbreakingv1beta1 Package bufbreakingv1beta1 contains the VersionSpec for v1beta1.	Package bufbreakingv1beta1 contains the VersionSpec for v1beta1.
buflint Package buflint contains the linting functionality.	Package buflint contains the linting functionality.
internal/buflintbuild Package buflintbuild contains the RuleBuilders used by buflintv*.	Package buflintbuild contains the RuleBuilders used by buflintv*.
internal/buflintcheck Package buflintcheck impelements the check functions.	Package buflintcheck impelements the check functions.
internal/buflintv1 Package buflintv1 contains the VersionSpec for v1.	Package buflintv1 contains the VersionSpec for v1.
internal/buflintv1beta1 Package buflintv1beta1 contains the VersionSpec for v1beta1.	Package buflintv1beta1 contains the VersionSpec for v1beta1.
internal
internaltesting

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