Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Make deprecations clearer #850

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading