refactor(config): Make some struct and field names less confusing (#2922)

Author: andrewmbenton

internal/config/config.go

@@ -55,12 +55,12 @@ const (
 )
 
 type Config struct {
-	Version string   `json:"version" yaml:"version"`
-	Cloud   Cloud    `json:"cloud" yaml:"cloud"`
-	SQL     []SQL    `json:"sql" yaml:"sql"`
-	Gen     Gen      `json:"overrides,omitempty" yaml:"overrides"`
-	Plugins []Plugin `json:"plugins" yaml:"plugins"`
-	Rules   []Rule   `json:"rules" yaml:"rules"`
+	Version   string    `json:"version" yaml:"version"`
+	Cloud     Cloud     `json:"cloud" yaml:"cloud"`
+	SQL       []SQL     `json:"sql" yaml:"sql"`
+	Overrides Overrides `json:"overrides,omitempty" yaml:"overrides"`
+	Plugins   []Plugin  `json:"plugins" yaml:"plugins"`
+	Rules     []Rule    `json:"rules" yaml:"rules"`
 }
 
 type Database struct {
@@ -93,11 +93,11 @@ type Rule struct {
 	Msg  string `json:"message" yaml:"message"`
 }
 
-type Gen struct {
-	Go *GenGo `json:"go,omitempty" yaml:"go"`
+type Overrides struct {
+	Go *GoOverrides `json:"go,omitempty" yaml:"go"`
 }
 
-type GenGo struct {
+type GoOverrides struct {
 	Overrides []Override        `json:"overrides,omitempty" yaml:"overrides"`
 	Rename    map[string]string `json:"rename,omitempty" yaml:"rename"`
 }
@@ -258,11 +258,11 @@ func Combine(conf Config, pkg SQL) CombinedSettings {
 		Package: pkg,
 		Rename:  map[string]string{},
 	}
-	if conf.Gen.Go != nil {
-		for k, v := range conf.Gen.Go.Rename {
+	if conf.Overrides.Go != nil {
+		for k, v := range conf.Overrides.Go.Rename {
 			cs.Rename[k] = v
 		}
-		cs.Overrides = append(cs.Overrides, conf.Gen.Go.Overrides...)
+		cs.Overrides = append(cs.Overrides, conf.Overrides.Go.Overrides...)
 	}
 	if pkg.Gen.Go != nil {
 		cs.Go = *pkg.Gen.Go

internal/config/v_one.go

@@ -189,7 +189,7 @@ func (c *V1GenerateSettings) Translate() Config {
 	}
 
 	if len(c.Overrides) > 0 || len(c.Rename) > 0 {
-		conf.Gen.Go = &GenGo{
+		conf.Overrides.Go = &GoOverrides{
 			Overrides: c.Overrides,
 			Rename:    c.Rename,
 		}

internal/config/v_two.go

@@ -27,9 +27,9 @@ func v2ParseConfig(rd io.Reader) (Config, error) {
 	if err := conf.validateGlobalOverrides(); err != nil {
 		return conf, err
 	}
-	if conf.Gen.Go != nil {
-		for i := range conf.Gen.Go.Overrides {
-			if err := conf.Gen.Go.Overrides[i].Parse(); err != nil {
+	if conf.Overrides.Go != nil {
+		for i := range conf.Overrides.Go.Overrides {
+			if err := conf.Overrides.Go.Overrides[i].Parse(); err != nil {
 				return conf, err
 			}
 		}
@@ -125,11 +125,11 @@ func (c *Config) validateGlobalOverrides() error {
 			engines[pkg.Engine] = struct{}{}
 		}
 	}
-	if c.Gen.Go == nil {
+	if c.Overrides.Go == nil {
 		return nil
 	}
 	usesMultipleEngines := len(engines) > 1
-	for _, oride := range c.Gen.Go.Overrides {
+	for _, oride := range c.Overrides.Go.Overrides {
 		if usesMultipleEngines && oride.Engine == "" {
 			return fmt.Errorf(`the "engine" field is required for global type overrides because your configuration uses multiple database engines`)
 		}