Skip to main content
Version: Next

models: the configuration model

The github.com/yohimik/dispat/pkg/models package holds the typed structs that a dispat.json, dispat.yaml, or dispat.toml file decodes into. You can use it to write generators, migration scripts, and test suites. It lets you author configurations as typed Go values and marshal them to loadable files, so you avoid assembling config text by hand.

go get github.com/yohimik/dispat/pkg/models

Writing a configuration in Go​

cfg := models.File{
	Scripts: map[string]models.Script{
		"build":   {"npm run build"},         // one command
		"release": {"npm ci", "npm publish"}, // or a sequence, run in order
	},
	Spaces: map[string]models.SpaceConfig{
		"libs": {Path: models.PathList{"packages"}, Flow: &models.SpaceFlowConfig{
			Build: []string{"build"}, Publish: []string{"publish"},
		}},
	},
	Packages: map[string]models.PackageConfig{
		"core": {RevertOnFail: models.Bool(false)},
		"cli":  {Path: "tools/cli", Dependencies: models.Providers("core")},
	},
}
data, _ := json.MarshalIndent(cfg, "", "  ") // a loadable dispat.json

The contract​

Every field carries a mapstructure tag to help the CLI decode the file. They also carry a json tag with the exact same key to handle marshaling. This guarantees that a marshalled model is a loadable configuration, so your generators can round-trip through Go types without needing hand-written templates.

Optional sub-objects are pointers. An unset object marshals as an absent key instead of printing {} noise to your file.

Tri-state options are *bool fields with nil-safe accessors and a Bool() helper. This covers enabled, verify, writeVersion, and every scalar of a package override. For these fields, an absent value means inherit instead of false.

Shapes the config file accepts​

Two keys accept multiple spellings in a config file. dispat expands these spellings here in the models package instead of in the CLI.

Dependency edges always resolve to a flat []DependencyConfig list. The Dependencies and ProviderList fields unmarshal every shorthand the file accepts into that flat list, and they marshal back to the shortest spelling that carries the same meaning. You can use the Providers function to build this list in code exactly how the shorthand works in a file.

A Scripts value is a Script. This represents the commands one name binds, in the order they run. It decodes from either a bare string or an array of strings, and it marshals back as the shorter of the two whenever they mean the same thing.

Two roles for a package entry​

A Packages entry means one of two things, depending on whether you set Path. Without Path, it overrides the space configuration of the package whose folder name matches the key, but with Path, it declares a standalone package outside every space. Both forms appear in the Go example above and are described in Packages.

What is not here​

This module contains models only. Loading, validation, defaulting, and package discovery all live inside the CLI, so an invalid model marshals perfectly well but fails with a clear error when dispat loads it. The Configuration reference documents anything that behaves differently at runtime, describing the file exactly as the CLI reads it.

Further reading​