config

Documentation

Overview

Package config loads git-customs TOML configuration.

Index

• func DefaultPath() (string, error)
• type Config
  • func Load(path string) (*Config, error)
  • func (c *Config) CommandList() []string
  • func (c *Config) TimeoutDuration() time.Duration
• type VisibilityConfig

Functions

func DefaultPath

func DefaultPath() (string, error)

DefaultPath returns ~/.config/git-customs/config.toml.

Types

type Config

type Config struct {
	Command      string           `toml:"command"`
	Commands     []string         `toml:"commands"`
	Timeout      string           `toml:"timeout"`
	ClearPattern string           `toml:"clear_pattern"`
	Repos        map[string]bool  `toml:"repos"`
	Visibility   VisibilityConfig `toml:"visibility"`
}

Config is the git-customs configuration.

func Load

func Load(path string) (*Config, error)

Load reads config from path. A missing file yields defaults and a nil error.

func (*Config) CommandList

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

CommandList returns the commands to run, in order. `commands` takes precedence over the single `command`; each command receives the full diff on stdin and must pass for the push to be allowed.

func (*Config) TimeoutDuration

func (c *Config) TimeoutDuration() time.Duration

TimeoutDuration parses Timeout, defaulting to 60s on error.

type VisibilityConfig

type VisibilityConfig struct {
	SkipHosts  []string `toml:"skip_hosts"`
	SkipOwners []string `toml:"skip_owners"`
}

VisibilityConfig lists hosts/owners always treated as private.