Add support to use short forms of type keywords #3139
Conversation
filips123
force-pushed
the
short-type-hints
branch
from
1d2170d
to
87a6ef3
Compare
| * @var boolean | ||
| */ | ||
| public $useShortTypes = false; | ||
|
|
There was a problem hiding this comment.
Remove this empty line.
There was a problem hiding this comment.
Please don't request changes which are in violation with the coding standard used by the library.
| 'resource', | ||
| 'callable', | ||
| ]; | ||
|
|
There was a problem hiding this comment.
Remove this empty line.
There was a problem hiding this comment.
Please don't request changes which are in violation with the coding standard used by the library.
| * | ||
| * @var boolean | ||
| */ | ||
| public $useShortTypes = false; |
There was a problem hiding this comment.
Shouldn't this default to true due to PSR-12?
There was a problem hiding this comment.
Shouldn't this default to true due to PSR-12?
Problem is that this might be considered as a breaking change. I'm not sure how this was done in the past, but maybe it should remain false in PHPCS 3.x and changed to true in 4.x.
There was a problem hiding this comment.
I understand. In the mean time it's easy to just change that property in the config file.
|
Any chance to get this merged? Short return types are the way to go, especially because it does not comply to the rules of PSR-12 currently. "Short form of type keywords MUST be used i.e. bool instead of boolean, int instead of integer etc.". |
|
Until such time as this can be merged, I've added a workaround here: https://packagist.org/packages/zebra-north/phpcs-short-types It's not a proper fix, it would be great if this PR could be merged. |
|
I would love for this to be merged, we are using PHPStorm and it automatically (and correctly) uses short types which we have to manually update to pass our code sniffers |
|
Merging this in would be useful |
This adds support to use short forms of type keywords in comments for function parameters and returns and variable types. It fixes #1864 and fixes #1434.
It adds
useShortTypesproperty, which is by defaultfalse, toSquiz.Commenting.FunctionCommentandSquiz.Commenting.VariableCommentto allow users to use short type checks. If it is enabled, it will force short types in comments and suggest them when long ones are used.P.S. I would appreciate if you add
hacktoberfest-acceptedlabel to this PR, so it will count for this year's Hacktoberfest.