config

Documentation

Overview

Package for configuration common to command line tool and web app.

Index

• type AppConfig
  • func InitConfig() AppConfig
  • func (c AppConfig) AvoidSubDomains() map[string]bool
  • func (c AppConfig) CorpusDataDir() string
  • func (c AppConfig) CorpusDir() string
  • func (c AppConfig) DictionaryDir() string
  • func (c AppConfig) GetVar(key string) string

Types

type AppConfig

type AppConfig struct {

	// The top level directory for the project
	ProjectHome string

	// A map of project configuration variables
	ConfigVars map[string]string

	// A list of files to read the lexical units in the dictionary from
	LUFileNames []string
}

AppConfig holds application configuration data that is general to the API

These variables are common to API and web app usage, especially loading dictionary files.

func InitConfig

func InitConfig() AppConfig

InitConfig sets application configuration data

func (AppConfig) AvoidSubDomains

func (c AppConfig) AvoidSubDomains() map[string]bool

Default: empty

func (AppConfig) CorpusDataDir

func (c AppConfig) CorpusDataDir() string

CorpusDataDir returns the directory where the corpus metadata is stored

func (AppConfig) CorpusDir

func (c AppConfig) CorpusDir() string

CorpusDir gets the directory where the raw corpus text files are read from

func (AppConfig) DictionaryDir

func (c AppConfig) DictionaryDir() string

DictionaryDir gets the name of the directory containing the dictionary files

func (AppConfig) GetVar

func (c AppConfig) GetVar(key string) string

GetVar gets a configuration variable value