registry

type EnvVar struct {
	Key      string
	Example  string
	Comment  string
	Required bool
}

type Module struct {
	Name     string   // section name in platformgo.yaml
	Requires []string // modules it cannot work without
	Import   string   // import path of the module package
	Package  string   // package name in code
	Field    string   // field name in the project's Config struct
	Env      []EnvVar

	// ProjectPkg is a package generated inside the project that the module needs at
	// startup, given relative to the project module path. Empty for modules that need
	// nothing from the project.
	ProjectPkg   string
	ProjectAlias string   // name of that import in generated code
	ExtraArgs    []string // arguments passed to New after the settings

	// Compose is the local development service of the module in docker-compose.yml,
	// indented as an entry under services. Volumes lists the named volumes it uses.
	Compose string
	Volumes []string

	Tools []Tool

	Options []Option // what the module section of platformgo.yaml may contain
}

type Option struct {
	Name        string
	Description string
	Default     string
}

type Tool struct {
	Module  string // module path, "github.com/sqlc-dev/sqlc"
	Package string // what go tool runs, "github.com/sqlc-dev/sqlc/cmd/sqlc"
	Version string
}