config

package

v0.14.1 Latest Latest Go to latest Published: May 22, 2025 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/mikelorant/committed

Links

Open Source Insights

Documentation ¶

Index ¶

type Colour
- func ParseColour(str string) Colour
- func (c Colour) Default() int
- func (c Colour) Index() int
- 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) Default() int
- func (c Compatibility) Index() int
- 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) Default() int
- func (e EmojiSelector) Index() int
- func (e EmojiSelector) MarshalYAML() (interface{}, error)
- func (e *EmojiSelector) UnmarshalYAML(value *yaml.Node) error
type EmojiSet
- func ParseEmojiSet(str string) EmojiSet
- func (e EmojiSet) Default() int
- func (e EmojiSet) Index() int
- func (e EmojiSet) MarshalYAML() (interface{}, error)
- func (e *EmojiSet) UnmarshalYAML(value *yaml.Node) error
type EmojiType
- func ParseEmojiType(str string) EmojiType
- func (e EmojiType) Default() int
- func (e EmojiType) Index() int
- func (e EmojiType) MarshalYAML() (interface{}, error)
- func (e *EmojiType) UnmarshalYAML(value *yaml.Node) error
type Focus
- func ParseFocus(str string) Focus
- func (f Focus) Default() int
- func (f Focus) Index() int
- func (f Focus) MarshalYAML() (interface{}, error)
- func (f *Focus) UnmarshalYAML(value *yaml.Node) error
type Theme
type View

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Colour ¶

type Colour int

const (
	ColourUnset Colour = iota
	ColourAdaptive
	ColourDark
	ColourLight
)

func ParseColour ¶

func ParseColour(str string) Colour

func (Colour) Default ¶ added in v0.11.0

func (c Colour) Default() int

func (Colour) Index ¶ added in v0.11.0

func (c Colour) Index() int

func (Colour) MarshalYAML ¶ added in v0.8.0

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
	CompatibilityUnicode14
	CompatibilityUnicode9
)

func ParseCompatibility ¶

func ParseCompatibility(str string) Compatibility

func (Compatibility) Default ¶ added in v0.11.0

func (c Compatibility) Default() int

func (Compatibility) Index ¶ added in v0.11.0

func (c Compatibility) Index() int

func (Compatibility) MarshalYAML ¶ added in v0.8.0

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"`
	Commit  Commit            `yaml:"commit,omitempty"`
	Authors []repository.User `yaml:"authors,omitempty"`
	Update  bool              `yaml:"-"`
}

func (*Config) Load ¶ added in v0.8.0

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

func (*Config) Save ¶ added in v0.8.0

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) Default ¶ added in v0.11.0

func (e EmojiSelector) Default() int

func (EmojiSelector) Index ¶ added in v0.11.0

func (e EmojiSelector) Index() int

func (EmojiSelector) MarshalYAML ¶ added in v0.8.0

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
	EmojiSetCommitted
	EmojiSetGitmoji
	EmojiSetDevmoji
	EmojiSetEmojiLog
)

func ParseEmojiSet ¶

func ParseEmojiSet(str string) EmojiSet

func (EmojiSet) Default ¶ added in v0.11.0

func (e EmojiSet) Default() int

func (EmojiSet) Index ¶ added in v0.11.0

func (e EmojiSet) Index() int

func (EmojiSet) MarshalYAML ¶ added in v0.8.0

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) Default ¶ added in v0.11.0

func (e EmojiType) Default() int

func (EmojiType) Index ¶ added in v0.11.0

func (e EmojiType) Index() int

func (EmojiType) MarshalYAML ¶ added in v0.8.0

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) Default ¶ added in v0.11.0

func (f Focus) Default() int

func (Focus) Index ¶ added in v0.11.0

func (f Focus) Index() int

func (Focus) MarshalYAML ¶ added in v0.8.0

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"`
	EmojiSet           EmojiSet      `yaml:"emojiSet,omitempty"`
	EmojiSelector      EmojiSelector `yaml:"emojiSelector,omitempty"`
	Compatibility      Compatibility `yaml:"compatibility,omitempty"`
	Theme              string        `yaml:"theme,omitempty"`
	Colour             Colour        `yaml:"colour,omitempty"`
	HighlightActive    bool          `yaml:"highlightActive,omitempty"`
	IgnoreGlobalAuthor bool          `yaml:"ignoreGlobalAuthor,omitempty"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL