Merge pull request #776 from LandonTClipp/master

Add docs about `InterfaceFile`
vektra · Apr 29, 2024 · 0229bd4 · 0229bd4
2 parents 25d2eb0 + 514021e
commit 0229bd4
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -198,6 +198,7 @@ Variables that are marked as being templated are capable of using mockery-provid
 |-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | InterfaceDir            | The directory path of the original interface being mocked. This can be used as <br>`#!yaml dir: "{{.InterfaceDir}}"` to place your mocks adjacent to the original interface. This should not be used for external interfaces.                                                                 |
 | InterfaceDirRelative    | The directory path of the original interface being mocked, relative to the current working directory. If the path cannot be made relative to the current working directory, this variable will be set equal to `PackagePath`                                                                  |
+| InterfaceFile           | The file path of the original interface being mocked. **NOTE:** This option will only write one mock implementation to the output file. If multiple mocks are defined in your original file, only one mock will be written to the output.                                                     |
 | InterfaceName           | The name of the original interface being mocked                                                                                                                                                                                                                                               |
 | InterfaceNameCamel      | Converts a string `interface_name` to `InterfaceName`. <br /><b style="color:var(--md-code-hl-number-color);">DEPRECATED</b>: use `{{ .InterfaceName | camelcase }}` instead                                                                                                                                                                     | 
 | InterfaceNameLowerCamel | Converts `InterfaceName` to `interfaceName` . <br /><b style="color:var(--md-code-hl-number-color);">DEPRECATED</b>: use `{{ .InterfaceName | camelcase | firstLower }}` instead                                                                                                                                                                |