config

Documentation

Overview

Package config handles the user configations.

Index

• Constants
• Variables
• func Alert(w io.Writer, list ...string) error
• func CmdPath() string
• func ConfigMissing(w io.Writer, name, suffix string)
• func Create(w io.Writer, name string, ow bool) error
• func CtrlC(w io.Writer)
• func Delete(w io.Writer, ask bool) error
• func DoesExist(w io.Writer, name, suffix string) error
• func Edit(w io.Writer) error
• func Enabled() map[string]interface{}
• func Info(w io.Writer, style string) error
• func InitDefaults()
• func List(w io.Writer) error
• func Load(w io.Writer, flag string) error
• func Location() string
• func Logo(w io.Writer) error
• func Missing() []string
• func New(w io.Writer, overwrite bool) error
• func Path() string
• func Save(w io.Writer, name string) error
• func Set(w io.Writer, name string) error
• func Setup(w io.Writer, start int) error
• func SortKeys() []string
• func Tip() get.Hints
• func Update(w io.Writer, name string, setup bool) error
• type Formats
  • func Format() Formats

Constants

const (
	ClearScreen = "\033c"
	ResetScreen = "\033[0m"
)

const NameFile = "config.yaml"

Variables

var (
	ErrEditorNil = errors.New("no suitable text editor can be found")
	ErrEditorRun = errors.New("editor cannot be run")
	ErrLogo      = errors.New("program logo is missing")
)

var (
	ErrConfigName = errors.New("viper config file cannot be empty")
	ErrWriter     = errors.New("writer cannot be nil")
)

var ErrEd = errors.New("there is no configuration file to edit")

var ErrExist = errors.New("a config file already exists")

var ErrStart = errors.New("setup start argument is out of range")

Functions

func Alert

func Alert(w io.Writer, list ...string) error

Alert returns writes list of missing settings in the config file.

func CmdPath

func CmdPath() string

func ConfigMissing

func ConfigMissing(w io.Writer, name, suffix string)

ConfigMissing writes an config file error notice.

func Create

func Create(w io.Writer, name string, ow bool) error

Create a named configuration file with an option to overwrite an existing file.

func CtrlC

func CtrlC(w io.Writer)

CtrlC intercepts Ctrl-C key combinations to exit out of the Setup.

func Delete

func Delete(w io.Writer, ask bool) error

Delete a configuration file.

func DoesExist

func DoesExist(w io.Writer, name, suffix string) error

DoesExist writes a how-to help message when a config file already exists.

func Edit

func Edit(w io.Writer) error

Edit a configuration file.

func Enabled

func Enabled() map[string]interface{}

Enabled returns all the Viper keys holding a value that are used. This will hide all unrecognized manual edits to the configuration file.

func Info

func Info(w io.Writer, style string) error

Info prints the content of a configuration file.

func InitDefaults

func InitDefaults()

InitDefaults initializes flag and configuration defaults.

func List

func List(w io.Writer) error

List and write all the available configurations.

func Load

func Load(w io.Writer, flag string) error

Load and reads a configuration file. The string argument should be the value of the hidden config flag.

func Location

func Location() string

Location returns the absolute path of the current configuration file and the status of any missing settings.

func Logo

func Logo(w io.Writer) error

Logo writes a custom 256-color, ANSI logo for RetroTxt.

func Missing

func Missing() []string

Missing returns the settings that are not found in the configuration file. This could be due to new features being added after the file was generated or because of manual file edits.

func New

func New(w io.Writer, overwrite bool) error

New creates a new configuration file and writes the results.

func Path

func Path() string

Path returns the absolute path of the configuration file.

func Save

func Save(w io.Writer, name string) error

Save each of viper settings to the named file.

func Set

func Set(w io.Writer, name string) error

Set edits and saves a named setting within a configuration file. It also accepts numeric index values printed by List().

func Setup

func Setup(w io.Writer, start int) error

Setup walks through all the settings and saves them to the configuration file. The start argument can being the walkthrough at the provided question number or it can be left at 0.

func SortKeys

func SortKeys() []string

SortKeys list all the available configuration setting names sorted by hand.

func Tip

func Tip() get.Hints

Tip provides some brief help information of the configurations.

func Update

func Update(w io.Writer, name string, setup bool) error

Update edits and saves the named setting within a configuration file.

Types

type Formats

type Formats struct {
	Info [5]string
}

Formats the choices for command flags.

func Format

func Format() Formats

Format flag choices for the info command.