config

Documentation

Index

• type Config
  • func New(path string) (*Config, error)
  • func (c *Config) IsAuthenticated() bool
  • func (c *Config) Update(key, host, dir, xapi string) error
  • func (c *Config) Write() error

Types

type Config

type Config struct {
	APIKey string `json:"apiKey"`
	Dir    string `json:"dir"`
	API    string `json:"api"`
	XAPI   string `json:"xapi"`
	File   string `json:"-"` // full path to config file
}

Config represents the settings for particular user. This defines both the auth for talking to the API, as well as where to put problems that get downloaded.

func New

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

New returns a configuration struct with content from the exercism.json file

func (*Config) IsAuthenticated

func (c *Config) IsAuthenticated() bool

IsAuthenticated returns true if the config contains an API key. This does not check whether or not that key is valid.

func (*Config) Update

func (c *Config) Update(key, host, dir, xapi string) error

Update sets new values where given.

func (*Config) Write

func (c *Config) Write() error

Write saves the config as JSON.