From 9be9b717d9993889fe75a9adb3a2f730736fe3ad Mon Sep 17 00:00:00 2001 From: Andrii Dembitskyi Date: Sun, 1 Nov 2020 20:42:02 +0200 Subject: [PATCH 1/2] Fix CS for `phpdoc_types_null_last` rule --- bin/src/MixinGenerator.php | 6 +- src/Mixin.php | 142 ++++++++++++++++++------------------- 2 files changed, 74 insertions(+), 74 deletions(-) diff --git a/bin/src/MixinGenerator.php b/bin/src/MixinGenerator.php index 5d8caf64..0803e371 100644 --- a/bin/src/MixinGenerator.php +++ b/bin/src/MixinGenerator.php @@ -122,7 +122,7 @@ private function interface(ReflectionClass $assert): string */ private function nullOr(ReflectionMethod $method, int $indent): ?string { - return $this->assertion($method, 'nullOr%s', 'null|%s', $indent); + return $this->assertion($method, 'nullOr%s', '%s|null', $indent); } /** @@ -157,7 +157,7 @@ private function assertion(ReflectionMethod $method, string $methodNameTemplate, $parsedComment = $this->parseDocComment($comment); $parameters = []; - /** @psalm-var array $parametersDefaults */ + /** @psalm-var array $parametersDefaults */ $parametersDefaults = []; $parametersReflection = $method->getParameters(); @@ -262,7 +262,7 @@ private function applyTypeTemplate(string $type, string $typeTemplate): string { $combinedType = sprintf($typeTemplate, $type); - if ('null|empty' === $combinedType) { + if ('empty|null' === $combinedType) { $combinedType = 'empty'; // @see https://github.com/vimeo/psalm/issues/3492 } diff --git a/src/Mixin.php b/src/Mixin.php index 3ad9b2d0..ccc43990 100644 --- a/src/Mixin.php +++ b/src/Mixin.php @@ -16,7 +16,7 @@ interface Mixin { /** * @psalm-pure - * @psalm-assert null|string $value + * @psalm-assert string|null $value * * @param mixed $value * @param string $message @@ -38,7 +38,7 @@ public static function allString($value, $message = ''); /** * @psalm-pure - * @psalm-assert null|non-empty-string $value + * @psalm-assert non-empty-string|null $value * * @param mixed $value * @param string $message @@ -60,7 +60,7 @@ public static function allStringNotEmpty($value, $message = ''); /** * @psalm-pure - * @psalm-assert null|int $value + * @psalm-assert int|null $value * * @param mixed $value * @param string $message @@ -82,7 +82,7 @@ public static function allInteger($value, $message = ''); /** * @psalm-pure - * @psalm-assert null|numeric $value + * @psalm-assert numeric|null $value * * @param mixed $value * @param string $message @@ -104,7 +104,7 @@ public static function allIntegerish($value, $message = ''); /** * @psalm-pure - * @psalm-assert null|float $value + * @psalm-assert float|null $value * * @param mixed $value * @param string $message @@ -126,7 +126,7 @@ public static function allFloat($value, $message = ''); /** * @psalm-pure - * @psalm-assert null|numeric $value + * @psalm-assert numeric|null $value * * @param mixed $value * @param string $message @@ -148,7 +148,7 @@ public static function allNumeric($value, $message = ''); /** * @psalm-pure - * @psalm-assert null|int $value + * @psalm-assert int|null $value * * @param mixed $value * @param string $message @@ -170,7 +170,7 @@ public static function allNatural($value, $message = ''); /** * @psalm-pure - * @psalm-assert null|bool $value + * @psalm-assert bool|null $value * * @param mixed $value * @param string $message @@ -192,7 +192,7 @@ public static function allBoolean($value, $message = ''); /** * @psalm-pure - * @psalm-assert null|scalar $value + * @psalm-assert scalar|null $value * * @param mixed $value * @param string $message @@ -214,7 +214,7 @@ public static function allScalar($value, $message = ''); /** * @psalm-pure - * @psalm-assert null|object $value + * @psalm-assert object|null $value * * @param mixed $value * @param string $message @@ -236,7 +236,7 @@ public static function allObject($value, $message = ''); /** * @psalm-pure - * @psalm-assert null|resource $value + * @psalm-assert resource|null $value * * @param mixed $value * @param string|null $type type of resource this should be. @see https://www.php.net/manual/en/function.get-resource-type.php @@ -260,7 +260,7 @@ public static function allResource($value, $type = null, $message = ''); /** * @psalm-pure - * @psalm-assert null|callable $value + * @psalm-assert callable|null $value * * @param mixed $value * @param string $message @@ -282,7 +282,7 @@ public static function allIsCallable($value, $message = ''); /** * @psalm-pure - * @psalm-assert null|array $value + * @psalm-assert array|null $value * * @param mixed $value * @param string $message @@ -304,7 +304,7 @@ public static function allIsArray($value, $message = ''); /** * @psalm-pure - * @psalm-assert null|iterable $value + * @psalm-assert iterable|null $value * * @deprecated use "isIterable" or "isInstanceOf" instead * @@ -330,7 +330,7 @@ public static function allIsTraversable($value, $message = ''); /** * @psalm-pure - * @psalm-assert null|array|ArrayAccess $value + * @psalm-assert array|ArrayAccess|null $value * * @param mixed $value * @param string $message @@ -352,7 +352,7 @@ public static function allIsArrayAccessible($value, $message = ''); /** * @psalm-pure - * @psalm-assert null|countable $value + * @psalm-assert countable|null $value * * @param mixed $value * @param string $message @@ -374,7 +374,7 @@ public static function allIsCountable($value, $message = ''); /** * @psalm-pure - * @psalm-assert null|iterable $value + * @psalm-assert iterable|null $value * * @param mixed $value * @param string $message @@ -398,7 +398,7 @@ public static function allIsIterable($value, $message = ''); * @psalm-pure * @psalm-template ExpectedType of object * @psalm-param class-string $class - * @psalm-assert null|ExpectedType $value + * @psalm-assert ExpectedType|null $value * * @param mixed $value * @param string|object $class @@ -476,9 +476,9 @@ public static function allIsInstanceOfAny($value, $classes, $message = ''); * @psalm-pure * @psalm-template ExpectedType of object * @psalm-param class-string $class - * @psalm-assert null|ExpectedType|class-string $value + * @psalm-assert ExpectedType|class-string|null $value * - * @param null|object|string $value + * @param object|string|null $value * @param string $class * @param string $message * @@ -505,7 +505,7 @@ public static function allIsAOf($value, $class, $message = ''); * @psalm-template UnexpectedType of object * @psalm-param class-string $class * - * @param null|object|string $value + * @param object|string|null $value * @param string $class * @param string $message * @@ -530,7 +530,7 @@ public static function allIsNotA($value, $class, $message = ''); * @psalm-pure * @psalm-param array $classes * - * @param null|object|string $value + * @param object|string|null $value * @param string[] $classes * @param string $message * @@ -615,7 +615,7 @@ public static function allNotNull($value, $message = ''); /** * @psalm-pure - * @psalm-assert null|true $value + * @psalm-assert true|null $value * * @param mixed $value * @param string $message @@ -637,7 +637,7 @@ public static function allTrue($value, $message = ''); /** * @psalm-pure - * @psalm-assert null|false $value + * @psalm-assert false|null $value * * @param mixed $value * @param string $message @@ -742,7 +742,7 @@ public static function nullOrEmail($value, $message = ''); public static function allEmail($value, $message = ''); /** - * @param null|array $values + * @param array|null $values * @param string $message * * @throws InvalidArgumentException @@ -996,7 +996,7 @@ public static function allInArray($value, $values, $message = ''); /** * @psalm-pure * - * @param null|string $value + * @param string|null $value * @param string $subString * @param string $message * @@ -1018,7 +1018,7 @@ public static function allContains($value, $subString, $message = ''); /** * @psalm-pure * - * @param null|string $value + * @param string|null $value * @param string $subString * @param string $message * @@ -1040,7 +1040,7 @@ public static function allNotContains($value, $subString, $message = ''); /** * @psalm-pure * - * @param null|string $value + * @param string|null $value * @param string $message * * @throws InvalidArgumentException @@ -1060,7 +1060,7 @@ public static function allNotWhitespaceOnly($value, $message = ''); /** * @psalm-pure * - * @param null|string $value + * @param string|null $value * @param string $prefix * @param string $message * @@ -1082,7 +1082,7 @@ public static function allStartsWith($value, $prefix, $message = ''); /** * @psalm-pure * - * @param null|string $value + * @param string|null $value * @param string $prefix * @param string $message * @@ -1124,7 +1124,7 @@ public static function allStartsWithLetter($value, $message = ''); /** * @psalm-pure * - * @param null|string $value + * @param string|null $value * @param string $suffix * @param string $message * @@ -1146,7 +1146,7 @@ public static function allEndsWith($value, $suffix, $message = ''); /** * @psalm-pure * - * @param null|string $value + * @param string|null $value * @param string $suffix * @param string $message * @@ -1168,7 +1168,7 @@ public static function allNotEndsWith($value, $suffix, $message = ''); /** * @psalm-pure * - * @param null|string $value + * @param string|null $value * @param string $pattern * @param string $message * @@ -1190,7 +1190,7 @@ public static function allRegex($value, $pattern, $message = ''); /** * @psalm-pure * - * @param null|string $value + * @param string|null $value * @param string $pattern * @param string $message * @@ -1252,7 +1252,7 @@ public static function allAlpha($value, $message = ''); /** * @psalm-pure * - * @param null|string $value + * @param string|null $value * @param string $message * * @throws InvalidArgumentException @@ -1272,7 +1272,7 @@ public static function allDigits($value, $message = ''); /** * @psalm-pure * - * @param null|string $value + * @param string|null $value * @param string $message * * @throws InvalidArgumentException @@ -1291,9 +1291,9 @@ public static function allAlnum($value, $message = ''); /** * @psalm-pure - * @psalm-assert null|lowercase-string $value + * @psalm-assert lowercase-string|null $value * - * @param null|string $value + * @param string|null $value * @param string $message * * @throws InvalidArgumentException @@ -1314,7 +1314,7 @@ public static function allLower($value, $message = ''); /** * @psalm-pure * - * @param null|string $value + * @param string|null $value * @param string $message * * @throws InvalidArgumentException @@ -1334,7 +1334,7 @@ public static function allUpper($value, $message = ''); /** * @psalm-pure * - * @param null|string $value + * @param string|null $value * @param int $length * @param string $message * @@ -1356,7 +1356,7 @@ public static function allLength($value, $length, $message = ''); /** * @psalm-pure * - * @param null|string $value + * @param string|null $value * @param int|float $min * @param string $message * @@ -1378,7 +1378,7 @@ public static function allMinLength($value, $min, $message = ''); /** * @psalm-pure * - * @param null|string $value + * @param string|null $value * @param int|float $max * @param string $message * @@ -1400,7 +1400,7 @@ public static function allMaxLength($value, $max, $message = ''); /** * @psalm-pure * - * @param null|string $value + * @param string|null $value * @param int|float $min * @param int|float $max * @param string $message @@ -1470,7 +1470,7 @@ public static function nullOrDirectory($value, $message = ''); public static function allDirectory($value, $message = ''); /** - * @param null|string $value + * @param string|null $value * @param string $message * * @throws InvalidArgumentException @@ -1486,7 +1486,7 @@ public static function nullOrReadable($value, $message = ''); public static function allReadable($value, $message = ''); /** - * @param null|string $value + * @param string|null $value * @param string $message * * @throws InvalidArgumentException @@ -1502,7 +1502,7 @@ public static function nullOrWritable($value, $message = ''); public static function allWritable($value, $message = ''); /** - * @psalm-assert null|class-string $value + * @psalm-assert class-string|null $value * * @param mixed $value * @param string $message @@ -1525,7 +1525,7 @@ public static function allClassExists($value, $message = ''); * @psalm-pure * @psalm-template ExpectedType of object * @psalm-param class-string $class - * @psalm-assert null|class-string|ExpectedType $value + * @psalm-assert class-string|ExpectedType|null $value * * @param mixed $value * @param string|object $class @@ -1550,7 +1550,7 @@ public static function nullOrSubclassOf($value, $class, $message = ''); public static function allSubclassOf($value, $class, $message = ''); /** - * @psalm-assert null|class-string $value + * @psalm-assert class-string|null $value * * @param mixed $value * @param string $message @@ -1573,7 +1573,7 @@ public static function allInterfaceExists($value, $message = ''); * @psalm-pure * @psalm-template ExpectedType of object * @psalm-param class-string $interface - * @psalm-assert null|class-string $value + * @psalm-assert class-string|null $value * * @param mixed $value * @param mixed $interface @@ -1599,9 +1599,9 @@ public static function allImplementsInterface($value, $interface, $message = '') /** * @psalm-pure - * @psalm-param null|class-string|object $classOrObject + * @psalm-param class-string|object|null $classOrObject * - * @param null|string|object $classOrObject + * @param string|object|null $classOrObject * @param mixed $property * @param string $message * @@ -1623,9 +1623,9 @@ public static function allPropertyExists($classOrObject, $property, $message = ' /** * @psalm-pure - * @psalm-param null|class-string|object $classOrObject + * @psalm-param class-string|object|null $classOrObject * - * @param null|string|object $classOrObject + * @param string|object|null $classOrObject * @param mixed $property * @param string $message * @@ -1647,9 +1647,9 @@ public static function allPropertyNotExists($classOrObject, $property, $message /** * @psalm-pure - * @psalm-param null|class-string|object $classOrObject + * @psalm-param class-string|object|null $classOrObject * - * @param null|string|object $classOrObject + * @param string|object|null $classOrObject * @param mixed $method * @param string $message * @@ -1671,9 +1671,9 @@ public static function allMethodExists($classOrObject, $method, $message = ''); /** * @psalm-pure - * @psalm-param null|class-string|object $classOrObject + * @psalm-param class-string|object|null $classOrObject * - * @param null|string|object $classOrObject + * @param string|object|null $classOrObject * @param mixed $method * @param string $message * @@ -1696,7 +1696,7 @@ public static function allMethodNotExists($classOrObject, $method, $message = '' /** * @psalm-pure * - * @param null|array $array + * @param array|null $array * @param string|int $key * @param string $message * @@ -1718,7 +1718,7 @@ public static function allKeyExists($array, $key, $message = ''); /** * @psalm-pure * - * @param null|array $array + * @param array|null $array * @param string|int $key * @param string $message * @@ -1739,7 +1739,7 @@ public static function allKeyNotExists($array, $key, $message = ''); /** * @psalm-pure - * @psalm-assert null|array-key $value + * @psalm-assert array-key|null $value * * @param mixed $value * @param string $message @@ -1760,7 +1760,7 @@ public static function nullOrValidArrayKey($value, $message = ''); public static function allValidArrayKey($value, $message = ''); /** - * @param null|Countable|array $array + * @param Countable|array|null $array * @param int $number * @param string $message * @@ -1778,7 +1778,7 @@ public static function nullOrCount($array, $number, $message = ''); public static function allCount($array, $number, $message = ''); /** - * @param null|Countable|array $array + * @param Countable|array|null $array * @param int|float $min * @param string $message * @@ -1796,7 +1796,7 @@ public static function nullOrMinCount($array, $min, $message = ''); public static function allMinCount($array, $min, $message = ''); /** - * @param null|Countable|array $array + * @param Countable|array|null $array * @param int|float $max * @param string $message * @@ -1814,7 +1814,7 @@ public static function nullOrMaxCount($array, $max, $message = ''); public static function allMaxCount($array, $max, $message = ''); /** - * @param null|Countable|array $array + * @param Countable|array|null $array * @param int|float $min * @param int|float $max * @param string $message @@ -1835,7 +1835,7 @@ public static function allCountBetween($array, $min, $max, $message = ''); /** * @psalm-pure - * @psalm-assert null|list $array + * @psalm-assert list|null $array * * @param mixed $array * @param string $message @@ -1857,7 +1857,7 @@ public static function allIsList($array, $message = ''); /** * @psalm-pure - * @psalm-assert null|non-empty-list $array + * @psalm-assert non-empty-list|null $array * * @param mixed $array * @param string $message @@ -1880,8 +1880,8 @@ public static function allIsNonEmptyList($array, $message = ''); /** * @psalm-pure * @psalm-template T - * @psalm-param null|mixed|array $array - * @psalm-assert null|array $array + * @psalm-param mixed|array|null $array + * @psalm-assert array|null $array * * @param mixed $array * @param string $message @@ -1906,7 +1906,7 @@ public static function allIsMap($array, $message = ''); /** * @psalm-pure * @psalm-template T - * @psalm-param null|mixed|array $array + * @psalm-param mixed|array|null $array * * @param mixed $array * @param string $message @@ -1930,7 +1930,7 @@ public static function allIsNonEmptyMap($array, $message = ''); /** * @psalm-pure * - * @param null|string $value + * @param string|null $value * @param string $message * * @throws InvalidArgumentException @@ -1950,7 +1950,7 @@ public static function allUuid($value, $message = ''); /** * @psalm-param class-string $class * - * @param null|Closure $expression + * @param Closure|null $expression * @param string $class * @param string $message * From ac13163384632e0e37757a57f3af2a30d05840ac Mon Sep 17 00:00:00 2001 From: Andrii Dembitskyi Date: Sun, 1 Nov 2020 20:43:05 +0200 Subject: [PATCH 2/2] Suppress extra CS rules (inherited from Symfony preset) --- .styleci.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.styleci.yml b/.styleci.yml index 71c5c5e5..c06c0d74 100644 --- a/.styleci.yml +++ b/.styleci.yml @@ -9,3 +9,5 @@ enabled: disabled: - phpdoc_annotation_without_dot # This is still buggy: https://github.com/symfony/symfony/pull/19198 + - short_array_syntax # Support PHP 5 + - no_superfluous_phpdoc_tags_symfony # All params/return tags should be preserved