gen

type Config[ConstraintExtra any] struct {
	// Struct tags to generate
	Tags []string `yaml:"tags"`
	// Disable generating factories for models
	NoFactory bool `yaml:"no_factory"`
	// Disable generating go test files
	NoTests bool `yaml:"no_tests"`
	// Disable back referencing in the loaded relationship structs
	NoBackReferencing bool `yaml:"no_back_referencing"`
	// Decides the casing for go structure tag names. camel, title or snake (default snake)
	StructTagCasing string `yaml:"struct_tag_casing"`
	// Relationship struct tag name
	RelationTag string `yaml:"relation_tag"`
	// List of column names that should have tags values set to '-' (ignored during parsing)
	TagIgnore []string `yaml:"tag_ignore"`

	Types         drivers.Types                `yaml:"types"`         // register custom types
	Aliases       drivers.Aliases              `yaml:"aliases"`       // customize aliases
	Constraints   Constraints[ConstraintExtra] `yaml:"constraints"`   // define additional constraints
	Relationships Relationships                `yaml:"relationships"` // define additional relationships

	Replacements []Replace   `yaml:"replacements"`
	Inflections  Inflections `yaml:"inflections"`

	// Customize the generator name in the top level comment of generated files
	// >>   Code generated by **GENERATOR NAME**. DO NOT EDIT.
	// defaults to "BobGen [driver] [version]"
	Generator string `yaml:"generator"`
}

type Constraints[C any] map[string]drivers.Constraints[C]

type DBInfoPlugin[T, C, I any] interface {
	Plugin
	PlugDBInfo(*drivers.DBInfo[T, C, I]) error
}

type Inflections struct {
	Plural        map[string]string `yaml:"plural"`
	PluralExact   map[string]string `yaml:"plural_exact"`
	Singular      map[string]string `yaml:"singular"`
	SingularExact map[string]string `yaml:"singular_exact"`
	Irregular     map[string]string `yaml:"irregular"`
}

type Output struct {
	// The key has to be unique in a gen.State
	// it also makes it possible to target modifing a specific output
	// There are special keys that are reserved for internal use
	// * "models" - for model templates.
	// * "factory" - for factory templates
	// * "queries" - for query templates.
	//    - This is run once for each query folder
	//    - The PkgName is set to the folder name in each run
	//    - The OutFolder is set to the same folder
	Key string

	PkgName                 string
	OutFolder               string
	Templates               []fs.FS
	SeparatePackageForTests bool
	// contains filtered or unexported fields
}

type Plugin interface {
	Name() string
}

type Relationships map[string][]orm.Relationship

type Replace struct {
	Tables  []string       `yaml:"tables"`
	Match   drivers.Column `yaml:"match"`
	Replace string         `yaml:"replace"`
}

type State[ConstraintExtra any] struct {
	Config              Config[ConstraintExtra]
	Outputs             []*Output
	CustomTemplateFuncs template.FuncMap
}

type StatePlugin[ConstraintExtra any] interface {
	Plugin
	PlugState(*State[ConstraintExtra]) error
}

type TemplateData[T, C, I any] struct {
	Dialect  string
	Importer language.Importer

	Table         drivers.Table[C, I]
	Tables        drivers.Tables[C, I]
	QueryFile     drivers.QueryFile
	QueryFolder   drivers.QueryFolder
	QueryFolders  []drivers.QueryFolder
	Enums         []drivers.Enum
	Aliases       drivers.Aliases
	Types         drivers.Types
	Relationships Relationships

	// Controls what names are output
	PkgName string

	// Control various generation features
	AddSoftDeletes    bool
	AddEnumTypes      bool
	EnumNullPrefix    string
	NoFactory         bool
	NoTests           bool
	NoBackReferencing bool

	// Tags control which tags are added to the struct
	Tags []string
	// RelationTag controls the value of the tags for the Relationship struct
	RelationTag string
	// Generate struct tags as camelCase or snake_case
	StructTagCasing string
	// Contains field names that should have tags values set to '-'
	TagIgnore map[string]struct{}

	// Supplied by the driver
	ExtraInfo T

	// Package information
	CurrentPackage string            // the current package being generated
	OutputPackages map[string]string // map of output keys to package paths

	// Driver is the module name of the underlying `database/sql` driver
	Driver   string
	Language language.Language
}

type TemplateDataPlugin[T, C, I any] interface {
	Plugin
	PlugTemplateData(*TemplateData[T, C, I]) error
}