buflint

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

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

type ConfigBuilder struct {
	Use                                  []string
	Except                               []string
	IgnoreIDOrCategoryToRootPaths        map[string][]string
	IgnoreRootPaths                      []string
	EnumZeroValueSuffix                  string
	RPCAllowSameRequestResponse          bool
	RPCAllowGoogleProtobufEmptyRequests  bool
	RPCAllowGoogleProtobufEmptyResponses bool
	ServiceSuffix                        string
}

type Handler interface {
	// LintCheck 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.
	//
	// Annotations will use the image file paths, if these should be relative, use
	// FixAnnotationFilenames.
	LintCheck(
		ctx context.Context,
		lintConfig *Config,
		image *imagev1beta1.Image,
	) ([]*analysis.Annotation, error)
}

type Runner interface {
	// Check runs lint checkers, returning a system error if any system error occurs
	// or returning the annotations otherwise.
	//
	// Annotations will be sorted, but Filenames will not have the roots as a prefix, instead
	// they will be relative to the roots. This should be fixed for linter outputs if image
	// mode is not used.
	Check(context.Context, *Config, []protodesc.File) ([]*analysis.Annotation, error)
}