configmigrate: imp naming

Author: EugeneOne1

internal/configmigrate/migrator.go

@@ -61,7 +61,7 @@ func (m *Migrator) Run(ctx context.Context, target SchemaVersion) (err error) {
 	confPath := filepath.Join(m.workingDir, m.configName)
 	logger := m.logger.With("config_path", confPath)
 
-	conf, err := readYobj(confPath)
+	conf, err := readYAML(confPath)
 	if err != nil {
 		if errors.Is(err, fs.ErrNotExist) {
 			logger.DebugContext(ctx, "configuration file does not exist")
@@ -96,7 +96,7 @@ func (m *Migrator) Run(ctx context.Context, target SchemaVersion) (err error) {
 }
 
 // getVersion returns the schema version from the configuration object.
-func (m *Migrator) getVersion(conf yobj) (v SchemaVersion, err error) {
+func (m *Migrator) getVersion(conf yObj) (v SchemaVersion, err error) {
 	verInt, err := fieldVal[int](conf, SchemaVersionKey)
 	if err != nil {
 		return 0, err
@@ -112,11 +112,11 @@ func (m *Migrator) getVersion(conf yobj) (v SchemaVersion, err error) {
 }
 
 // migrateFunc is a function that upgrades conf or returns an error.
-type migrateFunc = func(ctx context.Context, conf yobj) (err error)
+type migrateFunc = func(ctx context.Context, conf yObj) (err error)
 
 // migrate performs migrations from current schema version to the target one.
 // It returns an error from the first failed migration.
-func (m *Migrator) migrate(ctx context.Context, conf yobj, curr, targ SchemaVersion) (err error) {
+func (m *Migrator) migrate(ctx context.Context, conf yObj, curr, targ SchemaVersion) (err error) {
 	migrations := [VersionLatest]migrateFunc{
 		// There is obviously no migration to the initial version.
 		0: nil,
@@ -186,7 +186,7 @@ func (m *Migrator) backupConfig(
 func (m *Migrator) writeMigrated(
 	ctx context.Context,
 	l *slog.Logger,
-	conf yobj,
+	conf yObj,
 	origPath string,
 	curr SchemaVersion,
 	targ SchemaVersion,

internal/configmigrate/v2.go

@@ -33,16 +33,16 @@ import (
 //	    # …
 //	# …
 //	schema_version: 2
-func (m *Migrator) migrateTo2(ctx context.Context, conf yobj) (err error) {
+func (m *Migrator) migrateTo2(ctx context.Context, conf yObj) (err error) {
 	const target SchemaVersion = 2
 
-	dnsVal, err := fieldVal[yobj](conf, "dns")
+	dnsVal, err := fieldVal[yObj](conf, "dns")
 	if err != nil {
 		// Don't wrap the error since it's informative enough as is.
 		return err
 	}
 
-	serverVal, err := fieldVal[yobj](dnsVal, "server")
+	serverVal, err := fieldVal[yObj](dnsVal, "server")
 	if err != nil {
 		// Don't wrap the error since it's informative enough as is.
 		return err
@@ -56,7 +56,7 @@ func (m *Migrator) migrateTo2(ctx context.Context, conf yobj) (err error) {
 		return fmt.Errorf("%s: %w", key, errors.ErrNotEmpty)
 	}
 
-	serverVal[key] = yobj{
+	serverVal[key] = yObj{
 		"enabled":  true,
 		"interval": timeutil.Duration(1 * time.Second),
 		"count":    4,

internal/configmigrate/yaml.go

@@ -9,12 +9,12 @@ import (
 	"gopkg.in/yaml.v3"
 )
 
-// yobj is the convenience alias for YAML key-value object.
-type yobj = map[string]any
+// yObj is the convenience alias for YAML key-value object.
+type yObj = map[string]any
 
 // fieldVal returns the value of type T for key from obj.  It returns errors if
 // the key is not found, the value is not set, or the value is not of type T.
-func fieldVal[T any](obj yobj, key string) (v T, err error) {
+func fieldVal[T any](obj yObj, key string) (v T, err error) {
 	val, ok := obj[key]
 	if !ok {
 		return v, fmt.Errorf("%s: %w", key, errors.ErrNoValue)
@@ -32,9 +32,9 @@ func fieldVal[T any](obj yobj, key string) (v T, err error) {
 	return v, nil
 }
 
-// readYobj reads the YAML file from filePath and returns the parsed YAML
+// readYAML reads the YAML file from filePath and returns the parsed YAML
 // object.
-func readYobj(filePath string) (obj yobj, err error) {
+func readYAML(filePath string) (obj yObj, err error) {
 	// #nosec G304 -- Trust the file path since it's constant now.
 	f, err := os.Open(filePath)
 	if err != nil {