config

Documentation

Overview

Package config provides facilities for manipulating kraftkit configuration files on the local filesystem.

Index

• type Config
  • func NewTempConfig() *Config
  • func (c *Config) Path() string
  • func (c *Config) Read(yamlPath ...string) *yaml.RNode
  • func (c *Config) Write(filters ...yaml.Filter)

Types

type Config

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

Config is a YAML-serializable kraftkit configuration. It provides facilities for reading and writing individual configuration attributes from/to a file.

This type is purposely decoupled from kraftkit's internal configuration facilities to allow testing the CLI from an outside perspective, independently from kraftkit's internal implementation.

func NewTempConfig

func NewTempConfig() *Config

NewTempConfig creates a temporary kraftkit configuration file on the local filesystem, pre-populated with a "paths" configuration section referencing temporary directories.

A ginkgo cleanup node is automatically created to handle the removal of the (temporary) parent directory of this configuration file.

func (*Config) Path

func (c *Config) Path() string

Path returns the path to the kraftkit configuration.

func (*Config) Read

func (c *Config) Read(yamlPath ...string) *yaml.RNode

Read returns the YAML node at the given YAML path from the configuration.

func (*Config) Write

func (c *Config) Write(filters ...yaml.Filter)

Write writes configuration changes by executing the given YAML filters.