config

package

v0.0.4 Latest Latest Go to latest Published: Feb 7, 2023 License: MIT Imports: 5 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/corani/adr

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func ProjectRoot() (string, error)
func SetVersion(v, c, d, b string)
func WriteConfig(root string, config *Config) error
type Config
- func ReadConfig() (*Config, error)
type Version
- func GetVersion() Version

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrConfig = errors.New("config")

Functions ¶

func ProjectRoot ¶

func ProjectRoot() (string, error)

func SetVersion ¶ added in v0.0.2

func SetVersion(v, c, d, b string)

func WriteConfig ¶

func WriteConfig(root string, config *Config) error

Types ¶

type Config ¶

type Config struct {
	Project       string `yaml:"-"`
	Root          string `yaml:"root"`
	AdrTemplate   string `yaml:"adrTemplate"`
	IndexTemplate string `yaml:"indexTemplate"`
}

func ReadConfig ¶

func ReadConfig() (*Config, error)

type Version ¶ added in v0.0.2

type Version struct {
	Version string
	Commit  string
	BuiltAt string
	BuiltBy string
}

func GetVersion ¶ added in v0.0.2

func GetVersion() Version

Source Files ¶

View all Source files

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