environment

Documentation

Index

• Constants
• Variables
• type EnvSettings
  • func (s *EnvSettings) AddFlags(fs *pflag.FlagSet)
  • func (s *EnvSettings) Init(fs *pflag.FlagSet)

Constants

const (
	//DockumentHomeEnvVar location of Dockument configuration file
	DockumentHomeEnvVar = "DOCKUMENT_HOME"
)

Variables

var DefaultDockumentHome = filepath.Join(homedir.HomeDir(), ".dockument")

DefaultDockumentHome is the default DOCKUMENT_HOME.

var DefaultOutPath, _ = os.Getwd()

DefaultOutPath is the default value for

var EnvMap = map[string]string{
	"home": "DOCKUMENT_PATH",
}

EnvMap maps flag names to envvars

Types

type EnvSettings

type EnvSettings struct {
	// Home is the local path to the dockument home directory.
	Home    path.Home
	Outpath string
}

EnvSettings are the global environment settings

func (*EnvSettings) AddFlags

func (s *EnvSettings) AddFlags(fs *pflag.FlagSet)

AddFlags binds flags to the given flagset.

func (*EnvSettings) Init

func (s *EnvSettings) Init(fs *pflag.FlagSet)

Init sets values from the environment.