config

type AdditionalComment struct {
	Table          string            `yaml:"table"`
	TableComment   string            `yaml:"tableComment"`
	ColumnComments map[string]string `yaml:"columnComments"`
}

type AdditionalRelation struct {
	Table         string   `yaml:"table"`
	Columns       []string `yaml:"columns"`
	ParentTable   string   `yaml:"parentTable"`
	ParentColumns []string `yaml:"parentColumns"`
	Def           string   `yaml:"def"`
}

type ColumnCount struct {
	Enabled bool     `yaml:"enabled"`
	Max     int      `yaml:"max"`
	Exclude []string `yaml:"exclude"`
}

type Config struct {
	Name        string               `yaml:"name"`
	DSN         string               `yaml:"dsn"`
	DocPath     string               `yaml:"docPath"`
	Format      Format               `yaml:"format"`
	ER          ER                   `yaml:"er"`
	Include     []string             `yaml:"include"`
	Exclude     []string             `yaml:"exclude"`
	Lint        Lint                 `yaml:"lint"`
	LintExclude []string             `yaml:"lintExclude"`
	Relations   []AdditionalRelation `yaml:"relations"`
	Comments    []AdditionalComment  `yaml:"comments"`
	Dict        dict.Dict            `yaml:"dict"`
	MergedDict  dict.Dict            `yaml:"-"`
}

type DuplicateRelations struct {
	Enabled bool `yaml:"enabled"`
}

type ER struct {
	Skip     bool   `yaml:"skip"`
	Format   string `yaml:"format"`
	Comment  bool   `yaml:"comment"`
	Distance *int   `yaml:"distance"`
}

type Format struct {
	Adjust bool `yaml:"adjust"`
	Sort   bool `yaml:"sort"`
}

type Lint struct {
	RequireTableComment    RequireTableComment    `yaml:"requireTableComment"`
	RequireColumnComment   RequireColumnComment   `yaml:"requireColumnComment"`
	UnrelatedTable         UnrelatedTable         `yaml:"unrelatedTable"`
	ColumnCount            ColumnCount            `yaml:"columnCount"`
	RequireColumns         RequireColumns         `yaml:"requireColumns"`
	DuplicateRelations     DuplicateRelations     `yaml:"duplicateRelations"`
	RequireForeignKeyIndex RequireForeignKeyIndex `yaml:"requireForeignKeyIndex"`
}

type Option func(*Config) error

type RequireColumnComment struct {
	Enabled        bool     `yaml:"enabled"`
	Exclude        []string `yaml:"exclude"`
	ExcludedTables []string `yaml:"excludedTables"`
}

type RequireColumns struct {
	Enabled bool                   `yaml:"enabled"`
	Columns []RequireColumnsColumn `yaml:"columns"`
}

type RequireColumnsColumn struct {
	Name    string   `yaml:"name"`
	Exclude []string `yaml:"exclude"`
}

type RequireForeignKeyIndex struct {
	Enabled bool     `yaml:"enabled"`
	Exclude []string `yaml:"exclude"`
}

type RequireTableComment struct {
	Enabled bool     `yaml:"enabled"`
	Exclude []string `yaml:"exclude"`
}

type Rule interface {
	IsEnabled() bool
	Check(schema *schema.Schema, exclude []string) []RuleWarn
}

type RuleWarn struct {
	Target  string
	Message string
}

type UnrelatedTable struct {
	Enabled bool     `yaml:"enabled"`
	Exclude []string `yaml:"exclude"`
}