loader

type ConfigContainer interface {

	// PromptUserForConfig is triggered when the config section
	// is not valid or it is not possible to unmarshal it.
	PromptUserForConfig() error
}

type ConfigSpec interface {

	// ConfigKey returns the globally unique string representing this config spec.
	ConfigKey() string

	// GlobalConfig returns the spec for the global configuration file.
	// The global config is always handled before the local one,
	// so the local spec can access data from the global one without any worries.
	GlobalConfig() ConfigContainer

	// LocalConfig returns the spec for the local configuration file.
	LocalConfig() ConfigContainer
}

type Marshaller interface {
	Marshal() (interface{}, error)
}

type Module interface {

	// Id returns the string globally identifying the module.
	// Module authors are advised to use a reversed URL as seen in Java world,
	// e.g. com.example.codereview.servicename
	Id() string

	// Kind returns the kind of this module.
	Kind() ModuleKind

	// ConfigSpec returns the configuration specification
	// to be used when bootstrapping the module.
	ConfigSpec() ModuleConfigSpec
}

type ModuleConfigSpec interface {
	ConfigSpec

	// ModuleKind returns the module kind for the associated module.
	ModuleKind() ModuleKind
}

type ModuleDialogSection struct {
	AvailableModules []Module
	Optional         bool
}

type ModuleKind string

type Unmarshaller interface {

	// Unmarshal is passed a function that is to be used to fill
	// an object with the data from the associated config section.
	Unmarshal(unmarshal func(interface{}) error) error
}

type Validator interface {
	Validate(sectionPath string) error
}