config

Documentation

Index

• Constants
• Variables
• type Config
  • func NewConfig(version string) (*Config, error)
• type ContextKey

Constants

const CLIName = "atlas"

CLIName is the name of the project.

Variables

var ErrContextConfigValueIsNotConfigType = errors.New(
	"context config value cannot be cast to config type",
)

Types

type Config

type Config struct {
	Path    string `validate:"required,dir"`
	Version string
}

Config stores configuration required by the CLI.

func NewConfig

func NewConfig(version string) (*Config, error)

NewConfig creates a new Config type.

type ContextKey

type ContextKey string

ContextKey is a dedicated type for accessing context values via a key, to avoid collisions. https://www.calhoun.io/pitfalls-of-context-values-and-how-to-avoid-or-mitigate-them

const ContextConfigKey ContextKey = "atlas.config"

ContextConfigKey is the key used to store the Config in a context.Context.