config

Documentation

Overview

Package config provides access to the comply.yml file.

Index

• func Exists() bool
• func ProjectRoot() string
• func SetProjectRoot(dir string)
• func YAML() map[interface{}]interface{}
• type Project
  • func Config() Project

Functions

func Exists

func Exists() bool

Exists tests for the presence of a comply configuration file.

func ProjectRoot

func ProjectRoot() string

ProjectRoot is the fully-qualified path to the root directory.

func SetProjectRoot

func SetProjectRoot(dir string)

SetProjectRoot is used by the test suite.

func YAML

func YAML() map[interface{}]interface{}

YAML is the parsed contents of ProjectRoot()/config.yml.

Types

type Project

type Project struct {
	Name       string                 `yaml:"name"`
	FilePrefix string                 `yaml:"filePrefix"`
	Tickets    map[string]interface{} `yaml:"tickets"`
}

func Config

func Config() Project

Config is the parsed contents of ProjectRoot()/config.yml.