config

Documentation

Index

• type Colour
  • func ParseColour(str string) Colour
  • func (c Colour) MarshalYAML() (interface{}, error)
  • func (c *Colour) UnmarshalYAML(value *yaml.Node) error
• type Commit
• type Compatibility
  • func ParseCompatibility(str string) Compatibility
  • func (c Compatibility) MarshalYAML() (interface{}, error)
  • func (c *Compatibility) UnmarshalYAML(value *yaml.Node) error
• type Config
  • func (c *Config) Load(fh io.Reader) (Config, error)
  • func (c *Config) Save(fh io.WriteCloser, cfg Config) error
• type EmojiSelector
  • func ParseEmojiSelector(str string) EmojiSelector
  • func (e EmojiSelector) MarshalYAML() (interface{}, error)
  • func (e *EmojiSelector) UnmarshalYAML(value *yaml.Node) error
• type EmojiSet
  • func ParseEmojiSet(str string) EmojiSet
  • func (e EmojiSet) MarshalYAML() (interface{}, error)
  • func (e *EmojiSet) UnmarshalYAML(value *yaml.Node) error
• type EmojiType
  • func ParseEmojiType(str string) EmojiType
  • func (e EmojiType) MarshalYAML() (interface{}, error)
  • func (e *EmojiType) UnmarshalYAML(value *yaml.Node) error
• type Focus
  • func ParseFocus(str string) Focus
  • func (f Focus) MarshalYAML() (interface{}, error)
  • func (f *Focus) UnmarshalYAML(value *yaml.Node) error
• type Theme
• type View

Types

type Colour

type Colour int

const (
	ColourUnset Colour = iota
	ColourAdaptive
	ColourDark
	ColourLight
)

func ParseColour

func ParseColour(str string) Colour

func (Colour) MarshalYAML

func (c Colour) MarshalYAML() (interface{}, error)

func (*Colour) UnmarshalYAML

func (c *Colour) UnmarshalYAML(value *yaml.Node) error

type Commit

type Commit struct {
	EmojiType EmojiType `yaml:"emojiType,omitempty"`
	Signoff   bool      `yaml:"signoff,omitempty"`
}

type Compatibility

type Compatibility int

const (
	CompatibilityUnset Compatibility = iota
	CompatibilityDefault
	CompatibilityTtyd
	CompatibilityKitty
)

func ParseCompatibility

func ParseCompatibility(str string) Compatibility

func (Compatibility) MarshalYAML

func (c Compatibility) MarshalYAML() (interface{}, error)

func (*Compatibility) UnmarshalYAML

func (c *Compatibility) UnmarshalYAML(value *yaml.Node) error

type Config

type Config struct {
	View    View              `yaml:"view,omitempty,flow"`
	Commit  Commit            `yaml:"commit,omitempty,flow"`
	Authors []repository.User `yaml:"authors,omitempty,flow"`
}

func (*Config) Load

func (c *Config) Load(fh io.Reader) (Config, error)

func (*Config) Save

func (c *Config) Save(fh io.WriteCloser, cfg Config) error

type EmojiSelector

type EmojiSelector int

const (
	EmojiSelectorUnset EmojiSelector = iota
	EmojiSelectorBelow
	EmojiSelectorAbove
)

func ParseEmojiSelector

func ParseEmojiSelector(str string) EmojiSelector

func (EmojiSelector) MarshalYAML

func (e EmojiSelector) MarshalYAML() (interface{}, error)

func (*EmojiSelector) UnmarshalYAML

func (e *EmojiSelector) UnmarshalYAML(value *yaml.Node) error

type EmojiSet

type EmojiSet int

const (
	EmojiSetUnset EmojiSet = iota
	EmojiSetGitmoji
	EmojiSetDevmoji
	EmojiSetEmojiLog
)

func ParseEmojiSet

func ParseEmojiSet(str string) EmojiSet

func (EmojiSet) MarshalYAML

func (e EmojiSet) MarshalYAML() (interface{}, error)

func (*EmojiSet) UnmarshalYAML

func (e *EmojiSet) UnmarshalYAML(value *yaml.Node) error

type EmojiType

type EmojiType int

const (
	EmojiTypeUnset EmojiType = iota
	EmojiTypeShortcode
	EmojiTypeCharacter
)

func ParseEmojiType

func ParseEmojiType(str string) EmojiType

func (EmojiType) MarshalYAML

func (e EmojiType) MarshalYAML() (interface{}, error)

func (*EmojiType) UnmarshalYAML

func (e *EmojiType) UnmarshalYAML(value *yaml.Node) error

type Focus

type Focus int

const (
	FocusUnset Focus = iota
	FocusAuthor
	FocusEmoji
	FocusSummary
)

func ParseFocus

func ParseFocus(str string) Focus

func (Focus) MarshalYAML

func (f Focus) MarshalYAML() (interface{}, error)

func (*Focus) UnmarshalYAML

func (f *Focus) UnmarshalYAML(value *yaml.Node) error

type Theme

type Theme int

type View

type View struct {
	Focus              Focus         `yaml:"focus,omitempty,flow"`
	EmojiSet           EmojiSet      `yaml:"emojiSet,omitempty,flow"`
	EmojiSelector      EmojiSelector `yaml:"emojiSelector,omitempty,flow"`
	Compatibility      Compatibility `yaml:"compatibility,omitempty,flow"`
	Theme              string        `yaml:"theme,omitempty,flow"`
	Colour             Colour        `yaml:"colour,omitempty,flow"`
	HighlightActive    bool          `yaml:"highlightActive,omitempty,flow"`
	IgnoreGlobalAuthor bool          `yaml:"ignoreGlobalAuthor,omitempty,flow"`
}