buflint

package

v0.48.2 Latest Latest Go to latest Published: Jul 30, 2021 License: Apache-2.0 Imports: 15 Imported by: 0

Details

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

Repository

github.com/bufbuild/buf

Links

Documentation ¶

Overview ¶

Package buflint contains the linting functionality.

The primary entry point to this package is the Handler.

Index ¶

Variables
func GetAllRulesV1() ([]bufcheck.Rule, error)
func GetAllRulesV1Beta1() ([]bufcheck.Rule, error)
func PrintFileAnnotations(writer io.Writer, fileAnnotations []bufanalysis.FileAnnotation, ...) error
type Config
- func NewConfigV1(externalConfig ExternalConfigV1) (*Config, error)
- func NewConfigV1Beta1(externalConfig ExternalConfigV1Beta1) (*Config, error)
- func (c *Config) GetRules() []bufcheck.Rule
type ExternalConfigV1
type ExternalConfigV1Beta1
type Handler
- func NewHandler(logger *zap.Logger) Handler
type Rule

Constants ¶

This section is empty.

Variables ¶

View Source

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

AllFormatStrings are all format strings.

Functions ¶

func GetAllRulesV1 ¶ added in v0.44.0

func GetAllRulesV1() ([]bufcheck.Rule, error)

GetAllRulesV1 gets all known rules.

Should only be used for printing.

func GetAllRulesV1Beta1 ¶ added in v0.34.0

func GetAllRulesV1Beta1() ([]bufcheck.Rule, error)

GetAllRulesV1Beta1 gets all known rules.

Should only be used for printing.

func PrintFileAnnotations ¶ added in v0.19.0

func PrintFileAnnotations(
	writer io.Writer,
	fileAnnotations []bufanalysis.FileAnnotation,
	formatString string,
) error

PrintFileAnnotations prints the FileAnnotations to the Writer.

Also accepts config-ignore-yaml.

Types ¶

type Config ¶

type Config struct {
	// Rules are the lint rules to run.
	//
	// Rules will be sorted by first categories, then id when Configs are
	// created from this package, i.e. created wth ConfigBuilder.NewConfig.
	Rules               []Rule
	IgnoreIDToRootPaths map[string]map[string]struct{}
	IgnoreRootPaths     map[string]struct{}
	AllowCommentIgnores bool
}

Config is the check config.

func NewConfigV1 ¶ added in v0.44.0

func NewConfigV1(externalConfig ExternalConfigV1) (*Config, error)

NewConfigV1 returns a new Config.

func NewConfigV1Beta1 ¶ added in v0.25.0

func NewConfigV1Beta1(externalConfig ExternalConfigV1Beta1) (*Config, error)

NewConfigV1Beta1 returns a new Config.

func (*Config) GetRules ¶ added in v0.34.0

func (c *Config) GetRules() []bufcheck.Rule

GetRules returns the rules.

type ExternalConfigV1 ¶ added in v0.44.0

type ExternalConfigV1 struct {
	Use    []string `json:"use,omitempty" yaml:"use,omitempty"`
	Except []string `json:"except,omitempty" yaml:"except,omitempty"`
	// IgnoreRootPaths
	Ignore []string `json:"ignore,omitempty" yaml:"ignore,omitempty"`
	// IgnoreIDOrCategoryToRootPaths
	IgnoreOnly                           map[string][]string `json:"ignore_only,omitempty" yaml:"ignore_only,omitempty"`
	EnumZeroValueSuffix                  string              `json:"enum_zero_value_suffix,omitempty" yaml:"enum_zero_value_suffix,omitempty"`
	RPCAllowSameRequestResponse          bool                `json:"rpc_allow_same_request_response,omitempty" yaml:"rpc_allow_same_request_response,omitempty"`
	RPCAllowGoogleProtobufEmptyRequests  bool                `json:"rpc_allow_google_protobuf_empty_requests,omitempty" yaml:"rpc_allow_google_protobuf_empty_requests,omitempty"`
	RPCAllowGoogleProtobufEmptyResponses bool                `json:"rpc_allow_google_protobuf_empty_responses,omitempty" yaml:"rpc_allow_google_protobuf_empty_responses,omitempty"`
	ServiceSuffix                        string              `json:"service_suffix,omitempty" yaml:"service_suffix,omitempty"`
	AllowCommentIgnores                  bool                `json:"allow_comment_ignores,omitempty" yaml:"allow_comment_ignores,omitempty"`
}

ExternalConfigV1 is an external config.

type ExternalConfigV1Beta1 ¶ added in v0.25.0

type ExternalConfigV1Beta1 struct {
	Use    []string `json:"use,omitempty" yaml:"use,omitempty"`
	Except []string `json:"except,omitempty" yaml:"except,omitempty"`
	// IgnoreRootPaths
	Ignore []string `json:"ignore,omitempty" yaml:"ignore,omitempty"`
	// IgnoreIDOrCategoryToRootPaths
	IgnoreOnly                           map[string][]string `json:"ignore_only,omitempty" yaml:"ignore_only,omitempty"`
	EnumZeroValueSuffix                  string              `json:"enum_zero_value_suffix,omitempty" yaml:"enum_zero_value_suffix,omitempty"`
	RPCAllowSameRequestResponse          bool                `json:"rpc_allow_same_request_response,omitempty" yaml:"rpc_allow_same_request_response,omitempty"`
	RPCAllowGoogleProtobufEmptyRequests  bool                `json:"rpc_allow_google_protobuf_empty_requests,omitempty" yaml:"rpc_allow_google_protobuf_empty_requests,omitempty"`
	RPCAllowGoogleProtobufEmptyResponses bool                `json:"rpc_allow_google_protobuf_empty_responses,omitempty" yaml:"rpc_allow_google_protobuf_empty_responses,omitempty"`
	ServiceSuffix                        string              `json:"service_suffix,omitempty" yaml:"service_suffix,omitempty"`
	AllowCommentIgnores                  bool                `json:"allow_comment_ignores,omitempty" yaml:"allow_comment_ignores,omitempty"`
}

ExternalConfigV1Beta1 is an external config.

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 *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.

type Rule ¶ added in v0.34.0

type Rule interface {
	bufcheck.Rule
	// contains filtered or unexported methods
}

Rule is a rule.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
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