From 314381f49af38e4bc87183c8c2a99bb493a7e230 Mon Sep 17 00:00:00 2001 From: LandonTClipp <11232769+LandonTClipp@users.noreply.github.com> Date: Thu, 21 Nov 2024 16:00:08 -0600 Subject: [PATCH] Docs: Make deprecations clearer --- docs/deprecations.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/deprecations.md b/docs/deprecations.md index ee42996d..64903670 100644 --- a/docs/deprecations.md +++ b/docs/deprecations.md @@ -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 @@ -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