configurator

package

v0.13.0 Latest Latest Go to latest Published: Jan 21, 2024 License: MIT Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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

This section is empty.

View Source

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

ErrConfigIsDir indicates that the config file is a directory.

This section is empty.

type Option func(c *PromptConfigurator)

Option configures Configurator.

func WithFileSystem(fs afero.Fs) Option

WithFileSystem sets filesystem for PromptConfigurator.

func WithStdio(stdio terminal.Stdio) Option

WithStdio configures stdio for prompt.

func WithStdioProvider(p cobra.StdioProvider) Option

WithStdioProvider configures stdio for prompt.

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

PromptConfigurator manages service.Config.

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

New creates a new Configurator.

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

Clean cleans old obsolete from storage.

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

Configurator provides Configurator.

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

Configure runs the configuration prompt.

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

Read reads configuration from config file.

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 (c *PromptConfigurator) Write(cfg service.Config) error

Write writes configuration to config file and external storage.