Merge pull request #598 from LandonTClipp/documentation

Add `exclude` documentation

docs/changelog.md

@@ -3,6 +3,10 @@ Changelog
 
 This changelog describes major feature additions. Please view the `releases` page for more details on commits and minor changes.
 
+### :octicons-tag-24: [`v2.24.0`](https://github.com/vektra/mockery/releases/tag/v2.24.0) `exclude` config
+
+The `exclude` parameter allows you to define subpaths to ignore. This is currently only compatible when using non-`packages` config.
+
 ### :octicons-tag-24: [`v2.23.0`](https://github.com/vektra/mockery/releases/tag/v2.23.0) Replace Types
 
 The `replace-type` parameter allows adding a list of type replacements to be made in package and/or type names.

docs/configuration.md

@@ -42,20 +42,21 @@ Parameter Descriptions
 
     | name | description |
     |------|-------------|
-    | `name`  | The `name` option takes either the name or matching regular expression of the interface to generate mock(s) for. |
     | `all`  |  It's common for a big package to have a lot of interfaces, so mockery provides `all`. This option will tell mockery to scan all files under the directory named by `--dir` ("." by default) and generates mocks for any interfaces it finds. This option implies `recursive: True`. |
-    | `recursive`  |  Use the `recursive` option to search subdirectories for the interface(s). This option is only compatible with `name`. The `all` option implies `recursive: True`. |
-    | `output` | mockery always generates files with the package `mocks` to keep things clean and simple. You can control which mocks directory is used by using `output`, which defaults to `./mocks`. |
-    |`outpkg`| Use `outpkg` to specify the package name of the generated mocks.|
-    | `inpackage` and `keeptree` | For some complex repositories, there could be multiple interfaces with the same name but in different packages. In that case, `inpackage` allows generating the mocked interfaces directly in the package that it mocks. In the case you don't want to generate the mocks into the package but want to keep a similar structure, use the option `keeptree`. |
-    | `filename` | Use the `filename` and `structname` to override the default generated file and struct name. These options are only compatible with non-regular expressions in `name`, where only one mock is generated. |
     | `case` | mockery generates files using the casing of the original interface name.  This can be modified by specifying `case: underscore` to format the generated file name using underscore casing. |
-    | `print` | Use `print: True` to have the resulting code printed out instead of written to disk. |
+    | `exclude` | This parameter is a list of strings representing path prefixes that should be excluded from mock generation. |
     | `exported` | Use `exported: True` to generate public mocks for private interfaces. |
-    | `with-expecter` | Use `with-expecter: True` to generate `EXPECT()` methods for your mocks. This is the preferred way to setup your mocks. |
-    | `testonly` | Prepend every mock file with `_test.go`. This is useful in cases where you are generating mocks `inpackage` but don't want the mocks to be visible to code outside of tests. |
+    | `filename` | Use the `filename` and `structname` to override the default generated file and struct name. These options are only compatible with non-regular expressions in `name`, where only one mock is generated. |
     | `inpackage-suffix` | When `inpackage-suffix` is set to `True`, mock files are suffixed with `_mock` instead of being prefixed with `mock_` for InPackage mocks |
+    | `inpackage` and `keeptree` | For some complex repositories, there could be multiple interfaces with the same name but in different packages. In that case, `inpackage` allows generating the mocked interfaces directly in the package that it mocks. In the case you don't want to generate the mocks into the package but want to keep a similar structure, use the option `keeptree`. |
+    | `name`  | The `name` option takes either the name or matching regular expression of the interface to generate mock(s) for. |
+    | `output` | mockery always generates files with the package `mocks` to keep things clean and simple. You can control which mocks directory is used by using `output`, which defaults to `./mocks`. |
+    |`outpkg`| Use `outpkg` to specify the package name of the generated mocks.|
+    | `print` | Use `print: True` to have the resulting code printed out instead of written to disk. |
+    | `recursive`  |  Use the `recursive` option to search subdirectories for the interface(s). This option is only compatible with `name`. The `all` option implies `recursive: True`. |
     | `replace-type source=destination` | Replaces aliases, packages and/or types during generation.|
+    | `testonly` | Prepend every mock file with `_test.go`. This is useful in cases where you are generating mocks `inpackage` but don't want the mocks to be visible to code outside of tests. |
+    | `with-expecter` | Use `with-expecter: True` to generate `EXPECT()` methods for your mocks. This is the preferred way to setup your mocks. |
 
 === "`packages` config"