chore: update return type of FixerOptionInterface::getAllowedValues (#8530)

kubawerlos · web-flow · commit b0c0160f2b6f · 2025-03-22T20:40:27.000+01:00
diff --git a/src/FixerConfiguration/AliasedFixerOptionBuilder.php b/src/FixerConfiguration/AliasedFixerOptionBuilder.php
@@ -52,7 +52,7 @@ public function setAllowedTypes(array $allowedTypes): self
     }
 
     /**
-     * @param list<null|(callable(mixed): bool)|scalar> $allowedValues
+     * @param non-empty-list<null|(callable(mixed): bool)|scalar> $allowedValues
      */
     public function setAllowedValues(array $allowedValues): self
     {
diff --git a/src/FixerConfiguration/FixerOption.php b/src/FixerConfiguration/FixerOption.php
@@ -36,16 +36,16 @@ final class FixerOption implements FixerOptionInterface
     private ?array $allowedTypes;
 
     /**
-     * @var null|list<null|(callable(mixed): bool)|scalar>
+     * @var null|non-empty-list<null|(callable(mixed): bool)|scalar>
      */
     private ?array $allowedValues;
 
     private ?\Closure $normalizer;
 
     /**
-     * @param mixed                                          $default
-     * @param null|list<string>                              $allowedTypes
-     * @param null|list<null|(callable(mixed): bool)|scalar> $allowedValues
+     * @param mixed                                                    $default
+     * @param null|list<string>                                        $allowedTypes
+     * @param null|non-empty-list<null|(callable(mixed): bool)|scalar> $allowedValues
      */
     public function __construct(
         string $name,
diff --git a/src/FixerConfiguration/FixerOptionBuilder.php b/src/FixerConfiguration/FixerOptionBuilder.php
@@ -33,7 +33,7 @@ final class FixerOptionBuilder
     private ?array $allowedTypes = null;
 
     /**
-     * @var null|list<null|(callable(mixed): bool)|scalar>
+     * @var null|non-empty-list<null|(callable(mixed): bool)|scalar>
      */
     private ?array $allowedValues = null;
 
@@ -74,7 +74,7 @@ public function setAllowedTypes(array $allowedTypes): self
     }
 
     /**
-     * @param list<null|(callable(mixed): bool)|scalar> $allowedValues
+     * @param non-empty-list<null|(callable(mixed): bool)|scalar> $allowedValues
      *
      * @return $this
      */
diff --git a/src/FixerConfiguration/FixerOptionInterface.php b/src/FixerConfiguration/FixerOptionInterface.php
@@ -35,7 +35,7 @@ public function getDefault();
     public function getAllowedTypes(): ?array;
 
     /**
-     * @return null|list<null|(callable(mixed): bool)|scalar>
+     * @return null|non-empty-list<null|(callable(mixed): bool)|scalar>
      */
     public function getAllowedValues(): ?array;
 
diff --git a/tests/Console/Command/HelpCommandTest.php b/tests/Console/Command/HelpCommandTest.php
@@ -38,7 +38,7 @@ public function testGetDisplayableAllowedValues($expected, FixerOptionInterface
 
     public static function provideGetDisplayableAllowedValuesCases(): iterable
     {
-        yield [null, new FixerOption('foo', 'bar', false, null, ['int'], [])];
+        yield [null, new FixerOption('foo', 'bar', false, null, ['int'])];
 
         yield [['A', 'B', 'x', 'z'], new FixerOption('foo', 'bar', false, null, ['string'], ['z', 'x', 'B', 'A'])];
 
diff --git a/tests/FixerConfiguration/AliasedFixerOptionTest.php b/tests/FixerConfiguration/AliasedFixerOptionTest.php
@@ -142,7 +142,7 @@ public static function provideGetAllowedTypesCases(): iterable
     }
 
     /**
-     * @param null|list<null|(callable(mixed): bool)|scalar> $allowedValues
+     * @param null|non-empty-list<null|(callable(mixed): bool)|scalar> $allowedValues
      *
      * @dataProvider provideGetAllowedValuesCases
      */
diff --git a/tests/RuleSet/RuleSetsTest.php b/tests/RuleSet/RuleSetsTest.php
@@ -196,7 +196,7 @@ private static function assertPHPUnitVersionIsLargestAllowed(string $setName, st
 
         foreach ($fixer->getConfigurationDefinition()->getOptions() as $option) {
             if ('target' === $option->getName()) {
-                /** @var list<PhpUnitTargetVersion::VERSION_*> */
+                /** @var non-empty-list<PhpUnitTargetVersion::VERSION_*> */
                 $allowedValues = $option->getAllowedValues();
 
                 $allowedVersionsForFixer = array_diff(

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ public function setAllowedTypes(array $allowedTypes): self`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`/**`
`55`		`- * @param list<null\|(callable(mixed): bool)\|scalar> $allowedValues`
	`55`	`+ * @param non-empty-list<null\|(callable(mixed): bool)\|scalar> $allowedValues`
`56`	`56`	`*/`
`57`	`57`	`public function setAllowedValues(array $allowedValues): self`
`58`	`58`	`{`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ final class FixerOptionBuilder`
`33`	`33`	`private ?array $allowedTypes = null;`
`34`	`34`
`35`	`35`	`/**`
`36`		`- * @var null\|list<null\|(callable(mixed): bool)\|scalar>`
	`36`	`+ * @var null\|non-empty-list<null\|(callable(mixed): bool)\|scalar>`
`37`	`37`	`*/`
`38`	`38`	`private ?array $allowedValues = null;`
`39`	`39`
`@@ -74,7 +74,7 @@ public function setAllowedTypes(array $allowedTypes): self`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`/**`
`77`		`- * @param list<null\|(callable(mixed): bool)\|scalar> $allowedValues`
	`77`	`+ * @param non-empty-list<null\|(callable(mixed): bool)\|scalar> $allowedValues`
`78`	`78`	`*`
`79`	`79`	`* @return $this`
`80`	`80`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ public function testGetDisplayableAllowedValues($expected, FixerOptionInterface`
`38`	`38`
`39`	`39`	`public static function provideGetDisplayableAllowedValuesCases(): iterable`
`40`	`40`	`{`
`41`		`- yield [null, new FixerOption('foo', 'bar', false, null, ['int'], [])];`
	`41`	`+ yield [null, new FixerOption('foo', 'bar', false, null, ['int'])];`
`42`	`42`
`43`	`43`	`yield [['A', 'B', 'x', 'z'], new FixerOption('foo', 'bar', false, null, ['string'], ['z', 'x', 'B', 'A'])];`
`44`	`44`
Original file line number	Diff line number	Diff line change
`@@ -142,7 +142,7 @@ public static function provideGetAllowedTypesCases(): iterable`
`142`	`142`	`}`
`143`	`143`
`144`	`144`	`/**`
`145`		`- * @param null\|list<null\|(callable(mixed): bool)\|scalar> $allowedValues`
	`145`	`+ * @param null\|non-empty-list<null\|(callable(mixed): bool)\|scalar> $allowedValues`
`146`	`146`	`*`
`147`	`147`	`* @dataProvider provideGetAllowedValuesCases`
`148`	`148`	`*/`