Skip to content

Commit

Permalink
Merge pull request #850 from LandonTClipp/LandonTClipp/deprecation_docs
Browse files Browse the repository at this point in the history
Docs: Make deprecations clearer
  • Loading branch information
LandonTClipp authored Nov 21, 2024
2 parents 5c75177 + 314381f commit 88830e8
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,28 @@ Deprecations
`packages`
----------

!!! tip ""

To resolve this warning, use the [`packages`](features.md#packages-configuration) feature:

```yaml title=".mockery.yaml"
packages:
[...]
```

The [`packages`](features.md#packages-configuration) feature will be the only way to configure mockery in the future.

`issue-845-fix`
---------------

!!! tip ""

To resolve this warning:

```yaml title=".mockery.yaml"
issue-845-fix: True
```

This parameter fixes a somewhat uninteresting, but important issue found in [#845](https://github.com/vektra/mockery/issues/845).
In short, mockery ignored the `#!yaml outpkg:` parameter if `#!yaml inpackage:` was set to `#!yaml True`. This prevents users
from being able to set alternate package names for their mocks that are generated in the same directory
Expand Down Expand Up @@ -40,6 +57,14 @@ if being generated with `#!yaml inpackage: True`.
`resolve-type-alias`
--------------------

!!! tip ""

To resolve this warning:

```yaml title=".mockery.yaml"
resolve-type-alias: False
```

This parameter directs Mockery on whether it should resolve a type alias to its underlying, real
type or if it should generate mocks by referencing. Mockery was changed in [#808](https://github.com/vektra/mockery/pull/808)
to support a new language feature that exposed type aliases in the parsed syntax tree. This meant
Expand Down

0 comments on commit 88830e8

Please sign in to comment.