Rename include/exclude-regex to be more specific and clear.

Author: LandonTClipp

.mockery_matryer.yml

@@ -12,8 +12,8 @@ packages:
   github.com/vektra/mockery/v3/internal/fixtures:
     config:
       all: false
-      include-regex: '.*'
-      exclude-regex: 'RequesterGenerics'
+      include-interface-regex: '.*'
+      exclude-interface-regex: 'RequesterGenerics'
     interfaces:
       Requester:
         configs:

config/config.go

@@ -418,11 +418,11 @@ func (c PackageConfig) GetInterfaceConfig(ctx context.Context, interfaceName str
 func (c PackageConfig) ShouldGenerateInterface(ctx context.Context, interfaceName string) (bool, error) {
 	log := zerolog.Ctx(ctx)
 	if *c.Config.All {
-		if *c.Config.IncludeRegex != "" {
-			log.Warn().Msg("interface config has both `all` and `include-regex` set: `include-regex` will be ignored")
+		if *c.Config.IncludeInterfaceRegex != "" {
+			log.Warn().Msg("interface config has both `all` and `include-interface-regex` set: `include-interface-regex` will be ignored")
 		}
-		if *c.Config.ExcludeRegex != "" {
-			log.Warn().Msg("interface config has both `all` and `exclude-regex` set: `exclude-regex` will be ignored")
+		if *c.Config.ExcludeInterfaceRegex != "" {
+			log.Warn().Msg("interface config has both `all` and `exclude-interface-regex` set: `exclude-interface-regex` will be ignored")
 		}
 		log.Debug().Msg("`all: true` is set, interface should be generated")
 		return true, nil
@@ -432,35 +432,35 @@ func (c PackageConfig) ShouldGenerateInterface(ctx context.Context, interfaceNam
 		return true, nil
 	}
 
-	includeRegex := *c.Config.IncludeRegex
-	excludeRegex := *c.Config.ExcludeRegex
+	includeRegex := *c.Config.IncludeInterfaceRegex
+	excludeRegex := *c.Config.ExcludeInterfaceRegex
 	if includeRegex == "" {
 		if excludeRegex != "" {
-			log.Warn().Msg("interface config has `exclude-regex` set but not `include-regex`: `exclude-regex` will be ignored")
+			log.Warn().Msg("interface config has `exclude-interface-regex` set but not `include-interface-regex`: `exclude-interface-regex` will be ignored")
 		}
 		return false, nil
 	}
 	includedByRegex, err := regexp.MatchString(includeRegex, interfaceName)
 	if err != nil {
-		return false, fmt.Errorf("evaluating `include-regex`: %w", err)
+		return false, fmt.Errorf("evaluating `include-interface-regex`: %w", err)
 	}
 	if !includedByRegex {
-		log.Debug().Msg("interface does not match include-regex")
+		log.Debug().Msg("interface does not match include-interface-regex")
 		return false, nil
 	}
-	log.Debug().Msg("interface matches include-regex")
+	log.Debug().Msg("interface matches include-interface-regex")
 	if excludeRegex == "" {
 		return true, nil
 	}
 	excludedByRegex, err := regexp.MatchString(excludeRegex, interfaceName)
 	if err != nil {
-		return false, fmt.Errorf("evaluating `exclude-regex`: %w", err)
+		return false, fmt.Errorf("evaluating `exclude-interface-regex`: %w", err)
 	}
 	if excludedByRegex {
-		log.Debug().Msg("interface matches exclude-regex")
+		log.Debug().Msg("interface matches exclude-interface-regex")
 		return false, nil
 	}
-	log.Debug().Msg("interface does not match exclude-regex")
+	log.Debug().Msg("interface does not match exclude-interface-regex")
 	return true, nil
 }
 
@@ -494,22 +494,22 @@ type ReplaceType struct {
 }
 
 type Config struct {
-	All                *bool          `koanf:"all" yaml:"all,omitempty"`
-	Anchors            map[string]any `koanf:"_anchors" yaml:"_anchors,omitempty"`
-	BuildTags          *string        `koanf:"build-tags" yaml:"build-tags,omitempty"`
-	ConfigFile         *string        `koanf:"config" yaml:"config,omitempty"`
-	Dir                *string        `koanf:"dir" yaml:"dir,omitempty"`
-	ExcludeSubpkgRegex []string       `koanf:"exclude-subpkg-regex" yaml:"exclude-subpkg-regex,omitempty"`
-	ExcludeRegex       *string        `koanf:"exclude-regex" yaml:"exclude-regex,omitempty"`
-	FileName           *string        `koanf:"filename" yaml:"filename,omitempty"`
+	All                   *bool          `koanf:"all" yaml:"all,omitempty"`
+	Anchors               map[string]any `koanf:"_anchors" yaml:"_anchors,omitempty"`
+	BuildTags             *string        `koanf:"build-tags" yaml:"build-tags,omitempty"`
+	ConfigFile            *string        `koanf:"config" yaml:"config,omitempty"`
+	Dir                   *string        `koanf:"dir" yaml:"dir,omitempty"`
+	ExcludeSubpkgRegex    []string       `koanf:"exclude-subpkg-regex" yaml:"exclude-subpkg-regex,omitempty"`
+	ExcludeInterfaceRegex *string        `koanf:"exclude-interface-regex" yaml:"exclude-interface-regex,omitempty"`
+	FileName              *string        `koanf:"filename" yaml:"filename,omitempty"`
 	// ForceFileWrite controls whether mockery will overwrite existing files when generating mocks. This is by default set to false.
-	ForceFileWrite *bool   `koanf:"force-file-write" yaml:"force-file-write,omitempty"`
-	Formatter      *string `koanf:"formatter" yaml:"formatter,omitempty"`
-	IncludeRegex   *string `koanf:"include-regex" yaml:"include-regex,omitempty"`
-	LogLevel       *string `koanf:"log-level" yaml:"log-level,omitempty"`
-	StructName     *string `koanf:"structname" yaml:"structname,omitempty"`
-	PkgName        *string `koanf:"pkgname" yaml:"pkgname,omitempty"`
-	Recursive      *bool   `koanf:"recursive" yaml:"recursive,omitempty"`
+	ForceFileWrite        *bool   `koanf:"force-file-write" yaml:"force-file-write,omitempty"`
+	Formatter             *string `koanf:"formatter" yaml:"formatter,omitempty"`
+	IncludeInterfaceRegex *string `koanf:"include-interface-regex" yaml:"include-interface-regex,omitempty"`
+	LogLevel              *string `koanf:"log-level" yaml:"log-level,omitempty"`
+	StructName            *string `koanf:"structname" yaml:"structname,omitempty"`
+	PkgName               *string `koanf:"pkgname" yaml:"pkgname,omitempty"`
+	Recursive             *bool   `koanf:"recursive" yaml:"recursive,omitempty"`
 	// ReplaceType is a nested map of format map["package path"]["type name"]*ReplaceType
 	ReplaceType map[string]map[string]*ReplaceType `koanf:"replace-type" yaml:"replace-type,omitempty"`
 	// RequireTemplateSchemaExists sets whether mockery will fail if the specified

docs/configuration.md

@@ -121,11 +121,11 @@ Parameter Descriptions
 | `config`                                               | :fontawesome-solid-x:     | `#!yaml ""`                           | Set the location of the mockery config file.                                                                                                                                                                                                         |
 | `dir`                                                  | :fontawesome-solid-check: | `#!yaml "mocks/{{.SrcPackagePath}}"`  | The directory where the mock file will be outputted to.                                                                                                                                                                                              |
 | `exclude-subpkg-regex`                                 | :fontawesome-solid-x:     | `#!yaml []`                           | A list of regular expressions that denote which subpackages should be excluded when `#!yaml recursive: true` |
-| `exclude-regex`                                        | :fontawesome-solid-x:     | `#!yaml ""`                           | When set along with `include-regex`, then interfaces which match `include-regex` but also match `exclude-regex` will not be generated. If `all` is set, or if `include-regex` is not set, then `exclude-regex` has no effect.                        |
+| `exclude-interface-regex`                              | :fontawesome-solid-x:     | `#!yaml ""`                           | When set along with `include-interface-regex`, then interfaces which match `include-interface-regex` but also match `exclude-interface-regex` will not be generated. If `all` is set, or if `include-interface-regex` is not set, then `exclude-interface-regex` has no effect.                        |
 | `filename`                                             | :fontawesome-solid-check: | `#!yaml "mock_{{.InterfaceName}}.go"` | The name of the file the mock will reside in.                                                                                                                                                                                                        |
 | `force-file-write`                                     | :fontawesome-solid-x:     | `#!yaml false`                        | When set to `#!yaml force-file-write: true`, mockery will forcibly overwrite any existing files. |
 | `formatter`                                            | :fontawesome-solid-x:     | `#!yaml "goimports"`                  | The formatter to use on the rendered template. Choices are: `gofmt`, `goimports`, `noop`.                                                                                                                                                            |
-| `include-regex`                                        | :fontawesome-solid-x:     | `#!yaml ""`                           | When set, only interface names that match the expression will be generated. This setting is ignored if `all: True` is specified in the configuration. To further refine the interfaces generated, use `exclude-regex`.                               |
+| `include-interface-regex`                              | :fontawesome-solid-x:     | `#!yaml ""`                           | When set, only interface names that match the expression will be generated. This setting is ignored if `all: True` is specified in the configuration. To further refine the interfaces generated, use `exclude-interface-regex`.                               |
 | `log-level`                                            | :fontawesome-solid-x:     | `#!yaml "info"`                       | Set the level of the logger                                                                                                                                                                                                                          |
 | `structname`                                             | :fontawesome-solid-check: | `#!yaml "Mock{{.InterfaceName}}"`   | The name of the generated interface implementation.                                                                                                                                                                                                                      |
 | `packages`                                             | :fontawesome-solid-x:     | `#!yaml null`                         | A dictionary containing configuration describing the packages and interfaces to generate mocks for.                                                                                                                                                  |

internal/cmd/migrate.go

@@ -326,7 +326,7 @@ func migrateConfig(
 		tbl.Append("deprecated-parameter", "`dry-run` not supported in v3.")
 	}
 	v3.ExcludeSubpkgRegex = v2Config.Exclude
-	v3.ExcludeRegex = v2Config.ExcludeRegex
+	v3.ExcludeInterfaceRegex = v2Config.ExcludeRegex
 	if v2Config.Exported != nil {
 		tbl.Append("deprecated-parameter", "`exported` is no longer supported. Use `structname` instead.")
 	}
@@ -340,7 +340,7 @@ func migrateConfig(
 	if v2Config.IncludeAutoGenerated != nil && *v2Config.IncludeAutoGenerated == false {
 		tbl.Append("deprecated-parameter", "`include-auto-generated` is not supported in v3, but PRs are welcome: https://github.com/vektra/mockery/issues/954")
 	}
-	v3.IncludeRegex = v2Config.IncludeRegex
+	v3.IncludeInterfaceRegex = v2Config.IncludeRegex
 	if v2Config.Issue845Fix == nil || *v2Config.Issue845Fix == false {
 		tbl.Append("deprecated-parameter", "`issue-845-fix` is permanently set to True in v3.")
 	}