config

Documentation

Index

• func TryBool(c *cli.Context, flag string) bool
• func WriteConfigFile(conf *CLIConfig) error
• type AnalyzeConfig
• type BuildConfig
• type CLIConfig
  • func MustNew(c *cli.Context) CLIConfig
  • func New(c *cli.Context) (CLIConfig, error)
• type DefaultConfig
• type ReportConfig
• type TestConfig
• type UploadConfig

Functions

func TryBool

func TryBool(c *cli.Context, flag string) bool

func WriteConfigFile

func WriteConfigFile(conf *CLIConfig) error

WriteConfigFile writes a config state to yaml

Types

type AnalyzeConfig

type AnalyzeConfig struct {
	Output          bool
	AllowUnresolved bool
}

AnalyzeConfig specifies the config for the analyze command

type BuildConfig

type BuildConfig struct {
	Force bool
}

BuildConfig specifies the config for the build command

type CLIConfig

type CLIConfig struct {
	APIKey   string
	Fetcher  string
	Project  string
	Revision string
	Branch   string
	Endpoint string
	Modules  []module.Config

	Debug       bool
	Interactive bool

	DefaultCmd DefaultConfig
	AnalyzeCmd AnalyzeConfig
	BuildCmd   BuildConfig
	TestCmd    TestConfig
	UploadCmd  UploadConfig
	ReportCmd  ReportConfig

	ConfigFilePath string
	Version        string
}

CLIConfig specifies the config available to the cli

func MustNew

func MustNew(c *cli.Context) CLIConfig

MustNew calls New but fails on an error instead of returning the error

func New

func New(c *cli.Context) (CLIConfig, error)

New creates a CLIConfig from a *cli.Context

type DefaultConfig

type DefaultConfig struct {
	Build bool
}

DefaultConfig specifies the config for the default command

type ReportConfig

type ReportConfig struct {
	Type string // Either "dependencies" or "licenses"
}

ReportConfig specifies the config for the report command

type TestConfig

type TestConfig struct {
	Timeout time.Duration
}

TestConfig specifies the config for the test command

type UploadConfig

type UploadConfig struct {
	UseLocators bool
	Data        string
}

UploadConfig specifies the config for the upload command