config

package
v0.5.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 26, 2019 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

View Source
const ColorAuto = "auto"

ColorAuto represents the auto-state for colors

View Source
const ColorOff = "off"

ColorOff represents the off-state for colors

View Source
const ColorOn = "on"

ColorOn represnets the on-state for colors

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config struct {
	Color        string
	LogLevel     string
	Profile      Profile
	ProfilesFile string
}

Config handles all overall configuration for the CLI

func (*Config) EditConfig added in v0.3.0

func (c *Config) EditConfig() error

EditConfig opens the configuration file in the default editor.

func (*Config) GetProfilesFolder

func (c *Config) GetProfilesFolder(xdgPath string) string

GetProfilesFolder retrieves the folder where the profiles file is stored It searches for the xdg environment path first and will secondarily place it in the home directory

func (*Config) InitConfig

func (c *Config) InitConfig()

InitConfig reads in profiles file and ENV variables if set.

func (*Config) PrintConfig added in v0.3.0

func (c *Config) PrintConfig() error

PrintConfig outputs the contents of the configuration file.

type Profile

type Profile struct {
	DeviceName  string
	ProfileName string
	APIKey      string
}

Profile handles all things related to managing the project specific configurations

func (*Profile) CreateProfile

func (p *Profile) CreateProfile() error

CreateProfile creates a profile when logging in

func (*Profile) DeleteConfigField added in v0.3.0

func (p *Profile) DeleteConfigField(field string) error

DeleteConfigField deletes a configuration field.

func (*Profile) GetAPIKey added in v0.3.0

func (p *Profile) GetAPIKey() (string, error)

GetAPIKey will return the existing key for the given profile

func (*Profile) GetColor added in v0.5.2

func (p *Profile) GetColor() (string, error)

GetColor gets the color setting for the user based on the flag or the persisted color stored in the config file

func (*Profile) GetConfigField

func (p *Profile) GetConfigField(field string) string

GetConfigField returns the configuration field for the specific profile

func (*Profile) GetDeviceName

func (p *Profile) GetDeviceName() (string, error)

GetDeviceName returns the configured device name

func (*Profile) RegisterAlias added in v0.3.0

func (p *Profile) RegisterAlias(alias, key string)

RegisterAlias registers an alias for a given key.

func (*Profile) WriteConfigField added in v0.3.0

func (p *Profile) WriteConfigField(field, value string) error

WriteConfigField updates a configuration field and writes the updated configuration to disk.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳