bufcheck

Documentation

Index

• func GetDeprecatedIDToReplacementIDs[R RuleOrCategory](rulesOrCategories []R) (map[string][]string, error)
• func PrintRules(writer io.Writer, rules []Rule, options ...PrintRulesOption) (retErr error)
• type AllCategoriesOption
• type AllRulesOption
• type BreakingOption
  • func BreakingWithExcludeImports() BreakingOption
• type Category
• type Client
  • func NewClient(logger *zap.Logger, tracer tracing.Tracer, runnerProvider RunnerProvider, ...) (Client, error)
• type ClientFunctionOption
  • func WithPluginConfigs(pluginConfigs ...bufconfig.PluginConfig) ClientFunctionOption
• type ClientOption
  • func ClientWithStderr(stderr io.Writer) ClientOption
• type ConfiguredRulesOption
• type LintOption
• type PrintRulesOption
  • func PrintRulesWithDeprecated() PrintRulesOption
  • func PrintRulesWithJSON() PrintRulesOption
• type Rule
• type RuleOrCategory
• type RunnerProvider
  • func NewRunnerProvider(delegate command.Runner) RunnerProvider
• type RunnerProviderFunc
  • func (r RunnerProviderFunc) NewRunner(pluginConfig bufconfig.PluginConfig) (pluginrpc.Runner, error)

Functions

func GetDeprecatedIDToReplacementIDs

func GetDeprecatedIDToReplacementIDs[R RuleOrCategory](rulesOrCategories []R) (map[string][]string, error)

GetDeprecatedIDToReplacementIDs gets a map from deprecated ID to replacement IDs.

func PrintRules

func PrintRules(writer io.Writer, rules []Rule, options ...PrintRulesOption) (retErr error)

PrintRules prints the rules to the Writer.

Types

type AllCategoriesOption

type AllCategoriesOption interface {
	// contains filtered or unexported methods
}

AllCategoriesOption is an option for AllCategories.

type AllRulesOption

type AllRulesOption interface {
	// contains filtered or unexported methods
}

AllRulesOption is an option for AllRules.

type BreakingOption

type BreakingOption interface {
	// contains filtered or unexported methods
}

BreakingOption is an option for Breaking.

func BreakingWithExcludeImports

func BreakingWithExcludeImports() BreakingOption

BreakingWithExcludeImports returns a new BreakingOption that says to exclude imports from breaking change detection.

The default is to check imports for breaking changes.

type Category

type Category interface {
	check.Category

	// Plugin returns the name of the plugin that created this Category.
	//
	// Names are freeform.
	//
	// Will be empty for Categorys based on builtin plugins.
	PluginName() string
	// contains filtered or unexported methods
}

Category is an individual line or breaking Category.

It wraps check.Category and adds the name of the plugin that implements the Category.

type Client

type Client interface {
	// Lint lints the given Image with the given LintConfig.
	//
	// The Image should have source code info for this to work properly.
	//
	// Images should *not* be filtered with regards to imports before passing to this function.
	//
	// An error of type bufanalysis.FileAnnotationSet will be returned lint failure.
	Lint(ctx context.Context, config bufconfig.LintConfig, image bufimage.Image, options ...LintOption) error
	// Breaking checks the given Images for breaking changes with the given BreakingConfig.
	//
	// The Images should have source code info for this to work properly.
	//
	// Images should *not* be filtered with regards to imports before passing to this function.
	// To exclude imports, pass BreakingWithExcludeImports.
	//
	// An error of type bufanalysis.FileAnnotationSet will be returned lint failure.
	Breaking(ctx context.Context, config bufconfig.BreakingConfig, image bufimage.Image, againstImage bufimage.Image, options ...BreakingOption) error
	// ConfiguredRules returns all of the Configured Rules for the given RuleType.
	ConfiguredRules(ctx context.Context, ruleType check.RuleType, config bufconfig.CheckConfig, options ...ConfiguredRulesOption) ([]Rule, error)
	// AllRules returns all Rules (configured or not) for the given RuleType.
	AllRules(ctx context.Context, ruleType check.RuleType, fileVersion bufconfig.FileVersion, options ...AllRulesOption) ([]Rule, error)
	// AllCategories returns all Categories.
	AllCategories(ctx context.Context, fileVersion bufconfig.FileVersion, options ...AllCategoriesOption) ([]Category, error)
}

Rules are returned sorted by ID, but PrintRules does our sort by category.

func NewClient

func NewClient(
	logger *zap.Logger,
	tracer tracing.Tracer,
	runnerProvider RunnerProvider,
	options ...ClientOption,
) (Client, error)

NewClient returns a new Client.

type ClientFunctionOption

type ClientFunctionOption interface {
	LintOption
	BreakingOption
	ConfiguredRulesOption
	AllRulesOption
	AllCategoriesOption
}

ClientFunctionOption is an option that applies to any Client function.

func WithPluginConfigs

func WithPluginConfigs(pluginConfigs ...bufconfig.PluginConfig) ClientFunctionOption

WithPluginConfigs returns a new ClientFunctionOption that says to also use the given plugins.

The default is to only use the builtin Rules and Categories.

type ClientOption

type ClientOption func(*clientOptions)

ClientOption is an option for a new Client.

func ClientWithStderr

func ClientWithStderr(stderr io.Writer) ClientOption

ClientWithStderr returns a new ClientOption that specifies a stderr to proxy plugin stderrs to.

The default is the equivalent of /dev/null.

type ConfiguredRulesOption

type ConfiguredRulesOption interface {
	// contains filtered or unexported methods
}

ConfiguredRulesOption is an option for ConfiguredRules.

type LintOption

type LintOption interface {
	// contains filtered or unexported methods
}

LintOption is an option for Lint.

type PrintRulesOption

type PrintRulesOption func(*printRulesOptions)

PrintRulesOption is an option for PrintRules.

func PrintRulesWithDeprecated

func PrintRulesWithDeprecated() PrintRulesOption

PrintRulesWithDeprecated returns a new PrintRulesOption that resullts in deprecated rules being printed.

func PrintRulesWithJSON

func PrintRulesWithJSON() PrintRulesOption

PrintRulesWithJSON returns a new PrintRulesOption that says to print the rules as JSON.

The default is to print as text.

type Rule

type Rule interface {
	check.Rule

	// BufcheckCategories returns the Rule's Categories.
	BufcheckCategories() []Category

	// Plugin returns the name of the plugin that created this Rule.
	//
	// Names are freeform.
	//
	// Will be empty for Rules based on builtin plugins.
	PluginName() string
	// contains filtered or unexported methods
}

Rule is an individual line or breaking Rule.

It wraps check.Rule and adds the name of the plugin that implements the Rule.

type RuleOrCategory

type RuleOrCategory interface {
	ID() string
	Purpose() string
	Deprecated() bool
	ReplacementIDs() []string
	PluginName() string
	// contains filtered or unexported methods
}

RuleOrCategory is a union interface with the common types in both Rule and Category.

type RunnerProvider

type RunnerProvider interface {
	NewRunner(pluginConfig bufconfig.PluginConfig) (pluginrpc.Runner, error)
}

RunnerProvider provides pluginrpc.Runners for a given plugin config.

func NewRunnerProvider

func NewRunnerProvider(delegate command.Runner) RunnerProvider

NewRunnerProvider returns a new RunnerProvider for the command.Runner.

type RunnerProviderFunc

type RunnerProviderFunc func(pluginConfig bufconfig.PluginConfig) (pluginrpc.Runner, error)

RunnerProviderFunc is a function that implements RunnerProvider.

func (RunnerProviderFunc) NewRunner

func (r RunnerProviderFunc) NewRunner(pluginConfig bufconfig.PluginConfig) (pluginrpc.Runner, error)

NewRunner implements RunnerProvider.