NotificationsYou must be signed in to change notification settings
Fork9.6k
Star30.3k

[TypeInfo] Add type alias support#59804

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

nicolas-grekas merged 1 commit intosymfony:7.3frommtarld:feat/type-aliases

Feb 19, 2025

Merged

[TypeInfo] Add type alias support#59804

nicolas-grekas merged 1 commit intosymfony:7.3frommtarld:feat/type-aliases

Feb 19, 2025

+302 −18

Conversation

Copy link

Contributor

mtarld commentedFeb 18, 2025•
edited
Loading

Q	A
Branch?	7.3
Bug fix?	no
New feature?	yes
Deprecations?	no
Issues
License	MIT

Add type aliasing support inTypeContext andStringTypeResolver, which enables the read of@phpstan-type and@phpstan-import-type.

With this PR, the following code will be properly understood by TypeInfo (before, it used to throw anUnhandledException):

/** * @phpstan-type TypeAlias = array<string, list<bool>> */finalclass Dummy{/**     * @var TypeAlias     */publicmixed$aliasedType;}

carsonbot added Status: Needs Review Bug Feature TypeInfo labels

Feb 18, 2025

carsonbot added this to the7.3 milestone

Feb 18, 2025

mtarld force-pushed thefeat/type-aliases branch 2 times, most recently from34dbc2f to14c1e1eCompare

February 18, 2025 16:01

Copy link

Member

nicolas-grekas commentedFeb 19, 2025

Note that the portable syntax (= understood by phpstan & psalm & phpstorm) is this one:
@phpstan-type TypeAlias = array<string, list<bool>>

nicolas-grekas reviewed

Feb 19, 2025

View reviewed changes

src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyWithPhpDoc.php OutdatedShow resolvedHide resolved

nicolas-grekas reviewed

Feb 19, 2025

View reviewed changes

src/Symfony/Component/TypeInfo/Tests/Fixtures/DummyWithTypeAliases.phpShow resolvedHide resolved

Copy link

Contributor

Neirda24 commentedFeb 19, 2025

Note that the portable syntax (= understood by phpstan & psalm & phpstorm) is this one:@phpstan-type TypeAlias = array<string, list<bool>>

But it is not how people usually write it I think. is it ?

Copy link

Member

nicolas-grekas commentedFeb 19, 2025

They have to if they want support from their tools...

mtarld force-pushed thefeat/type-aliases branch from14c1e1e tocd159cfCompare

February 19, 2025 08:51

nicolas-grekas reviewed

Feb 19, 2025

View reviewed changes

Copy link

Member

nicolas-grekas left a comment•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Can you add a test case using psalm-type just to confirm phpstan's parser handles both?

Copy link

Contributor

Neirda24 commentedFeb 19, 2025

They have to if they want support from their tools...

hmmm IMO when this PR is merged it must not enforce one specific way of writing things with these tools. It should support both with and without=. Current projects / libraries that uses these kind of features don't always use the=. Requiring it would restrict people from using the TypeInfo on tools that did not follow the symfony requirements.

mtarld force-pushed thefeat/type-aliases branch fromcd159cf todcceca6Compare

February 19, 2025 08:57

Copy link

Contributor

Neirda24 commentedFeb 19, 2025

They have to if they want support from their tools...

More on this. The documentationhttps://phpstan.org/writing-php-code/phpdoc-types#local-type-aliases doesn't even mention this. I asked Ondrej a while back on symfony's slack about this but he didn't tought it was worth adding it to documentation.

Copy link

ContributorAuthor

mtarld commentedFeb 19, 2025

@Neirda24,@nicolas-grekas, I updated the code/tests to make it work for@psalm-*,@phpstan-*, with and without the= so that it matches most of the use cases.