config

Documentation

Index

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

Constants

const (
	// File is the default name of the JSON file where the config written.
	// The user can pass an alternate filename when using the CLI.
	File = ".exercism.json"
	// LegacyFile is the name of the original config file.
	// It is a misnomer, since the config was in json, not go.
	LegacyFile = ".exercism.go"

	// DirExercises is the default name of the directory for active users.
	// Make this non-exported when handlers.Login is deleted.
	DirExercises = "exercism"
)

Functions

func Home

func Home() (string, error)

Home returns the user's canonical home directory. See: http://stackoverflow.com/questions/7922270/obtain-users-home-directory we can't cross compile using cgo and use user.Current()

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
	// contains filtered or unexported fields
}

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) SetDir

func (c *Config) SetDir(path string) error

SetDir sets the configuration directory to the given path or defaults to the home exercism directory

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.