config

Documentation

Index

• type BreakingConfig
• type CommitConfig
• type Config
  • func Load() (*Config, error)
  • func (c *Config) GetEmoji(commitType string) string
  • func (c *Config) GetScopes() []string
• type EmojiConfig
• type HooksConfig
• type ProjectConfig
• type ScopesConfig

Types

type BreakingConfig

type BreakingConfig struct {
	RequireDescription bool `toml:"require_description"`
}

type CommitConfig

type CommitConfig struct {
	MaxLength    int    `toml:"max_length"`
	RequireScope bool   `toml:"require_scope"`
	TicketPrefix string `toml:"ticket_prefix"`
}

type Config

type Config struct {
	Project  ProjectConfig  `toml:"project"`
	Scopes   ScopesConfig   `toml:"scopes"`
	Commit   CommitConfig   `toml:"commit"`
	Breaking BreakingConfig `toml:"breaking"`
	Emoji    EmojiConfig    `toml:"emoji"`
	Hooks    HooksConfig    `toml:"hooks"`
}

func Load

func Load() (*Config, error)

func (*Config) GetEmoji

func (c *Config) GetEmoji(commitType string) string

func (*Config) GetScopes

func (c *Config) GetScopes() []string

type EmojiConfig

type EmojiConfig struct {
	Enabled bool              `toml:"enabled"`
	Types   map[string]string `toml:"types"`
}

type HooksConfig

type HooksConfig struct {
	PreCommit  string `toml:"pre_commit"`
	PostCommit string `toml:"post_commit"`
}

type ProjectConfig

type ProjectConfig struct {
	Name        string `toml:"name"`
	Description string `toml:"description"`
}

type ScopesConfig

type ScopesConfig struct {
	Enabled bool     `toml:"enabled"`
	List    []string `toml:"list"`
}