Documentation
¶
Overview ¶
Package gen generates project files from platformgo.yaml.
It produces the module wiring, their settings and the environment example. This is what removes manual edits when modules are added or removed: only the domain part stays in project code.
Index ¶
- Constants
- func Apply(dir string, files map[string][]byte) ([]string, error)
- func Changed(dir string, files map[string][]byte) ([]string, error)
- func Files(dir string, f *spec.File) (map[string][]byte, error)
- func SettingsCode(raw []byte) ([]byte, error)
- func SettingsEnabled(f *spec.File) bool
- func SettingsSchemaPath(f *spec.File) string
- func Wiring(f *spec.File) (map[string][]byte, error)
Constants ¶
const ( ConfigPath = "cmd/app/config.gen.go" ModulesPath = "cmd/app/modules.gen.go" EnvPath = ".env.example" ComposePath = "docker-compose.yml" )
Paths of generated files, relative to the project root.
const SettingsModule = "settings"
SettingsModule is the module name whose schema drives the generation.
const SettingsPath = "internal/settings/settings.gen.go"
SettingsPath is the generated typed access to the business settings. It lives in the project so that domain code reads a setting as a method call rather than a string key.
Variables ¶
This section is empty.
Functions ¶
func Apply ¶
Apply writes the generated files that differ from what the project has and returns their paths. Untouched files keep their modification time, so a build that runs generation first does not rebuild everything.
func Changed ¶
Changed returns the paths whose content in the project differs from the generated one. An empty list means generation is up to date.
func Files ¶
Files returns everything platformgo generates for the project: the module wiring and, when the settings module is enabled, the typed access to the business settings.
The schema is read from the project directory, so the generated code always matches the file a developer just edited.
func SettingsCode ¶
SettingsCode generates the typed access from the schema file contents.
func SettingsEnabled ¶
SettingsEnabled reports whether the project enables the settings module.
func SettingsSchemaPath ¶
SettingsSchemaPath is the schema file of the project: settings.yaml unless the module section names another one.
Types ¶
This section is empty.
Source Files