configurator

Documentation

Overview

Package configurator provides read / write functionalities to manage application configuration.

Index

• Variables
• type Option
  • func WithFileSystem(fs afero.Fs) Option
  • func WithStdio(stdio terminal.Stdio) Option
  • func WithStdioProvider(p cobra.StdioProvider) Option
• type PromptConfigurator
  • func New(configFile string, options ...Option) *PromptConfigurator
  • func (c *PromptConfigurator) Clean(oldCfg service.Config, newCfg service.Config) error
  • func (c *PromptConfigurator) Configurator() service.Configurator
  • func (c *PromptConfigurator) Configure() (err error)
  • func (c *PromptConfigurator) Read() (service.Config, error)
  • func (c *PromptConfigurator) SafeRead() (service.Config, error)
  • func (c *PromptConfigurator) Write(cfg service.Config) error

Variables

var ErrConfigIsDir = errors.New("config file is a directory")

ErrConfigIsDir indicates that the config file is a directory.

Types

type Option

type Option func(c *PromptConfigurator)

Option configures Configurator.

func WithFileSystem

func WithFileSystem(fs afero.Fs) Option

WithFileSystem sets filesystem for PromptConfigurator.

func WithStdio

func WithStdio(stdio terminal.Stdio) Option

WithStdio configures stdio for prompt.

func WithStdioProvider

func WithStdioProvider(p cobra.StdioProvider) Option

WithStdioProvider configures stdio for prompt.

type PromptConfigurator

type PromptConfigurator struct {
	// contains filtered or unexported fields
}

PromptConfigurator manages service.Config.

func New

func New(configFile string, options ...Option) *PromptConfigurator

New creates a new Configurator.

func (*PromptConfigurator) Clean

func (c *PromptConfigurator) Clean(oldCfg service.Config, newCfg service.Config) error

Clean cleans old obsolete from storage.

func (*PromptConfigurator) Configurator

func (c *PromptConfigurator) Configurator() service.Configurator

Configurator provides Configurator.

func (*PromptConfigurator) Configure

func (c *PromptConfigurator) Configure() (err error)

Configure runs the configuration prompt.

func (*PromptConfigurator) Read

func (c *PromptConfigurator) Read() (service.Config, error)

Read reads configuration from config file.

func (*PromptConfigurator) SafeRead

func (c *PromptConfigurator) SafeRead() (service.Config, error)

SafeRead is the same as Read but does not return error if the config file is missing.

func (*PromptConfigurator) Write

func (c *PromptConfigurator) Write(cfg service.Config) error

Write writes configuration to config file and external storage.