config

Documentation

Index

• func BindToFlags(cfg *Config, fs *flag.FlagSet)
• type BoolCompareConfig
• type Config
  • func NewDefault() Config
  • func (cfg Config) Validate() error
• type EnumValue
  • func NewEnumValue[EnumT comparable](mapping map[string]EnumT, dst *EnumT) *EnumValue[EnumT]
  • func (e *EnumValue[EnumT]) Set(s string) error
  • func (e EnumValue[EnumT]) String() string
• type ExpectedActualConfig
• type FormatterConfig
• type GoRequireConfig
• type KnownCheckersValue
  • func (kcv KnownCheckersValue) Contains(v string) bool
  • func (kcv *KnownCheckersValue) Set(v string) error
  • func (kcv KnownCheckersValue) String() string
• type RegexpValue
  • func (rv *RegexpValue) Set(v string) error
  • func (rv RegexpValue) String() string
• type RequireErrorConfig
• type SuiteExtraAssertCallConfig

Functions

func BindToFlags

func BindToFlags(cfg *Config, fs *flag.FlagSet)

BindToFlags binds Config fields to according flags.

Types

type BoolCompareConfig

type BoolCompareConfig struct {
	IgnoreCustomTypes bool
}

BoolCompareConfig implements configuration of checkers.BoolCompare.

type Config

type Config struct {
	EnableAll        bool
	DisabledCheckers KnownCheckersValue
	DisableAll       bool
	EnabledCheckers  KnownCheckersValue

	BoolCompare          BoolCompareConfig
	ExpectedActual       ExpectedActualConfig
	Formatter            FormatterConfig
	GoRequire            GoRequireConfig
	RequireError         RequireErrorConfig
	SuiteExtraAssertCall SuiteExtraAssertCallConfig
}

Config implements testifylint configuration.

func NewDefault

func NewDefault() Config

NewDefault builds default testifylint config.

func (Config) Validate

func (cfg Config) Validate() error

type EnumValue

type EnumValue[EnumT comparable] struct {
	// contains filtered or unexported fields
}

EnumValue is a special type for support of flag.FlagSet over user-defined constants.

func NewEnumValue

func NewEnumValue[EnumT comparable](mapping map[string]EnumT, dst *EnumT) *EnumValue[EnumT]

NewEnumValue takes the "enum-value-name to enum-value" mapping and a destination for the value passed through the CLI. Returns an EnumValue instance suitable for flag.FlagSet.Var.

func (*EnumValue[EnumT]) Set

func (e *EnumValue[EnumT]) Set(s string) error

func (EnumValue[EnumT]) String

func (e EnumValue[EnumT]) String() string

type ExpectedActualConfig

type ExpectedActualConfig struct {
	ExpVarPattern RegexpValue
}

ExpectedActualConfig implements configuration of checkers.ExpectedActual.

type FormatterConfig

type FormatterConfig struct {
	CheckFormatString bool
	RequireFFuncs     bool
}

FormatterConfig implements configuration of checkers.Formatter.

type GoRequireConfig

type GoRequireConfig struct {
	IgnoreHTTPHandlers bool
}

GoRequireConfig implements configuration of checkers.GoRequire.

type KnownCheckersValue

type KnownCheckersValue []string

KnownCheckersValue implements comma separated list of testify checkers.

func (KnownCheckersValue) Contains

func (kcv KnownCheckersValue) Contains(v string) bool

func (*KnownCheckersValue) Set

func (kcv *KnownCheckersValue) Set(v string) error

func (KnownCheckersValue) String

func (kcv KnownCheckersValue) String() string

type RegexpValue

type RegexpValue struct {
	*regexp.Regexp
}

RegexpValue is a special wrapper for support of flag.FlagSet over regexp.Regexp. Original regexp is available through RegexpValue.Regexp.

func (*RegexpValue) Set

func (rv *RegexpValue) Set(v string) error

func (RegexpValue) String

func (rv RegexpValue) String() string

type RequireErrorConfig

type RequireErrorConfig struct {
	FnPattern RegexpValue
}

RequireErrorConfig implements configuration of checkers.RequireError.

type SuiteExtraAssertCallConfig

type SuiteExtraAssertCallConfig struct {
	Mode checkers.SuiteExtraAssertCallMode
}

SuiteExtraAssertCallConfig implements configuration of checkers.SuiteExtraAssertCall.