chore: list over array in more places (#7876)

PHP-CS-Fixer · Mar 11, 2024 · ffce76b · ffce76b
1 parent 14a5ed1
commit ffce76b
Show file tree

Hide file tree

Showing 18 changed files with 28 additions and 30 deletions.
diff --git a/src/Fixer/AbstractPhpUnitFixer.php b/src/Fixer/AbstractPhpUnitFixer.php
@@ -68,7 +68,7 @@ final protected function getDocBlockIndex(Tokens $tokens, int $index): int
     }
 
     /**
-     * @param array<string> $preventingAnnotations
+     * @param list<string> $preventingAnnotations
      */
     final protected function ensureIsDockBlockWithAnnotation(
         Tokens $tokens,
@@ -115,7 +115,7 @@ private function createDocBlock(Tokens $tokens, int $docBlockIndex, string $anno
     }
 
     /**
-     * @param array<string> $preventingAnnotations
+     * @param list<string> $preventingAnnotations
      */
     private function updateDocBlockIfNeeded(
         Tokens $tokens,
@@ -137,7 +137,7 @@ private function updateDocBlockIfNeeded(
     }
 
     /**
-     * @return array<Line>
+     * @return list<Line>
      */
     private function addInternalAnnotation(DocBlock $docBlock, Tokens $tokens, int $docBlockIndex, string $annotation): array
     {

diff --git a/src/Fixer/Alias/PowToExponentiationFixer.php b/src/Fixer/Alias/PowToExponentiationFixer.php
@@ -97,7 +97,7 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
     }
 
     /**
-     * @return array<int[]>
+     * @return list<array{int, int, int}>
      */
     private function findPowCalls(Tokens $tokens): array
     {

diff --git a/src/Fixer/ArrayNotation/YieldFromArrayToYieldsFixer.php b/src/Fixer/ArrayNotation/YieldFromArrayToYieldsFixer.php
@@ -118,7 +118,7 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
     }
 
     /**
-     * @return iterable<int, array<int>>
+     * @return iterable<int, array{int, int}>
      */
     private function getYieldsFromToUnpack(Tokens $tokens): iterable
     {

diff --git a/src/Fixer/Casing/MagicConstantCasingFixer.php b/src/Fixer/Casing/MagicConstantCasingFixer.php
@@ -77,7 +77,7 @@ private function getMagicConstants(): array
     }
 
     /**
-     * @return array<int>
+     * @return list<int>
      */
     private function getMagicConstantTokens(): array
     {

diff --git a/src/Fixer/ClassNotation/NoPhp4ConstructorFixer.php b/src/Fixer/ClassNotation/NoPhp4ConstructorFixer.php
@@ -290,7 +290,7 @@ private function fixInfiniteRecursion(Tokens $tokens, int $start, int $end): voi
      * @param int    $startIndex function/method start index
      * @param int    $bodyIndex  function/method body index
      *
-     * @return array{array<array<array{int, string}|int|string>>, array{3: false}}
+     * @return array{list<list<array{int, string}|int|string>>, array{3: false}}
      */
     private function getWrapperMethodSequence(Tokens $tokens, string $method, int $startIndex, int $bodyIndex): array
     {

diff --git a/src/Fixer/ClassNotation/OrderedClassElementsFixer.php b/src/Fixer/ClassNotation/OrderedClassElementsFixer.php
@@ -410,7 +410,7 @@ private function getElements(Tokens $tokens, int $startIndex): array
     }
 
     /**
-     * @return array<string>|string type or array of type and name
+     * @return list<string>|string type or array of type and name
      */
     private function detectElementType(Tokens $tokens, int $index)
     {

diff --git a/src/Fixer/ClassNotation/OrderedTypesFixer.php b/src/Fixer/ClassNotation/OrderedTypesFixer.php
@@ -304,7 +304,7 @@ private function isTypeSortable(TypeAnalysis $type): bool
     }
 
     /**
-     * @return array{0: array<string|string[]>, 1: string}
+     * @return array{0: list<string|string[]>, 1: string}
      */
     private function collectDisjunctiveNormalFormTypes(string $type): array
     {
@@ -336,9 +336,9 @@ private function collectUnionOrIntersectionTypes(string $type): array
     }
 
     /**
-     * @param array<string|string[]> $types
+     * @param list<string|string[]> $types
      *
-     * @return array<string|string[]>
+     * @return list<string|string[]>
      */
     private function runTypesThroughSortingAlgorithm(array $types): array
     {

diff --git a/src/Fixer/ControlStructure/NoBreakCommentFixer.php b/src/Fixer/ControlStructure/NoBreakCommentFixer.php
@@ -335,7 +335,7 @@ private function getStructureEnd(Tokens $tokens, int $position): int
     }
 
     /**
-     * @return array<int>
+     * @return list<int>
      */
     private static function getParenthesisedStructureKinds(): array
     {

diff --git a/src/Fixer/DoctrineAnnotation/DoctrineAnnotationIndentationFixer.php b/src/Fixer/DoctrineAnnotation/DoctrineAnnotationIndentationFixer.php
@@ -157,7 +157,7 @@ private function isClosingLineWithMeaningfulContent(Tokens $tokens, int $index):
     }
 
     /**
-     * @param array<array<int>> $annotationPositions Pairs of begin and end indices of main annotations
+     * @param list<array{int, int}> $annotationPositions Pairs of begin and end indices of main annotations
      */
     private function indentationCanBeFixed(Tokens $tokens, int $newLineTokenIndex, array $annotationPositions): bool
     {

diff --git a/src/Fixer/FunctionNotation/CombineNestedDirnameFixer.php b/src/Fixer/FunctionNotation/CombineNestedDirnameFixer.php
@@ -189,7 +189,7 @@ private function getDirnameInfo(Tokens $tokens, int $index, ?int $firstArgumentE
     }
 
     /**
-     * @param array<array{indices: list<int>, secondArgument?: int, levels: int, end: int}> $dirnameInfoArray
+     * @param list<array{indices: list<int>, secondArgument?: int, levels: int, end: int}> $dirnameInfoArray
      */
     private function combineDirnames(Tokens $tokens, array $dirnameInfoArray): void
     {

diff --git a/src/Fixer/FunctionNotation/NoSpacesAfterFunctionNameFixer.php b/src/Fixer/FunctionNotation/NoSpacesAfterFunctionNameFixer.php
@@ -116,18 +116,16 @@ private function fixFunctionCall(Tokens $tokens, int $index): void
     }
 
     /**
-     * @return array<list<int>|string>
+     * @return list<array{int}|string>
      */
     private function getBraceAfterVariableKinds(): array
     {
-        static $tokens = [
+        return [
             ')',
             ']',
             [CT::T_DYNAMIC_VAR_BRACE_CLOSE],
             [CT::T_ARRAY_INDEX_CURLY_BRACE_CLOSE],
         ];
-
-        return $tokens;
     }
 
     /**

diff --git a/src/Fixer/LanguageConstruct/NoUnsetOnPropertyFixer.php b/src/Fixer/LanguageConstruct/NoUnsetOnPropertyFixer.php
@@ -84,7 +84,7 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
     }
 
     /**
-     * @return array<array<string, bool|int>>
+     * @return list<array<string, bool|int>>
      */
     private function getUnsetsInfo(Tokens $tokens, int $index): array
     {
@@ -144,7 +144,7 @@ private function isProperty(Tokens $tokens, int $index, int $endIndex): bool
     }
 
     /**
-     * @param array<array<string, bool|int>> $unsetsInfo
+     * @param list<array<string, bool|int>> $unsetsInfo
      */
     private function isAnyUnsetToTransform(array $unsetsInfo): bool
     {

diff --git a/src/Fixer/Operator/BinaryOperatorSpacesFixer.php b/src/Fixer/Operator/BinaryOperatorSpacesFixer.php
@@ -150,7 +150,7 @@ final class BinaryOperatorSpacesFixer extends AbstractFixer implements Configura
     private int $currentLevel;
 
     /**
-     * @var array<null|string>
+     * @var list<null|string>
      */
     private static array $allowedValues = [
         self::ALIGN,

diff --git a/src/Fixer/Operator/OperatorLinebreakFixer.php b/src/Fixer/Operator/OperatorLinebreakFixer.php
@@ -40,7 +40,7 @@ final class OperatorLinebreakFixer extends AbstractFixer implements Configurable
     private string $position = 'beginning';
 
     /**
-     * @var array<array<int|string>|string>
+     * @var list<list<int|string>|string>
      */
     private array $operators = [];
 

diff --git a/tests/Console/ConfigurationResolverTest.php b/tests/Console/ConfigurationResolverTest.php
@@ -339,7 +339,7 @@ public static function provideResolvePathCases(): iterable
     }
 
     /**
-     * @param array<string> $paths
+     * @param list<string> $paths
      *
      * @dataProvider provideRejectInvalidPathCases
      */
@@ -1284,7 +1284,7 @@ public static function provideDeprecatedFixerConfiguredCases(): iterable
      *
      * @group legacy
      *
-     * @param array<string> $successors
+     * @param list<string> $successors
      */
     public function testDeprecatedRuleSetConfigured(string $ruleSet, array $successors): void
     {

diff --git a/tests/Tokenizer/Analyzer/FunctionsAnalyzerTest.php b/tests/Tokenizer/Analyzer/FunctionsAnalyzerTest.php
@@ -40,7 +40,7 @@ public function testIsGlobalFunctionCall(string $code, array $indices): void
     }
 
     /**
-     * @return iterable<array{string, array<int>}>
+     * @return iterable<array{string, list<int>}>
      */
     public static function provideIsGlobalFunctionCallCases(): iterable
     {
@@ -284,7 +284,7 @@ public function testIsGlobalFunctionCallPre80(string $code, array $indices): voi
     }
 
     /**
-     * @return iterable<array{string, array<int>}>
+     * @return iterable<array{string, list<int>}>
      */
     public static function provideIsGlobalFunctionCallPre80Cases(): iterable
     {

diff --git a/tests/Tokenizer/Analyzer/GotoLabelAnalyzerTest.php b/tests/Tokenizer/Analyzer/GotoLabelAnalyzerTest.php
@@ -44,7 +44,7 @@ public function testGotoLabel(string $source, array $expectedTrue): void
     }
 
     /**
-     * @return iterable<array{string, array<int>}>
+     * @return iterable<array{string, list<int>}>
      */
     public static function provideGotoLabelCases(): iterable
     {
@@ -124,7 +124,7 @@ public function testGotoLabel80(string $source, array $expectedTrue): void
     }
 
     /**
-     * @return iterable<array{string, array<int>}>
+     * @return iterable<array{string, list<int>}>
      */
     public static function provideGotoLabel80Cases(): iterable
     {

diff --git a/tests/Tokenizer/Analyzer/SwitchAnalyzerTest.php b/tests/Tokenizer/Analyzer/SwitchAnalyzerTest.php
@@ -26,7 +26,7 @@
 final class SwitchAnalyzerTest extends TestCase
 {
     /**
-     * @param array<int> $indices
+     * @param list<int> $indices
      *
      * @dataProvider provideColonCases
      */
@@ -44,7 +44,7 @@ public function testColon(string $code, array $indices): void
     }
 
     /**
-     * @return iterable<array{string, array<int>}>
+     * @return iterable<array{string, list<int>}>
      */
     public static function provideColonCases(): iterable
     {