config

package

v0.0.0-...-873fb03 Latest Latest Go to latest Published: Jul 8, 2022 License: Apache-2.0 Imports: 7 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

Repository

github.com/ZupIT/ritchie-cli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Configs
type Manager
- func NewManager(ritHome string) Manager
- func (m Manager) Read() (Configs, error)
- func (m Manager) Write(configs Configs) error
type Reader
type Writer

Constants ¶

View Source

const (
	File            = "configs.toml"
	DefaultLang     = "English"
	DefaultTutorial = "enabled"
	DefaultMetrics  = "yes"
	DefaultRunType  = formula.DockerRun
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Configs ¶

type Configs struct {
	Language string             `toml:"language"`
	Tutorial string             `toml:"tutorial"`
	Metrics  string             `toml:"metrics"`
	RunType  formula.RunnerType `toml:"runType"`
}

type Manager ¶

type Manager struct {
	ConfigsPath string
}

func NewManager ¶

func NewManager(ritHome string) Manager

func (Manager) Read ¶

func (m Manager) Read() (Configs, error)

Read reads the Configs file inside the .rit home dir If configs.toml does not exist it's return a default value and error == nil:

Configs{
		Language: DefaultLang,
		Tutorial: DefaultTutorial,
		Metrics:  DefaultMetrics,
		RunType:  DefaultRunType,
	}

in case of an error decoding the error != nil

func (Manager) Write ¶

func (m Manager) Write(configs Configs) error

Write creates or update the ritchie configuration. Case success the error == nil

type Reader ¶

type Reader interface {
	Read() (Configs, error)
}

type Writer ¶

type Writer interface {
	Write(configs Configs) error
}

Source Files ¶

View all Source files

config.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL