breakingv1

Documentation

Index

• Variables
• type Config
  • func (x *Config) GetExceptIds() []string
  • func (x *Config) GetIgnoreIdPaths() []*IDPaths
  • func (x *Config) GetIgnorePaths() []string
  • func (x *Config) GetIgnoreUnstablePackages() bool
  • func (x *Config) GetUseIds() []string
  • func (x *Config) GetVersion() string
  • func (*Config) ProtoMessage()
  • func (x *Config) ProtoReflect() protoreflect.Message
  • func (x *Config) Reset()
  • func (x *Config) SetExceptIds(v []string)
  • func (x *Config) SetIgnoreIdPaths(v []*IDPaths)
  • func (x *Config) SetIgnorePaths(v []string)
  • func (x *Config) SetIgnoreUnstablePackages(v bool)
  • func (x *Config) SetUseIds(v []string)
  • func (x *Config) SetVersion(v string)
  • func (x *Config) String() string
• type Config_builder
  • func (b0 Config_builder) Build() *Config
• type IDPaths
  • func (x *IDPaths) GetId() string
  • func (x *IDPaths) GetPaths() []string
  • func (*IDPaths) ProtoMessage()
  • func (x *IDPaths) ProtoReflect() protoreflect.Message
  • func (x *IDPaths) Reset()
  • func (x *IDPaths) SetId(v string)
  • func (x *IDPaths) SetPaths(v []string)
  • func (x *IDPaths) String() string
• type IDPaths_builder
  • func (b0 IDPaths_builder) Build() *IDPaths

Variables

var File_buf_alpha_breaking_v1_config_proto protoreflect.FileDescriptor

Types

type Config

type Config struct {
	// contains filtered or unexported fields
}

Config represents the breaking change configuration for a module. The rule and category IDs are defined by the version and apply across the config. The version is independent of the version of the package. The package version refers to the config shape, the version encoded in the Config message indicates which rule and category IDs should be used.

The rule and category IDs are not encoded as enums in this package because we may want to support custom rule and category IDs in the future. Callers will need to resolve the rule and category ID strings.

func (*Config) GetExceptIds

func (x *Config) GetExceptIds() []string

func (*Config) GetIgnoreIdPaths

func (x *Config) GetIgnoreIdPaths() []*IDPaths

func (*Config) GetIgnorePaths

func (x *Config) GetIgnorePaths() []string

func (*Config) GetIgnoreUnstablePackages

func (x *Config) GetIgnoreUnstablePackages() bool

func (*Config) GetUseIds

func (x *Config) GetUseIds() []string

func (*Config) GetVersion

func (x *Config) GetVersion() string

func (*Config) ProtoMessage

func (*Config) ProtoMessage()

func (*Config) ProtoReflect

func (x *Config) ProtoReflect() protoreflect.Message

func (*Config) Reset

func (x *Config) Reset()

func (*Config) SetExceptIds

func (x *Config) SetExceptIds(v []string)

func (*Config) SetIgnoreIdPaths

func (x *Config) SetIgnoreIdPaths(v []*IDPaths)

func (*Config) SetIgnorePaths

func (x *Config) SetIgnorePaths(v []string)

func (*Config) SetIgnoreUnstablePackages

func (x *Config) SetIgnoreUnstablePackages(v bool)

func (*Config) SetUseIds

func (x *Config) SetUseIds(v []string)

func (*Config) SetVersion

func (x *Config) SetVersion(v string)

func (*Config) String

func (x *Config) String() string

type Config_builder

type Config_builder struct {

	// version represents the version of the breaking change rule and category IDs that should be used with this config.
	Version string
	// use_ids lists the rule and/or category IDs that are included in the breaking change check.
	UseIds []string
	// except_ids lists the rule and/or category IDs that are excluded from the breaking change check.
	ExceptIds []string
	// ignore_paths lists the paths of directories and/or files that should be ignored by the breaking change check.
	// All paths are relative to the root of the module.
	IgnorePaths []string
	// ignore_id_paths is a map of rule and/or category IDs to directory and/or file paths to exclude from the
	// breaking change check. This corresponds with the ignore_only configuration key.
	IgnoreIdPaths []*IDPaths
	// ignore_unstable_packages ignores packages with a last component that is one of the unstable forms recognised
	// by the PACKAGE_VERSION_SUFFIX:
	//
	//	v\d+test.*
	//	v\d+(alpha|beta)\d+
	//	v\d+p\d+(alpha|beta)\d+
	IgnoreUnstablePackages bool
	// contains filtered or unexported fields
}

func (Config_builder) Build

func (b0 Config_builder) Build() *Config

type IDPaths

type IDPaths struct {
	// contains filtered or unexported fields
}

IDPaths represents a rule or category ID and the file and/or directory paths that are ignored for the rule.

func (*IDPaths) GetId

func (x *IDPaths) GetId() string

func (*IDPaths) GetPaths

func (x *IDPaths) GetPaths() []string

func (*IDPaths) ProtoMessage

func (*IDPaths) ProtoMessage()

func (*IDPaths) ProtoReflect

func (x *IDPaths) ProtoReflect() protoreflect.Message

func (*IDPaths) Reset

func (x *IDPaths) Reset()

func (*IDPaths) SetId

func (x *IDPaths) SetId(v string)

func (*IDPaths) SetPaths

func (x *IDPaths) SetPaths(v []string)

func (*IDPaths) String

func (x *IDPaths) String() string

type IDPaths_builder

type IDPaths_builder struct {
	Id    string
	Paths []string
	// contains filtered or unexported fields
}

func (IDPaths_builder) Build

func (b0 IDPaths_builder) Build() *IDPaths