config

Documentation

Index

• Variables
• type Config
  • func (cfg *Config) Defaults() error
• type File
  • func (f *File) FromArg(read bool) error
  • func (f *File) Load() (*Config, error)
  • func (f *File) Parse() (*Config, error)
  • func (f *File) RemoveJSONComments()

Variables

var (

	// SafeVarName is used to remove special chars from paths
	SafeVarName = regexp.MustCompile(`[^a-zA-Z0-9]`)
)

Types

type Config

type Config struct {
	Dest        string
	Pkg         string
	Fmt         bool // gofmt
	Compression *compression.Options
	Tags        string

	Output string

	Custom []custom.Custom

	Spread     bool
	Unexported bool
	Clean      bool
	Debug      bool
	Updater    updater.Config
}

Config holds the json/yaml/toml data

func (*Config) Defaults

func (cfg *Config) Defaults() error

Defaults set the default value for some variables

type File

type File struct {
	FilePath string
	Data     []byte
	Mode     string // "json" || "yaml" || "yml" || "toml"
}

File holds config file info

func (*File) FromArg

func (f *File) FromArg(read bool) error

FromArg gets the json/yaml/toml file from args

func (*File) Load

func (f *File) Load() (*Config, error)

Load the json/yaml file that was specified from args and transform it into a config struct

func (*File) Parse

func (f *File) Parse() (*Config, error)

Parse gets the config file's content from File.Data

func (*File) RemoveJSONComments

func (f *File) RemoveJSONComments()

RemoveJSONComments from the file