config

Documentation

Index

• type Arguments
• type Config
  • func (c Config) Validate() error
• type Package
  • func (p Package) Validate() error
• type Packages
  • func (p Packages) Validate() error

Types

type Arguments

type Arguments struct {
	Output    string `env:"OUT" envDefault:"out"`
	Config    string `env:"CONFIG" envDefault:"vanitygen.yaml"`
	Formatter string `env:"FORMAT" envDefault:"plain"`
}

type Config

type Config struct {
	Domain   string   `json:"domain" yaml:"domain"`
	SiteName string   `json:"siteName" yaml:"siteName"`
	Author   string   `json:"author" yaml:"author"`
	DocsURL  *string  `json:"docs" yaml:"docs"`
	Packages Packages `json:"pkgs" yaml:"pkgs"`
}

func (Config) Validate

func (c Config) Validate() error

type Package

type Package struct {
	Name          string   `json:"name" yaml:"name"`
	Provider      string   `json:"provider" yaml:"provider"`
	RepositoryURL string   `json:"repoUrl" yaml:"repoUrl"`
	Branch        string   `json:"branch" yaml:"branch"`
	Website       *string  `json:"website,omitempty" yaml:"website,omitempty"`
	Subpackages   []string `json:"subpackages,omitempty" yaml:"subpackages,omitempty"`
}

func (Package) Validate

func (p Package) Validate() error

type Packages

type Packages []Package

func (Packages) Validate

func (p Packages) Validate() error