chore: configuration v2 cloner

Author: ldez

.golangci.yml

@@ -171,6 +171,11 @@ linters:
         linters: [gosec]
         text: "G306: Expect WriteFile permissions to be 0600 or less"
 
+      # Related to migration command.
+      - path: pkg/commands/internal/migrate/two/
+        linters:
+          - lll
+
 formatters:
   enable:
     - gofmt

Makefile

@@ -60,6 +60,11 @@ fast_check_generated:
 	git checkout -- go.mod go.sum # can differ between go1.16 and go1.17
 	git diff --exit-code # check no changes
 
+# Migration
+
+clone_config:
+	go run ./pkg/commands/internal/migrate/cloner/
+
 # Benchmark
 
 # Benchmark with a local version

pkg/commands/internal/migrate/cloner/cloner.go

@@ -0,0 +1,197 @@
+package main
+
+import (
+	"bytes"
+	"fmt"
+	"go/ast"
+	"go/parser"
+	"go/printer"
+	"go/token"
+	"log"
+	"os"
+	"path/filepath"
+	"reflect"
+	"strings"
+
+	"golang.org/x/tools/imports"
+)
+
+const newPkgName = "two"
+
+const (
+	srcDir = "./pkg/config"
+	dstDir = "./pkg/commands/internal/migrate/two"
+)
+
+func main() {
+	stat, err := os.Stat(srcDir)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	if !stat.IsDir() {
+		log.Fatalf("%s is not a directory", srcDir)
+	}
+
+	_ = os.RemoveAll(dstDir)
+
+	err = processPackage(srcDir, dstDir)
+	if err != nil {
+		log.Fatalf("Processing package error: %v", err)
+	}
+}
+
+func processPackage(srcDir, dstDir string) error {
+	return filepath.Walk(srcDir, func(srcPath string, _ os.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+
+		if skipFile(srcPath) {
+			return nil
+		}
+
+		fset := token.NewFileSet()
+
+		file, err := parser.ParseFile(fset, srcPath, nil, parser.AllErrors)
+		if err != nil {
+			return fmt.Errorf("parsing %s: %w", srcPath, err)
+		}
+
+		processFile(file)
+
+		return writeNewFile(fset, file, srcPath, dstDir)
+	})
+}
+
+func skipFile(path string) bool {
+	if !strings.HasSuffix(path, ".go") || strings.HasSuffix(path, "_test.go") {
+		return true
+	}
+
+	if filepath.Base(path) == "base_loader.go" {
+		return true
+	}
+
+	if filepath.Base(path) == "loader.go" {
+		return true
+	}
+
+	return false
+}
+
+func processFile(file *ast.File) {
+	file.Name.Name = newPkgName
+
+	var newDecls []ast.Decl
+	for _, decl := range file.Decls {
+		switch d := decl.(type) {
+		case *ast.FuncDecl:
+			continue
+
+		case *ast.GenDecl:
+			switch d.Tok {
+			case token.CONST, token.VAR:
+				continue
+			case token.TYPE:
+				for _, spec := range d.Specs {
+					typeSpec, ok := spec.(*ast.TypeSpec)
+					if !ok {
+						continue
+					}
+
+					structType, ok := typeSpec.Type.(*ast.StructType)
+					if !ok {
+						continue
+					}
+
+					processStructFields(structType)
+				}
+			default:
+				// noop
+			}
+
+			newDecls = append(newDecls, decl)
+		}
+	}
+
+	file.Decls = newDecls
+}
+
+func processStructFields(structType *ast.StructType) {
+	var newFields []*ast.Field
+
+	for _, field := range structType.Fields.List {
+		if len(field.Names) > 0 && !field.Names[0].IsExported() {
+			continue
+		}
+
+		if field.Tag == nil {
+			continue
+		}
+
+		field.Type = convertType(field.Type)
+		field.Tag.Value = convertStructTag(field.Tag.Value)
+
+		newFields = append(newFields, field)
+	}
+
+	structType.Fields.List = newFields
+}
+
+func convertType(expr ast.Expr) ast.Expr {
+	ident, ok := expr.(*ast.Ident)
+	if !ok {
+		return expr
+	}
+
+	switch ident.Name {
+	case "bool", "string", "int", "int8", "int16", "int32", "int64", "float32", "float64":
+		return &ast.StarExpr{X: ident}
+
+	default:
+		return expr
+	}
+}
+
+func convertStructTag(value string) string {
+	structTag := reflect.StructTag(strings.Trim(value, "`"))
+
+	key := structTag.Get("mapstructure")
+
+	if key == ",squash" {
+		return wrapStructTag(`yaml:",inline"`)
+	}
+
+	return wrapStructTag(fmt.Sprintf(`yaml:"%[1]s,omitempty" toml:"%[1]s,omitempty"`, key))
+}
+
+func wrapStructTag(s string) string {
+	return "`" + s + "`"
+}
+
+func writeNewFile(fset *token.FileSet, file *ast.File, srcPath, dstDir string) error {
+	var buf bytes.Buffer
+
+	err := printer.Fprint(&buf, fset, file)
+	if err != nil {
+		return fmt.Errorf("printing %s: %w", srcPath, err)
+	}
+
+	dstPath := filepath.Join(dstDir, filepath.Base(srcPath))
+
+	_ = os.MkdirAll(filepath.Dir(dstPath), os.ModePerm)
+
+	formatted, err := imports.Process(dstPath, buf.Bytes(), nil)
+	if err != nil {
+		return fmt.Errorf("formatting %s: %w", dstPath, err)
+	}
+
+	//nolint:gosec,mnd // The permission is right.
+	err = os.WriteFile(dstPath, formatted, 0o644)
+	if err != nil {
+		return fmt.Errorf("writing file %s: %w", dstPath, err)
+	}
+
+	return nil
+}

pkg/commands/internal/migrate/ptr/ptr.go

@@ -0,0 +1,12 @@
+package ptr
+
+func Deref[T any](v *T) T {
+	if v == nil {
+		var zero T
+		return zero
+	}
+
+	return *v
+}
+
+func Pointer[T any](v T) *T { return &v }

pkg/commands/internal/migrate/two/base_rule.go

@@ -0,0 +1,11 @@
+package two
+
+type BaseRule struct {
+	Linters    []string `yaml:"linters,omitempty" toml:"linters,omitempty"`
+	Path       *string  `yaml:"path,omitempty" toml:"path,omitempty"`
+	PathExcept *string  `yaml:"path-except,omitempty" toml:"path-except,omitempty"`
+	Text       *string  `yaml:"text,omitempty" toml:"text,omitempty"`
+	Source     *string  `yaml:"source,omitempty" toml:"source,omitempty"`
+
+	InternalReference *string `yaml:"-,omitempty" toml:"-,omitempty"`
+}

pkg/commands/internal/migrate/two/config.go

@@ -0,0 +1,16 @@
+package two
+
+type Config struct {
+	Version *string `yaml:"version,omitempty" toml:"version,omitempty"`
+
+	Run Run `yaml:"run,omitempty" toml:"run,omitempty"`
+
+	Output Output `yaml:"output,omitempty" toml:"output,omitempty"`
+
+	Linters Linters `yaml:"linters,omitempty" toml:"linters,omitempty"`
+
+	Issues   Issues   `yaml:"issues,omitempty" toml:"issues,omitempty"`
+	Severity Severity `yaml:"severity,omitempty" toml:"severity,omitempty"`
+
+	Formatters Formatters `yaml:"formatters,omitempty" toml:"formatters,omitempty"`
+}

pkg/commands/internal/migrate/two/formatters.go

@@ -0,0 +1,12 @@
+package two
+
+type Formatters struct {
+	Enable     []string            `yaml:"enable,omitempty" toml:"enable,omitempty"`
+	Settings   FormatterSettings   `yaml:"settings,omitempty" toml:"settings,omitempty"`
+	Exclusions FormatterExclusions `yaml:"exclusions,omitempty" toml:"exclusions,omitempty"`
+}
+
+type FormatterExclusions struct {
+	Generated *string  `yaml:"generated,omitempty" toml:"generated,omitempty"`
+	Paths     []string `yaml:"paths,omitempty" toml:"paths,omitempty"`
+}

pkg/commands/internal/migrate/two/formatters_settings.go

@@ -0,0 +1,46 @@
+package two
+
+type FormatterSettings struct {
+	Gci       GciSettings       `yaml:"gci,omitempty" toml:"gci,omitempty"`
+	GoFmt     GoFmtSettings     `yaml:"gofmt,omitempty" toml:"gofmt,omitempty"`
+	GoFumpt   GoFumptSettings   `yaml:"gofumpt,omitempty" toml:"gofumpt,omitempty"`
+	GoImports GoImportsSettings `yaml:"goimports,omitempty" toml:"goimports,omitempty"`
+	GoLines   GoLinesSettings   `yaml:"golines,omitempty" toml:"golines,omitempty"`
+}
+
+type GciSettings struct {
+	Sections         []string `yaml:"sections,omitempty" toml:"sections,omitempty"`
+	NoInlineComments *bool    `yaml:"no-inline-comments,omitempty" toml:"no-inline-comments,omitempty"`
+	NoPrefixComments *bool    `yaml:"no-prefix-comments,omitempty" toml:"no-prefix-comments,omitempty"`
+	CustomOrder      *bool    `yaml:"custom-order,omitempty" toml:"custom-order,omitempty"`
+	NoLexOrder       *bool    `yaml:"no-lex-order,omitempty" toml:"no-lex-order,omitempty"`
+}
+
+type GoFmtSettings struct {
+	Simplify     *bool              `yaml:"simplify,omitempty" toml:"simplify,omitempty"`
+	RewriteRules []GoFmtRewriteRule `yaml:"rewrite-rules,omitempty" toml:"rewrite-rules,omitempty"`
+}
+
+type GoFmtRewriteRule struct {
+	Pattern     *string `yaml:"pattern,omitempty" toml:"pattern,omitempty"`
+	Replacement *string `yaml:"replacement,omitempty" toml:"replacement,omitempty"`
+}
+
+type GoFumptSettings struct {
+	ModulePath *string `yaml:"module-path,omitempty" toml:"module-path,omitempty"`
+	ExtraRules *bool   `yaml:"extra-rules,omitempty" toml:"extra-rules,omitempty"`
+
+	LangVersion *string `yaml:"-,omitempty" toml:"-,omitempty"`
+}
+
+type GoImportsSettings struct {
+	LocalPrefixes []string `yaml:"local-prefixes,omitempty" toml:"local-prefixes,omitempty"`
+}
+
+type GoLinesSettings struct {
+	MaxLen          *int  `yaml:"max-len,omitempty" toml:"max-len,omitempty"`
+	TabLen          *int  `yaml:"tab-len,omitempty" toml:"tab-len,omitempty"`
+	ShortenComments *bool `yaml:"shorten-comments,omitempty" toml:"shorten-comments,omitempty"`
+	ReformatTags    *bool `yaml:"reformat-tags,omitempty" toml:"reformat-tags,omitempty"`
+	ChainSplitDots  *bool `yaml:"chain-split-dots,omitempty" toml:"chain-split-dots,omitempty"`
+}

pkg/commands/internal/migrate/two/issues.go

@@ -0,0 +1,15 @@
+package two
+
+type Issues struct {
+	MaxIssuesPerLinter *int  `yaml:"max-issues-per-linter,omitempty" toml:"max-issues-per-linter,omitempty"`
+	MaxSameIssues      *int  `yaml:"max-same-issues,omitempty" toml:"max-same-issues,omitempty"`
+	UniqByLine         *bool `yaml:"uniq-by-line,omitempty" toml:"uniq-by-line,omitempty"`
+
+	DiffFromRevision  *string `yaml:"new-from-rev,omitempty" toml:"new-from-rev,omitempty"`
+	DiffFromMergeBase *string `yaml:"new-from-merge-base,omitempty" toml:"new-from-merge-base,omitempty"`
+	DiffPatchFilePath *string `yaml:"new-from-patch,omitempty" toml:"new-from-patch,omitempty"`
+	WholeFiles        *bool   `yaml:"whole-files,omitempty" toml:"whole-files,omitempty"`
+	Diff              *bool   `yaml:"new,omitempty" toml:"new,omitempty"`
+
+	NeedFix *bool `yaml:"fix,omitempty" toml:"fix,omitempty"`
+}

pkg/commands/internal/migrate/two/linters.go

@@ -0,0 +1,12 @@
+package two
+
+type Linters struct {
+	Default  *string  `yaml:"default,omitempty" toml:"default,omitempty"`
+	Enable   []string `yaml:"enable,omitempty" toml:"enable,omitempty"`
+	Disable  []string `yaml:"disable,omitempty" toml:"disable,omitempty"`
+	FastOnly *bool    `yaml:"fast-only,omitempty" toml:"fast-only,omitempty"`
+
+	Settings LintersSettings `yaml:"settings,omitempty" toml:"settings,omitempty"`
+
+	Exclusions LinterExclusions `yaml:"exclusions,omitempty" toml:"exclusions,omitempty"`
+}