args

Documentation

Index

• func Validate(genericArgs *args.GeneratorArgs) error
• type CustomArgs
  • func NewDefaults() (*args.GeneratorArgs, *CustomArgs)
  • func (c *CustomArgs) AddFlags(fs *pflag.FlagSet)

Functions

func Validate

func Validate(genericArgs *args.GeneratorArgs) error

Validate checks the given arguments.

Types

type CustomArgs

type CustomArgs struct {
	// ReportFilename is added to CustomArgs for specifying name of report file used
	// by API linter. If specified, API rule violations will be printed to report file.
	// Otherwise default value "-" will be used which indicates stdout.
	ReportFilename string
}

CustomArgs is used by the gengo framework to pass args specific to this generator.

func NewDefaults

func NewDefaults() (*args.GeneratorArgs, *CustomArgs)

NewDefaults returns default arguments for the generator. Returning the arguments instead of using default flag parsing allows registering custom arguments afterwards

func (*CustomArgs) AddFlags

func (c *CustomArgs) AddFlags(fs *pflag.FlagSet)

AddFlags add the generator flags to the flag set.