config

Documentation

Index

• Variables
• func AuthFlow(notice string) (string, string, error)
• func AuthFlowComplete()
• func ConfigDir() string
• func ConfigFile() string
• func IsGitHubApp(id string) bool
• func StubBackupConfig() func()
• func StubConfig(content string) func()
• func StubWriteConfig(w io.Writer) func()
• type Config
  • func NewConfig(root *yaml.Node) Config
  • func ParseConfig(fn string) (Config, error)
  • func ParseDefaultConfig() (Config, error)
  • func ParseOrSetupConfigFile(fn string) (Config, error)
• type ConfigMap
  • func (cm *ConfigMap) FindEntry(key string) (keyNode, valueNode *yaml.Node, err error)
  • func (cm *ConfigMap) GetStringValue(key string) (string, error)
  • func (cm *ConfigMap) SetStringValue(key, value string) error
• type HostConfig
• type NotFoundError

Variables

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

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

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

	return data, nil
}

var WriteConfigFile = func(fn string, data []byte) error {
	cfgFile, err := os.OpenFile(ConfigFile(), 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 AuthFlow

func AuthFlow(notice string) (string, string, error)

func AuthFlowComplete

func AuthFlowComplete()

func ConfigDir

func ConfigDir() string

func ConfigFile

func ConfigFile() string

func IsGitHubApp

func IsGitHubApp(id string) bool

IsGitHubApp reports whether an OAuth app is "GitHub CLI" or "GitHub CLI (dev)"

func StubBackupConfig

func StubBackupConfig() func()

func StubConfig

func StubConfig(content string) func()

func StubWriteConfig

func StubWriteConfig(w io.Writer) func()

Types

type Config

type Config interface {
	Hosts() ([]*HostConfig, error)
	Get(string, string) (string, error)
	Set(string, string, string) error
	Write() error
}

This interface describes interacting with some persistent configuration for gh.

func NewConfig

func NewConfig(root *yaml.Node) Config

func ParseConfig

func ParseConfig(fn string) (Config, error)

func ParseDefaultConfig

func ParseDefaultConfig() (Config, error)

func ParseOrSetupConfigFile

func ParseOrSetupConfigFile(fn string) (Config, error)

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 waas parsed.

func (*ConfigMap) FindEntry

func (cm *ConfigMap) FindEntry(key string) (keyNode, valueNode *yaml.Node, err error)

func (*ConfigMap) GetStringValue

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

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
}