config

Documentation

Index

• Constants
• Variables
• type Data
  • func (d *Data) GetOpenAPIFilepath() (path string)
  • func (d *Data) GetOutputDir() (path string)
  • func (d *Data) GetTemplateFilesDir() (path string)
  • func (d *Data) Load() (err error)
• type Template

Constants

const SemVer = "0.0.11"

SemVer should be updated on any new release!!

Variables

var (
	Debug          bool
	Dryrun         bool
	VersionFlagSet bool
	// ConfigFilePath is `.` if not set through the `-configFile` flag
	ConfigFilePath string
	// ProcWorkingDir is set through calling os.Getwd()
	ProcWorkingDir string
	ExePath        string
)

Types

type Data

type Data struct {
	Template

	// left public due to it's need to be unmarshalled by Data.Load()
	TemplatesDir string `yaml:"templatesDir"`

	// OpenAPIFile represents the path to the yaml OpenAPI 3 file to render
	OpenAPIFile string

	OutputPath string
	// contains filtered or unexported fields
}

Data represents the config data used in the day-to-day running of can

TODO this may be vague in definition for the sake of its legibility in use

func (*Data) GetOpenAPIFilepath

func (d *Data) GetOpenAPIFilepath() (path string)

GetOpenAPIFilepath uses the current working directory, resolved config file and the openAPI file that was specified in the config file to determine the absolute path to an OpenAPI file. It takes into account that any of these, except the working directory could be relative. It returns the absolute value on every call by caching the result of it's first run and returning that on successive calls

func (*Data) GetOutputDir

func (d *Data) GetOutputDir() (path string)

GetOutputDir is used by the render engine to determine where rendered files will be written to

func (*Data) GetTemplateFilesDir

func (d *Data) GetTemplateFilesDir() (path string)

func (*Data) Load

func (d *Data) Load() (err error)

type Template

type Template struct {
	Name       string
	ModuleName string
	// BasePackageName represents the
	BasePackageName string
	// contains filtered or unexported fields
}

Template's fields are dependant on there being a defined templated name in the CLI arguments or config file.