project

type Config struct {
	// Module is the Go module path. Read from go.mod when absent.
	Module string `json:"module,omitempty"`
	// Dialect is the default SQL dialect for migrations.
	Dialect string `json:"dialect,omitempty"`

	// EnvVariable and MigrationPath are the single-database form.
	EnvVariable   string `json:"env_variable,omitempty"`
	MigrationPath string `json:"migration_path,omitempty"`

	// Databases are the migration targets, keyed by the name passed to -db.
	Databases map[string]Database `json:"databases,omitempty"`

	Layout   Layout   `json:"layout,omitempty"`
	Generate Generate `json:"generate,omitempty"`
	// Rules overrides a lint rule's severity: "error", "warn" or "off".
	Rules map[string]string `json:"rules,omitempty"`
	// Skip are path fragments the linter ignores.
	Skip []string `json:"skip,omitempty"`

	// Root is the directory the file was found in. Not serialised.
	Root string `json:"-"`
	// Found reports whether a file was actually read, as opposed to
	// defaults being returned.
	Found bool `json:"-"`
	// contains filtered or unexported fields
}

type Database struct {
	// EnvVariable names the environment variable holding the DSN. The DSN
	// itself is never stored in the file: a connection string holds a
	// password, and the repository is the wrong place for one.
	EnvVariable string `json:"env_variable"`
	// MigrationPath is the directory of .up.sql / .down.sql files, relative
	// to the repository root.
	MigrationPath string `json:"migration_path"`
	// Dialect overrides the top-level one for this target. A repository with
	// a Postgres primary and a SQLite cache, or two engines mid-migration,
	// sets it here.
	Dialect string `json:"dialect,omitempty"`
	// LedgerTable overrides the name of the applied-migrations table, for a
	// database that already has a schema_migrations belonging to something
	// else.
	LedgerTable string `json:"ledger_table,omitempty"`
	// NoLock skips the advisory lock. Setting it means two concurrent
	// deploys can both apply the same migration; only do it where the lock
	// genuinely cannot work.
	NoLock bool `json:"no_lock,omitempty"`
}

type Generate struct {
	// Repository emits a repository layer. Turn it off for a service whose
	// modules talk to something other than a database.
	Repository *bool `json:"repository,omitempty"`
	// Tests emits a test file per module.
	Tests *bool `json:"tests,omitempty"`
	// Constants emits a constants package.
	Constants *bool `json:"constants,omitempty"`
}

type Layout struct {
	// Apps is where the domains live. Default "apps".
	Apps string `json:"apps,omitempty"`
	// Tests selects where generated tests go and where the linter expects
	// them: "colocated" (beside the code, the Go default) or "mirror" (under
	// TestsDir, mirroring the package path).
	Tests string `json:"tests,omitempty"`
	// TestsDir is the root for mirrored tests. Default "tests".
	TestsDir string `json:"tests_dir,omitempty"`
	// ModuleFile is the name of a module's declaration file. {module} is
	// replaced with the module's package name. Default "{module}_module.go".
	ModuleFile string `json:"module_file,omitempty"`
	// AppFile is the name of a domain's aggregator. {app} is replaced.
	// Default "{app}_app.go".
	AppFile string `json:"app_file,omitempty"`
	// Layers maps each logical layer to the directory names that count as
	// it. A repository that calls its data layer "store" adds that here and
	// the layering rules start applying to it.
	Layers map[string][]string `json:"layers,omitempty"`
}

type Target struct {
	Name string
	// EnvVariable holds the DSN. Never the DSN itself.
	EnvVariable string
	// MigrationPath is absolute, resolved against the repository root.
	MigrationPath string
	Dialect       string
	LedgerTable   string
	NoLock        bool
}