config

Documentation

Index

• Constants
• func CheckFileWritable(path string) bool
• func SplitID(id string) (owner, name string, err error)
• type Cli
• type Config
  • func GetConfig(cp ConfigParser) (Config, error)
  • func NewProtectedConfig(config Config) Config
  • func (c *Config) Validate() error
• type ConfigParser
• type Github
• type Logger
• type Loggers
• type Net
• type Output
• type StartPoint
• type YAMLParser
  • func NewYAMLParser(fpath string) (*YAMLParser, error)
  • func (p *YAMLParser) Parse() (Config, error)

Constants

const (
	ErrScope = "config"

	ErrCodeParameter = 1
)

Functions

func CheckFileWritable

func CheckFileWritable(path string) bool

Check this file path is writable. Will create directories first.

func SplitID

func SplitID(id string) (owner, name string, err error)

Types

type Cli

type Cli struct {
	DisableProgressBar bool `yaml:"disable_progress_bar"`
}

type Config

type Config struct {
	ConfigPath    string `yaml:"config"`
	AccessToken   string `yaml:"access_token" validate:"required"`
	MaxConcurrent int    `yaml:"max_concurrent"`
	LogRespHead   int    `yaml:"log_resp_head"`
	StartPoint    `yaml:"start_point"`
	Network       Net     `yaml:"network"`
	Output        Output  `yaml:"output"`
	Github        Github  `yaml:"github"`
	Cli           Cli     `yaml:"cli"`
	Log           Loggers `yaml:"log"`
}

func GetConfig

func GetConfig(cp ConfigParser) (Config, error)

func NewProtectedConfig

func NewProtectedConfig(config Config) Config

func (*Config) Validate

func (c *Config) Validate() error

type ConfigParser

type ConfigParser interface {
	Parse() (Config, error)
}

type Github

type Github struct {
	HTMLHost string `yaml:"html_host"`
	ApiHost  string `yaml:"api_host"`
}

type Logger

type Logger struct {
	Level   string `yaml:"level"`
	Path    string `yaml:"path"`
	Console bool   `yaml:"console"`
}

type Loggers

type Loggers struct {
	Main Logger `yaml:"main"`
	Http Logger `yaml:"http"`
}

type Net

type Net struct {
	RetryTime     int           `yaml:"retry_time"`
	RetryInterval time.Duration `yaml:"retry_interval"`
}

type Output

type Output struct {
	Path string `yaml:"path"`
}

type StartPoint

type StartPoint struct {
	Path          string `yaml:"path" validate:"required"`
	ID            github.RepoID
	SectionFilter []string
}

type YAMLParser

type YAMLParser struct {
	// contains filtered or unexported fields
}

func NewYAMLParser

func NewYAMLParser(fpath string) (*YAMLParser, error)

func (*YAMLParser) Parse

func (p *YAMLParser) Parse() (Config, error)