Improve PHPDoc types support

[julienfalque]

Related to #4913.

[julienfalque]

I've worked a bit more on this and made several improvements. Now this PR adds support for:

• spaces around |, e.g.: A | B
• class constants, e.g. Foo::BAR_*
• scalar constants, e.g. 'a' | 'b'
• types containing a -, e.g. class-string
• intersection types, e.g. A & B
• object-like arrays, e.g.: array{a: bool, b?: string}

[Slamdunk]

• spaces around |, e.g.: A | B
• class constants, e.g. Foo::BAR_*
• scalar constants, e.g. 'a' | 'b'
• types containing a -, e.g. class-string
• intersection types, e.g. A & B
• object-like arrays, e.g.: array{a: bool, b?: string}

I'm sorry @keradus to ping you, but v2.16.2 Yellow Bird kinda broke almost every project I'm aware of, since these notations are now widespread due to static analysis tools.

Hope to see a release with this bugfix as soon as possible 😢

[julienfalque]

@Slamdunk Note that the actual fix for the unexpected removal of annotations is #4915. This PR will rather unlock enhancements in e.g. phpdoc_to_return_type.

[Slamdunk]

Yup, sorry

after gitter talk

[kubawerlos]

@julienfalque can we add tests from #5049 here?

[julienfalque]

after gitter talk

Didn't get a notification for this review being dismissed. What was the talk about?

@julienfalque can we add tests from #5049 here?

Sure thing. Are you allowed to push on my branch? Otherwise I'll cherry-pick your commit.

[SpacePossum]

indeed, I don't see why the spacing would matter when extracting the type info

[julienfalque]

Using whitespaces is not a widespread practice but it should not be complicated to add support for it. I'll try to do it shortly.

[SpacePossum]

👍 it will saves the trouble of figuring out all the possible priority issues with fixers that clean up the spacing

[julienfalque]

Test case added. Though whitespaces are not stripped from the result because the type is parsed as a whole.

[SpacePossum]

Is the "type" " int " not exactly the same as "type" "int" ? Especially as the type " int " can never exist within PHP, same with class names that cannot contain pending or trialing spacing. I'm not sure why we would extract these differently but maybe I'm missing the use case here.

[julienfalque]

Not sure what you mean. The regex just extracts the type definition as-is, without changing anything to it. Those whitespaces have no special meaning, they are not part of a type, e.g. there is no " int " but "int" + whitespaces.

Removing the whitespaces would prevent, e.g. a fixer to know the original syntax in order to change it.

[SpacePossum]

@kubawerlos @julienfalque RTM than? can someone run this code on the some other code bases like SF/Twig/Doctrine for example to see if all goes well?

[SpacePossum]

and one more request, can some look into https://github.com/FriendsOfPHP/PHP-CS-Fixer/pull/5095/files to see if the issue there is no longer present in this PR?

[kubawerlos]

and one more request, can some look into https://github.com/FriendsOfPHP/PHP-CS-Fixer/pull/5095/files to see if the issue there is no longer present in this PR?

Can't we merge this and update the other one and we will all see?

[SpacePossum]

I prefer to resolve both PR's here as 5095 hasn't got any comments what so ever and I don't want it to sit there forever

[julienfalque]

@SpacePossum I tried applying changes from #5095 and all tests were green. I approved #5095, we can merge them separately IMO.

[coveralls]

Coverage increased (+0.0009%) to 91.549% when pulling fd4a770 on julienfalque:phpdoc-psalm-types into 25f9db1 on FriendsOfPHP:2.19.

[keradus]

can you rebase, @julienfalque ?

[julienfalque]

Done.

[keradus]

Thank you @julienfalque.

[Slamdunk]

@julienfalque do you think this could be behind #5836?