config

Documentation

Index

• Variables
• type Config
  • func NewConfigFromViper(v *viper.Viper) (*Config, error)
  • func (c *Config) CfgAsMap(ctx context.Context) (map[string]any, error)
  • func (c *Config) ExcludePath(path string) bool
  • func (c *Config) GetInterfaceConfig(ctx context.Context, packageName string, interfaceName string) ([]*Config, error)
  • func (c *Config) GetPackageConfig(ctx context.Context, packageName string) (*Config, error)
  • func (c *Config) GetPackages(ctx context.Context) ([]string, error)
  • func (c *Config) Initialize(ctx context.Context) error
  • func (c *Config) LogUnsupportedPackagesConfig(ctx context.Context)
  • func (c *Config) ShouldGenerateInterface(ctx context.Context, packageName, interfaceName string) (bool, error)
  • func (c *Config) TagName(name string) string
• type Interface

Variables

var (
	ErrNoConfigFile         = fmt.Errorf("no config file exists")
	ErrNoGoFilesFoundInRoot = fmt.Errorf("no go files found in root search path")
	ErrPkgNotFound          = fmt.Errorf("package not found in config")
)

Types

type Config

type Config struct {
	All                  bool                   `mapstructure:"all"`
	MockBuildTags        string                 `mapstructure:"mock-build-tags"`
	BuildTags            string                 `mapstructure:"tags"`
	Case                 string                 `mapstructure:"case"`
	Config               string                 `mapstructure:"config"`
	Cpuprofile           string                 `mapstructure:"cpuprofile"`
	Dir                  string                 `mapstructure:"dir"`
	DisableConfigSearch  bool                   `mapstructure:"disable-config-search"`
	DisableVersionString bool                   `mapstructure:"disable-version-string"`
	DryRun               bool                   `mapstructure:"dry-run"`
	ExcludeRegex         string                 `mapstructure:"exclude-regex"`
	Exported             bool                   `mapstructure:"exported"`
	FileName             string                 `mapstructure:"filename"`
	IncludeAutoGenerated bool                   `mapstructure:"include-auto-generated"`
	IncludeRegex         string                 `mapstructure:"include-regex"`
	InPackage            bool                   `mapstructure:"inpackage"`
	InPackageSuffix      bool                   `mapstructure:"inpackage-suffix"`
	KeepTree             bool                   `mapstructure:"keeptree"`
	LogLevel             string                 `mapstructure:"log-level"`
	MockName             string                 `mapstructure:"mockname"`
	Name                 string                 `mapstructure:"name"`
	Note                 string                 `mapstructure:"note"`
	Outpkg               string                 `mapstructure:"outpkg"`
	Output               string                 `mapstructure:"output"`
	Packages             map[string]interface{} `mapstructure:"packages"`
	Packageprefix        string                 `mapstructure:"packageprefix"`
	Print                bool                   `mapstructure:"print"`
	Profile              string                 `mapstructure:"profile"`
	Quiet                bool                   `mapstructure:"quiet"`
	Recursive            bool                   `mapstructure:"recursive"`
	Exclude              []string               `mapstructure:"exclude"`
	SrcPkg               string                 `mapstructure:"srcpkg"`
	BoilerplateFile      string                 `mapstructure:"boilerplate-file"`
	// StructName overrides the name given to the mock struct and should only be nonempty
	// when generating for an exact match (non regex expression in -name).
	StructName     string   `mapstructure:"structname"`
	TestOnly       bool     `mapstructure:"testonly"`
	UnrollVariadic bool     `mapstructure:"unroll-variadic"`
	Version        bool     `mapstructure:"version"`
	WithExpecter   bool     `mapstructure:"with-expecter"`
	ReplaceType    []string `mapstructure:"replace-type"`
	// contains filtered or unexported fields
}

func NewConfigFromViper

func NewConfigFromViper(v *viper.Viper) (*Config, error)

func (*Config) CfgAsMap

func (c *Config) CfgAsMap(ctx context.Context) (map[string]any, error)

CfgAsMap reads in the config file and returns a map representation, instead of a struct representation. This is mainly needed because viper throws away case-sensitivity in the `packages` section, which won't work when defining interface names 😞

func (*Config) ExcludePath

func (c *Config) ExcludePath(path string) bool

func (*Config) GetInterfaceConfig

func (c *Config) GetInterfaceConfig(ctx context.Context, packageName string, interfaceName string) ([]*Config, error)

func (*Config) GetPackageConfig

func (c *Config) GetPackageConfig(ctx context.Context, packageName string) (*Config, error)

GetPackageConfig returns a struct representation of the package's config as provided in yaml. If the package did not specify a config section, this method will inject the top-level config into the package's config. This is especially useful as it allows us to lazily evaluate a package's config. If the package does specify config, this method takes care to merge the top-level config with the values specified for this package.

func (*Config) GetPackages

func (c *Config) GetPackages(ctx context.Context) ([]string, error)

GetPackages returns a list of the packages that are defined in the `packages` config section.

func (*Config) Initialize

func (c *Config) Initialize(ctx context.Context) error

func (*Config) LogUnsupportedPackagesConfig

func (c *Config) LogUnsupportedPackagesConfig(ctx context.Context)

LogUnsupportedPackagesConfig is a method that will help aid migrations to the packages config feature. This is intended to be a temporary measure until v3 when we can remove all legacy config options.

func (*Config) ShouldGenerateInterface

func (c *Config) ShouldGenerateInterface(ctx context.Context, packageName, interfaceName string) (bool, error)

func (*Config) TagName

func (c *Config) TagName(name string) string

type Interface

type Interface struct {
	Config Config `mapstructure:"config"`
}