internal

Jul 8, 2021

Changes in this version

type Helper

+ func (h *Helper) AddFileAnnotationWithExtraIgnoreDescriptorsf(descriptor protosource.Descriptor, ...)

Jan 18, 2021

Changes in this version

type Helper

+ func (h *Helper) AddFileAnnotationWithExtraIgnoreLocationsf(descriptor protosource.Descriptor, location protosource.Location, ...)

+ type RunnerOption func(*Runner)

+ func RunnerWithIgnorePrefix(ignorePrefix string) RunnerOption

Jan 4, 2021

Changes in this version

type Config

+ Rules []*Rule

+ type Rule struct

+ func (c *Rule) Categories() []string

+ func (c *Rule) ID() string

+ func (c *Rule) MarshalJSON() ([]byte, error)

+ func (c *Rule) Purpose() string

+ type RuleBuilder struct

+ func NewNopRuleBuilder(id string, purpose string, checkFunc CheckFunc) *RuleBuilder

+ func NewRuleBuilder(id string, newPurpose func(ConfigBuilder) (string, error), ...) *RuleBuilder

+ func (c *RuleBuilder) ID() string

+ func (c *RuleBuilder) NewRule(configBuilder ConfigBuilder, categories []string) (*Rule, error)

type VersionSpec

+ RuleBuilders []*RuleBuilder

Nov 24, 2020

Changes in this version

type Config

+ IgnoreUnstablePackages bool

type ConfigBuilder

+ IgnoreUnstablePackages bool

Oct 13, 2020

Changes in this version

+ type VersionSpec struct

+ AllCategories []string

+ CheckerBuilders []*CheckerBuilder

+ DefaultCategories []string

+ IDToCategories map[string][]string

May 31, 2020

Changes in this version

type Config

+ AllowCommentIgnores bool

type ConfigBuilder

+ AllowCommentIgnores bool

+ type IgnoreFunc func(id string, descriptor bufsrc.Descriptor, location bufsrc.Location) bool

Jan 17, 2020

Changes in this version

type Helper

+ func (h *Helper) AddFileAnnotationf(descriptor protodesc.Descriptor, location protodesc.Location, format string, ...)

+ func (h *Helper) FileAnnotations() []*filev1beta1.FileAnnotation

Oct 18, 2019

Changes in this version

+ func GetCheckersForCategories(checkers []bufcheck.Checker, allKnownCategories []string, categories []string) ([]bufcheck.Checker, error)

+ type CheckFunc func(id string, previousFiles []protodesc.File, files []protodesc.File) ([]*analysis.Annotation, error)

+ type Checker struct

+ func (c *Checker) Categories() []string

+ func (c *Checker) ID() string

+ func (c *Checker) MarshalJSON() ([]byte, error)

+ func (c *Checker) Purpose() string

+ type CheckerBuilder struct

+ func NewCheckerBuilder(id string, newPurpose func(ConfigBuilder) (string, error), ...) *CheckerBuilder

+ func NewNopCheckerBuilder(id string, purpose string, checkFunc CheckFunc) *CheckerBuilder

+ func (c *CheckerBuilder) ID() string

+ func (c *CheckerBuilder) NewChecker(configBuilder ConfigBuilder, categories []string) (*Checker, error)

+ type Config struct

+ Checkers []*Checker

+ IgnoreIDToRootPaths map[string]map[string]struct{}

+ IgnoreRootPaths map[string]struct{}

+ type ConfigBuilder struct

+ EnumZeroValueSuffix string

+ Except []string

+ IgnoreIDOrCategoryToRootPaths map[string][]string

+ IgnoreRootPaths []string

+ RPCAllowGoogleProtobufEmptyRequests bool

+ RPCAllowGoogleProtobufEmptyResponses bool

+ RPCAllowSameRequestResponse bool

+ ServiceSuffix string

+ Use []string

+ func (b ConfigBuilder) NewConfig(checkerBuilders []*CheckerBuilder, idToCategories map[string][]string, ...) (*Config, error)

+ type Helper struct

+ func NewHelper(id string) *Helper

+ func (h *Helper) AddAnnotationf(descriptor protodesc.Descriptor, location protodesc.Location, format string, ...)

+ func (h *Helper) Annotations() []*analysis.Annotation

+ type Runner struct

+ func NewRunner(logger *zap.Logger) *Runner

+ func (r *Runner) Check(ctx context.Context, config *Config, previousFiles []protodesc.File, ...) ([]*analysis.Annotation, error)