Switch lintersconfig to map[string]any

Author: JoelSpeed

pkg/analysis/registry.go

@@ -197,9 +197,14 @@ func getLinterTypedConfig(ci initializer.ConfigurableAnalyzerInitializer, linter
 		return ci.ConfigType(), nil
 	}
 
+	encodedConfig, err := yaml.Marshal(rawConfig)
+	if err != nil {
+		return nil, fmt.Errorf("error encoding config for linter %q: %w", ci.Name(), err)
+	}
+
 	linterConfig := ci.ConfigType()
 
-	if err := yaml.Unmarshal(rawConfig, linterConfig); err != nil {
+	if err := yaml.Unmarshal(encodedConfig, linterConfig); err != nil {
 		return nil, fmt.Errorf("error reading config for linter %q: %w", ci.Name(), err)
 	}
 
@@ -211,7 +216,7 @@ func getLinterTypedConfig(ci initializer.ConfigurableAnalyzerInitializer, linter
 // It also supports backwards compatibility with early configuration.
 // We use to have camelCased config names, but now it is all lowercase matched on the linter name.
 // TODO(@JoelSpeed): Remove the strings.ToLower in a future release with a release note about the change.
-func getConfigByName(name string, lintersCfg config.LintersConfig) ([]byte, bool) {
+func getConfigByName(name string, lintersCfg config.LintersConfig) (any, bool) {
 	rawConfig, ok := lintersCfg[name]
 	if ok {
 		return rawConfig, true

pkg/analysis/registry_test.go

@@ -18,7 +18,6 @@ package analysis_test
 import (
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
-	"gopkg.in/yaml.v3"
 
 	goanalysis "golang.org/x/tools/go/analysis"
 
@@ -151,113 +150,104 @@ var _ = Describe("Registry", func() {
 			Entry("With a valid JSONTagsConfig JSONTagRegex", validateLintersConfigTableInput{
 				linters: config.Linters{},
 				config: config.LintersConfig{
-					"jsontags": toYaml(jsontags.JSONTagsConfig{
+					"jsontags": jsontags.JSONTagsConfig{
 						JSONTagRegex: "^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*)*$",
-					}),
+					},
 				},
 			}),
 			Entry("With an invalid JSONTagsConfig JSONTagRegex", validateLintersConfigTableInput{
 				config: config.LintersConfig{
-					"jsontags": toYaml(jsontags.JSONTagsConfig{
+					"jsontags": jsontags.JSONTagsConfig{
 						JSONTagRegex: "^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*",
-					}),
+					},
 				},
 				expectedErr: "error validating linters config: lintersConfig.jsontags.jsonTagRegex: Invalid value: \"^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*\": invalid regex: error parsing regexp: missing closing ): `^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*`",
 			}),
 			Entry("With a valid JSONTagsConfig JSONTagRegex (legacy field name)", validateLintersConfigTableInput{
 				linters: config.Linters{},
 				config: config.LintersConfig{
-					"jsonTags": toYaml(jsontags.JSONTagsConfig{
+					"jsonTags": jsontags.JSONTagsConfig{
 						JSONTagRegex: "^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*)*$",
-					}),
+					},
 				},
 			}),
 			Entry("With an invalid JSONTagsConfig JSONTagRegex (legacy field name)", validateLintersConfigTableInput{
 				config: config.LintersConfig{
-					"jsonTags": toYaml(jsontags.JSONTagsConfig{
+					"jsonTags": jsontags.JSONTagsConfig{
 						JSONTagRegex: "^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*",
-					}),
+					},
 				},
 				expectedErr: "error validating linters config: lintersConfig.jsontags.jsonTagRegex: Invalid value: \"^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*\": invalid regex: error parsing regexp: missing closing ): `^[a-z][a-z0-9]*(?:[A-Z][a-z0-9]*`",
 			}),
 
 			Entry("With a valid OptionalOrRequiredConfig (legacy field name)", validateLintersConfigTableInput{
 				config: config.LintersConfig{
-					"optionalorrequired": toYaml(optionalorrequired.OptionalOrRequiredConfig{
+					"optionalorrequired": optionalorrequired.OptionalOrRequiredConfig{
 						PreferredOptionalMarker: markers.OptionalMarker,
 						PreferredRequiredMarker: markers.RequiredMarker,
-					}),
+					},
 				},
 				expectedErr: "",
 			}),
 			Entry("With kubebuilder preferred markers (legacy field name)", validateLintersConfigTableInput{
 				config: config.LintersConfig{
-					"optionalorrequired": toYaml(optionalorrequired.OptionalOrRequiredConfig{
+					"optionalorrequired": optionalorrequired.OptionalOrRequiredConfig{
 						PreferredOptionalMarker: markers.KubebuilderOptionalMarker,
 						PreferredRequiredMarker: markers.KubebuilderRequiredMarker,
-					}),
+					},
 				},
 				expectedErr: "",
 			}),
 			Entry("With invalid preferred optional marker (legacy field name)", validateLintersConfigTableInput{
 				config: config.LintersConfig{
-					"optionalorrequired": toYaml(optionalorrequired.OptionalOrRequiredConfig{
+					"optionalorrequired": optionalorrequired.OptionalOrRequiredConfig{
 						PreferredOptionalMarker: "invalid",
-					}),
+					},
 				},
 				expectedErr: "error validating linters config: lintersConfig.optionalorrequired.preferredOptionalMarker: Invalid value: \"invalid\": invalid value, must be one of \"optional\", \"kubebuilder:validation:Optional\" or omitted",
 			}),
 			Entry("With invalid preferred required marker (legacy field name)", validateLintersConfigTableInput{
 				config: config.LintersConfig{
-					"optionalorrequired": toYaml(optionalorrequired.OptionalOrRequiredConfig{
+					"optionalorrequired": optionalorrequired.OptionalOrRequiredConfig{
 						PreferredRequiredMarker: "invalid",
-					}),
+					},
 				},
 				expectedErr: "error validating linters config: lintersConfig.optionalorrequired.preferredRequiredMarker: Invalid value: \"invalid\": invalid value, must be one of \"required\", \"kubebuilder:validation:Required\" or omitted",
 			}),
 			Entry("With a valid OptionalOrRequiredConfig (legacy field name)", validateLintersConfigTableInput{
 				config: config.LintersConfig{
-					"optionalOrRequired": toYaml(optionalorrequired.OptionalOrRequiredConfig{
+					"optionalOrRequired": optionalorrequired.OptionalOrRequiredConfig{
 						PreferredOptionalMarker: markers.OptionalMarker,
 						PreferredRequiredMarker: markers.RequiredMarker,
-					}),
+					},
 				},
 				expectedErr: "",
 			}),
 			Entry("With kubebuilder preferred markers (legacy field name)", validateLintersConfigTableInput{
 				config: config.LintersConfig{
-					"optionalOrRequired": toYaml(optionalorrequired.OptionalOrRequiredConfig{
+					"optionalOrRequired": optionalorrequired.OptionalOrRequiredConfig{
 						PreferredOptionalMarker: markers.KubebuilderOptionalMarker,
 						PreferredRequiredMarker: markers.KubebuilderRequiredMarker,
-					}),
+					},
 				},
 				expectedErr: "",
 			}),
 			Entry("With invalid preferred optional marker (legacy field name)", validateLintersConfigTableInput{
 				config: config.LintersConfig{
-					"optionalOrRequired": toYaml(optionalorrequired.OptionalOrRequiredConfig{
+					"optionalOrRequired": optionalorrequired.OptionalOrRequiredConfig{
 						PreferredOptionalMarker: "invalid",
-					}),
+					},
 				},
 				expectedErr: "error validating linters config: lintersConfig.optionalorrequired.preferredOptionalMarker: Invalid value: \"invalid\": invalid value, must be one of \"optional\", \"kubebuilder:validation:Optional\" or omitted",
 			}),
 			Entry("With invalid preferred required marker (legacy field name)", validateLintersConfigTableInput{
 				config: config.LintersConfig{
-					"optionalOrRequired": toYaml(optionalorrequired.OptionalOrRequiredConfig{
+					"optionalOrRequired": optionalorrequired.OptionalOrRequiredConfig{
 						PreferredRequiredMarker: "invalid",
-					}),
+					},
 				},
 				expectedErr: "error validating linters config: lintersConfig.optionalorrequired.preferredRequiredMarker: Invalid value: \"invalid\": invalid value, must be one of \"required\", \"kubebuilder:validation:Required\" or omitted",
 			}),
 		)
 	})
 })
-
-func toYaml(v any) []byte {
-	yaml, err := yaml.Marshal(v)
-	if err != nil {
-		panic(err)
-	}
-
-	return yaml
-}

pkg/config/linters_config.go

@@ -16,4 +16,4 @@ limitations under the License.
 package config
 
 // LintersConfig contains configuration for individual linters.
-type LintersConfig map[string][]byte
+type LintersConfig map[string]any