feat: add default value support for @template annotations - #832
Merged
Conversation
Every generic of a class had to be given during mapping, even when a sensible fallback existed for some of them. Following PHPStan and Psalm, a template can now declare a default type, making the matching generic optional: ```php /** * @template TValue * @template TMeta of array<string, mixed> = array<string, string> */ final readonly class SomePage { public function __construct( /** @var list<TValue> */ public array $items, /** @var TMeta */ public array $meta, ) {} } final readonly class SomeClass { public function __construct( // `TMeta` is not filled in, its default type is used /** @var SomePage<SomeUser> */ public SomePage $pageWithDefaultMeta, // `TMeta` is filled in, overriding its default type /** @var SomePage<SomeUser, array{cursor: int}> */ public SomePage $pageWithCursorMeta, ) {} } ``` Templates declaring a default are not counted as required anymore, and the default is used as the fallback for an omitted generic, instead of the template itself.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Every generic of a class had to be given during mapping, even when a sensible fallback existed for some of them. Following PHPStan and Psalm, a template can now declare a default type, making the matching generic optional:
Templates declaring a default are not counted as required anymore, and the default is used as the fallback for an omitted generic, instead of the template itself.
Fixes #600