config

Documentation

Index

• Constants
• Variables
• func ConfigDir() string
• func ConfigFile() string
• func NewBlankRoot() *yaml.Node
• func StubBackupConfig() func()
• func StubConfig(main, hosts string) func()
• func StubWriteConfig(wc io.Writer, wh io.Writer) func()
• type AliasConfig
  • func (a *AliasConfig) Add(alias, expansion string) error
  • func (a *AliasConfig) All() map[string]string
  • func (a *AliasConfig) Delete(alias string) error
  • func (a *AliasConfig) Get(alias string) (string, bool)
• type Config
  • func InheritEnv(c Config) Config
  • func NewBlankConfig() Config
  • func NewConfig(root *yaml.Node) Config
  • func NewFromString(str string) Config
  • func ParseConfig(filename string) (Config, error)
  • func ParseDefaultConfig() (Config, error)
• type ConfigEntry
• type ConfigMap
  • func (cm *ConfigMap) Empty() bool
  • func (cm *ConfigMap) FindEntry(key string) (ce *ConfigEntry, err error)
  • func (cm *ConfigMap) GetStringValue(key string) (string, error)
  • func (cm *ConfigMap) RemoveEntry(key string)
  • func (cm *ConfigMap) SetStringValue(key, value string) error
• type HostConfig
• type NotFoundError

Constants

const (
	PromptsDisabled = "disabled"
	PromptsEnabled  = "enabled"
)

const (
	GITHUB_TOKEN            = "GITHUB_TOKEN"
	GITHUB_ENTERPRISE_TOKEN = "GITHUB_ENTERPRISE_TOKEN"
)

Variables

var BackupConfigFile = func(filename string) error {
	return os.Rename(filename, filename+".bak")
}

var ReadConfigFile = func(filename string) ([]byte, error) {
	f, err := os.Open(filename)
	if err != nil {
		return nil, pathError(err)
	}
	defer f.Close()

	data, err := ioutil.ReadAll(f)
	if err != nil {
		return nil, err
	}

	return data, nil
}

var WriteConfigFile = func(filename string, data []byte) error {
	err := os.MkdirAll(path.Dir(filename), 0771)
	if err != nil {
		return pathError(err)
	}

	cfgFile, err := os.OpenFile(filename, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0600)
	if err != nil {
		return err
	}
	defer cfgFile.Close()

	n, err := cfgFile.Write(data)
	if err == nil && n < len(data) {
		err = io.ErrShortWrite
	}

	return err
}

Functions

func ConfigDir

func ConfigDir() string

func ConfigFile

func ConfigFile() string

func NewBlankRoot

func NewBlankRoot() *yaml.Node

func StubBackupConfig

func StubBackupConfig() func()

func StubConfig

func StubConfig(main, hosts string) func()

func StubWriteConfig

func StubWriteConfig(wc io.Writer, wh io.Writer) func()

Types

type AliasConfig

type AliasConfig struct {
	ConfigMap
	Parent Config
}

func (*AliasConfig) Add

func (a *AliasConfig) Add(alias, expansion string) error

func (*AliasConfig) All

func (a *AliasConfig) All() map[string]string

func (*AliasConfig) Delete

func (a *AliasConfig) Delete(alias string) error

func (*AliasConfig) Get

func (a *AliasConfig) Get(alias string) (string, bool)

type Config

type Config interface {
	Get(string, string) (string, error)
	GetWithSource(string, string) (string, string, error)
	Set(string, string, string) error
	UnsetHost(string)
	Hosts() ([]string, error)
	Aliases() (*AliasConfig, error)
	CheckWriteable(string, string) error
	Write() error
}

This interface describes interacting with some persistent configuration for gh.

func InheritEnv

func InheritEnv(c Config) Config

func NewBlankConfig

func NewBlankConfig() Config

NewBlankConfig initializes a config file pre-populated with comments and default values

func NewConfig

func NewConfig(root *yaml.Node) Config

func NewFromString

func NewFromString(str string) Config

NewFromString initializes a Config from a yaml string

func ParseConfig

func ParseConfig(filename string) (Config, error)

func ParseDefaultConfig

func ParseDefaultConfig() (Config, error)

type ConfigEntry

type ConfigEntry struct {
	KeyNode   *yaml.Node
	ValueNode *yaml.Node
	Index     int
}

type ConfigMap

type ConfigMap struct {
	Root *yaml.Node
}

This type implements a low-level get/set config that is backed by an in-memory tree of Yaml nodes. It allows us to interact with a yaml-based config programmatically, preserving any comments that were present when the yaml was parsed.

func (*ConfigMap) Empty

func (cm *ConfigMap) Empty() bool

func (*ConfigMap) FindEntry

func (cm *ConfigMap) FindEntry(key string) (ce *ConfigEntry, err error)

func (*ConfigMap) GetStringValue

func (cm *ConfigMap) GetStringValue(key string) (string, error)

func (*ConfigMap) RemoveEntry

func (cm *ConfigMap) RemoveEntry(key string)

func (*ConfigMap) SetStringValue

func (cm *ConfigMap) SetStringValue(key, value string) error

type HostConfig

type HostConfig struct {
	ConfigMap
	Host string
}

type NotFoundError

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