configuration

Documentation

Index

• Constants
• type Application
• type Configuration
  • func Get() *Configuration
  • func Init() (*Configuration, error)
• type Watch

Constants

const (
	// FILE_NAME is the name of the main project file
	FILE_NAME = "anko"
)

Types

type Application

type Application struct {
	RootPath   string `yaml:"root_path"`
	ExecPath   string `yaml:"exec_path"`
	Language   string `yaml:"language"`
	ShowBanner bool   `yaml:"show_banner"`
	Watch      Watch  `yaml:"watch"`
}

Application is responsible to mapping the datails of the root application.

type Configuration

type Configuration struct {
	Application Application `yaml:"application"`
}

Configuration is the main structure of the anko project. All the information contained in anko.yaml is converted using the Configuration structure.

func Get

func Get() *Configuration

Get is the getter of the configurationFile

func Init

func Init() (*Configuration, error)

Init is the basic configuration function, responsible to read and defining the configuration

type Watch

type Watch struct {
	Extensions []string `yaml:"extensions"`
	Files      []string `yaml:"files"`
}

Watch contains all files and extensions to be observed during the application cycle.