config

Documentation

Index

• Variables
• type Config
  • func ReadFile(path string) (c *Config, rerr error)
  • func ReadIOJSON(reader io.Reader) (*Config, error)
  • func ReadIOYAML(reader io.Reader) (*Config, error)
  • func ReadString(data string) (*Config, error)
• type FileType
• type License

Variables

var (
	ErrFilePathInvalid = errors.New("File Path invalid")
	ErrFileTypeInvalid = errors.New("File Type invalid")
	ErrDataInvalid     = errors.New("Data invalid")
)

Error definitions

Types

type Config

type Config struct {
	License  License    `yaml:"license" json:"license"`
	Files    []FileType `yaml:"files" json:"files"`
	Excludes []string   `yaml:"excludes" json:"excludes"`
}

Config ...

func ReadFile

func ReadFile(path string) (c *Config, rerr error)

ReadFile ...

func ReadIOJSON

func ReadIOJSON(reader io.Reader) (*Config, error)

ReadIOJSON ...

func ReadIOYAML

func ReadIOYAML(reader io.Reader) (*Config, error)

ReadIOYAML ...

func ReadString

func ReadString(data string) (*Config, error)

ReadString ...

type FileType

type FileType struct {
	Match   string `yaml:"match" json:"match"`
	Comment string `yaml:"comment" json:"comment"`
}

FileType ...

type License

type License struct {
	Path    string `yaml:"path" json:"path"`
	Content string `yaml:"content" json:"content"`
}

License ...