Documentation ¶
Overview ¶
Package bufcheck contains the implementations of the lint and breaking change detection checkers.
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 ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var AllCheckerFormatStrings = []string{
"text",
"json",
}
AllCheckerFormatStrings is all checker format strings.
Functions ¶
Types ¶
type Checker ¶
type Checker interface { json.Marshaler // ID returns the ID of the Checker. // // UPPER_SNAKE_CASE. ID() string // Categories returns the categories of the Checker. // // UPPER_SNAKE_CASE. // Sorted. Categories() []string // Purpose returns the purpose of the Checker. // // Full sentence. Purpose() string }
Checker is a checker.
Directories ¶
Path | Synopsis |
---|---|
Package bufbreaking contains the breaking change detection functionality.
|
Package bufbreaking contains the breaking change detection functionality. |
internal/bufbreakingbuild
Package bufbreakingbuild contains the CheckerBuilders used by bufbreakingv*.
|
Package bufbreakingbuild contains the CheckerBuilders used by bufbreakingv*. |
internal/bufbreakingcheck
Package bufbreakingcheck impelements the check functions.
|
Package bufbreakingcheck impelements the check functions. |
internal/bufbreakingv1beta1
Package bufbreakingv1beta1 contains the VersionSpec for v1beta1.
|
Package bufbreakingv1beta1 contains the VersionSpec for v1beta1. |
Package buflint contains the linting functionality.
|
Package buflint contains the linting functionality. |
internal/buflintbuild
Package buflintbuild contains the CheckerBuilders used by buflintv*.
|
Package buflintbuild contains the CheckerBuilders used by buflintv*. |
internal/buflintcheck
Package buflintcheck impelements the check functions.
|
Package buflintcheck impelements the check functions. |
internal/buflintv1beta1
Package buflintv1beta1 contains the VersionSpec for v1beta1.
|
Package buflintv1beta1 contains the VersionSpec for v1beta1. |
Click to show internal directories.
Click to hide internal directories.