feat(migrate): Add command to migrate v2 config to v3. (#953)

Author: LandonTClipp

.golangci.yml

@@ -40,6 +40,42 @@ linters-settings:
       - empty
       - expected-actual
       - len
+  gosimple:
+    checks:
+      - S1000
+      - S1001
+      - S1003
+      - S1004
+      - S1005
+      - S1006
+      - S1007
+      - S1008
+      - S1009
+      - S1010
+      - S1011
+      - S1012
+      - S1016
+      - S1017
+      - S1018
+      - S1019
+      - S1020
+      - S1021
+      - S1023
+      - S1024
+      - S1025
+      - S1028
+      - S1029
+      - S1030
+      - S1031
+      - S1032
+      - S1033
+      - S1034
+      - S1035
+      - S1036
+      - S1037
+      - S1038
+      - S1039
+      - S1040
 issues:
   exclude-rules:
     - linters:

config/config.go

@@ -4,7 +4,6 @@ import (
 	"bufio"
 	"bytes"
 	"context"
-	"errors"
 	"fmt"
 	"go/ast"
 	"os"
@@ -24,6 +23,7 @@ import (
 	"github.com/knadh/koanf/v2"
 	"github.com/rs/zerolog"
 	"github.com/spf13/pflag"
+	internalConfig "github.com/vektra/mockery/v3/internal/config"
 	"github.com/vektra/mockery/v3/internal/logging"
 	"github.com/vektra/mockery/v3/internal/stackerr"
 	"github.com/vektra/mockery/v3/shared"
@@ -48,8 +48,8 @@ func NewInterface(name string, filename string, file *ast.File, pkg *packages.Pa
 	}
 }
 
-// Data is the data sent to the template for the config file.
-type Data struct {
+// TemplateData is the data sent to the template for the config file.
+type TemplateData struct {
 	// ConfigDir is the directory of where the mockery config file is located.
 	ConfigDir string
 	// InterfaceDir is the directory of the interface being mocked.
@@ -96,7 +96,7 @@ func NewDefaultKoanf(ctx context.Context) (*koanf.Koanf, error) {
 }
 
 type RootConfig struct {
-	Config     `koanf:",squash" yaml:",inline"`
+	*Config    `koanf:",squash" yaml:",inline"`
 	Packages   map[string]*PackageConfig `koanf:"packages" yaml:"packages"`
 	koanf      *koanf.Koanf
 	configFile *pathlib.Path
@@ -131,7 +131,7 @@ func NewRootConfig(
 		return nil, nil, err
 	}
 	var rootConfig RootConfig = RootConfig{
-		Config: *conf,
+		Config: conf,
 		koanf:  k,
 	}
 
@@ -150,7 +150,7 @@ func NewRootConfig(
 	}
 	if configFile == nil {
 		log.Debug().Msg("config file not specified, searching")
-		configFile, err = findConfig()
+		configFile, err = internalConfig.FindConfig()
 		if err != nil {
 			return nil, k, fmt.Errorf("discovering mockery config: %w", err)
 		}
@@ -280,7 +280,7 @@ func (c *RootConfig) Initialize(ctx context.Context) error {
 		pkgLog := log.With().Str("package-path", pkgName).Logger()
 		pkgCtx := pkgLog.WithContext(ctx)
 
-		mergeConfigs(pkgCtx, c.Config, pkgConfig.Config)
+		mergeConfigs(pkgCtx, *c.Config, pkgConfig.Config)
 		if err := pkgConfig.Initialize(pkgCtx); err != nil {
 			return fmt.Errorf("initializing root config: %w", err)
 		}
@@ -506,28 +506,6 @@ type Config struct {
 	Version      *bool                              `koanf:"version" yaml:"version,omitempty"`
 }
 
-func findConfig() (*pathlib.Path, error) {
-	cwd, err := os.Getwd()
-	if err != nil {
-		return nil, fmt.Errorf("getting current working directory: %w", err)
-	}
-	currentPath := pathlib.NewPath(cwd)
-	for len(currentPath.Parts()) != 1 {
-		for _, confName := range []string{".mockery.yaml", ".mockery.yml"} {
-			configPath := currentPath.Join(confName)
-			isFile, err := configPath.Exists()
-			if err != nil {
-				return nil, fmt.Errorf("checking if %s is file: %w", configPath.String(), err)
-			}
-			if isFile {
-				return configPath, nil
-			}
-		}
-		currentPath = currentPath.Parent()
-	}
-	return nil, errors.New("mockery config file not found")
-}
-
 func (c *Config) FilePath() *pathlib.Path {
 	return pathlib.NewPath(*c.Dir).Join(*c.FileName).Clean()
 }
@@ -608,7 +586,7 @@ func (c *Config) ParseTemplates(ctx context.Context, iface *Interface, srcPkg *p
 		}
 	}
 	// data is the struct sent to the template parser
-	data := Data{
+	data := TemplateData{
 		ConfigDir:            filepath.Dir(*c.ConfigFile),
 		InterfaceDir:         interfaceDir,
 		InterfaceDirRelative: interfaceDirRelative,

docs/configuration.md

@@ -109,11 +109,6 @@ import (
     2. There are a number of template variables available to generalize config values.
     3. The style of mock to be generated is specified using the [`template`](template/index.md) parameter.
 
-As you can see, configuration parameters are hierarchal such that:
-
-- Interface-level config overrides package-level config.
-- Package-level config overrides top-level config.
-
 Parameter Descriptions
 -----------------------
 
@@ -139,6 +134,9 @@ Parameter Descriptions
 | `template`                                             | :fontawesome-solid-x:     | `#!yaml ""`                           | The template to use. The choices are `moq`, `mockery`, or a file path provided by `file://path/to/file.txt`.                                                                                                                                         |
 | `template-data`                                        | :fontawesome-solid-x:     | `#!yaml {}`                           | A `map[string]any` that provides arbitrary options to the template. Each template will have a different set of accepted keys. Refer to each template's documentation for more details.                                                               |
 
+!!! tip "`pkg.go.dev`"
+
+    The full schema definition can be viewed at our [pkg.go.dev](https://pkg.go.dev/github.com/vektra/mockery/v3/config#RootConfig) site.
 
 Templates
 ---------

docs/replace-type.md

@@ -6,7 +6,6 @@ title: replace-type
 
 The `#!yaml replace-type:` parameter allows you to replace a type in the generated mocks with another type. Take for example the following interface:
 
-
 ```go title="interface.go"
 package replace_type
 
@@ -22,6 +21,8 @@ type RType interface {
 
 You can selectively replace the `rt1.RType1` with a new type if so desired. For example:
 
+### Schema
+
 ```yaml title=".mockery.yml"
 replace-type:
   github.com/vektra/mockery/v3/internal/fixtures/example_project/replace_type/rti/rt1:
@@ -30,6 +31,8 @@ replace-type:
       type-name: RType2
 ```
 
+### Result
+
 The mock will now replace all instances of `rt1.RType1` with `rt2.RType2`. You can see the before and after of `mockery`-style mocks:
 
 === "before"
@@ -44,7 +47,7 @@ The mock will now replace all instances of `rt1.RType1` with `rt2.RType2`. You c
 
 === "after"
 
-    ```go 
+    ```go
     // Replace2 provides a mock function for the type RTypeReplaced1
     func (_mock *RTypeReplaced1) Replace1(f rt2.RType2) {
         _mock.Called(f)