Types array/list cleanup (#936)

kubawerlos · Dec 29, 2023 · a06ef9e · a06ef9e
1 parent 1adfc79
commit a06ef9e
Show file tree

Hide file tree

Showing 45 changed files with 94 additions and 93 deletions.
diff --git a/.dev-tools/src/Fixer/OrderedClassElementsInternalFixer.php b/.dev-tools/src/Fixer/OrderedClassElementsInternalFixer.php
@@ -88,14 +88,14 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
             $index = $tokens->getNextTokenOfKind($index, ['{']);
             \assert(\is_int($index));
 
-            /** @var array<array<string>> $elements */
+            /** @var list<list<string>> $elements */
             $elements = $this->orderedClassElementsFixerWrapper->getElements($tokens, $index);
 
             if (\count($elements) === 0) {
                 continue;
             }
 
-            /** @var array<array<string>> $elements */
+            /** @var list<list<string>> $elements */
             $elements = $this->orderedClassElementsFixerWrapper->sortElements($elements);
             $sorted = $this->sortElements($elements);
 
@@ -111,15 +111,15 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
     }
 
     /**
-     * @param array<array<string>> $elements
+     * @param list<list<string>> $elements
      */
     private function sortElements(array $elements): array
     {
         \usort(
             $elements,
             /**
-             * @param array<string> $a
-             * @param array<string> $b
+             * @param array<string, string> $a
+             * @param array<string, string> $b
              */
             static function (array $a, array $b): int {
                 if (

diff --git a/.dev-tools/src/Fixer/PriorityInternalFixer.php b/.dev-tools/src/Fixer/PriorityInternalFixer.php
@@ -58,7 +58,7 @@ public function isRisky(): bool
 
     public function fix(\SplFileInfo $file, Tokens $tokens): void
     {
-        /** @var array<int> $indices */
+        /** @var list<int> $indices */
         $indices = $tokens->findSequence([[\T_CLASS]]);
 
         $classStartIndex = \key($indices);
@@ -74,7 +74,7 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
 
         $endIndex = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_CURLY_BRACE, $startIndex);
 
-        /** @var array<int> $indices */
+        /** @var list<int> $indices */
         $indices = $tokens->findSequence([[\T_PUBLIC], [\T_FUNCTION], [\T_STRING, 'getPriority']], $startIndex, $endIndex);
 
         $sequencesStartIndex = \key($indices);

diff --git a/.dev-tools/src/Priority/PriorityCollection.php b/.dev-tools/src/Priority/PriorityCollection.php
@@ -20,7 +20,7 @@
 
 final class PriorityCollection
 {
-    /** @var array<PriorityFixer> */
+    /** @var list<PriorityFixer> */
     private $priorityFixers = [];
 
     public static function create(): self

diff --git a/.dev-tools/src/Priority/PriorityFixer.php b/.dev-tools/src/Priority/PriorityFixer.php
@@ -18,10 +18,10 @@ final class PriorityFixer
     /** @var FixerInterface */
     private $fixer;
 
-    /** @var array<self> */
+    /** @var list<self> */
     private $fixersToRunAfter = [];
 
-    /** @var array<self> */
+    /** @var list<self> */
     private $fixersToRunBefore = [];
 
     /** @var null|int */
@@ -63,15 +63,15 @@ public function getPriority(): int
     }
 
     /**
-     * @return array<string>
+     * @return list<string>
      */
     public function getFixerToRunAfterNames(): array
     {
         return $this->getFixerNames($this->fixersToRunAfter);
     }
 
     /**
-     * @return array<string>
+     * @return list<string>
      */
     public function getFixerToRunBeforeNames(): array
     {
@@ -105,9 +105,9 @@ public function calculatePriority(bool $requireAllRelationHavePriority): bool
     }
 
     /**
-     * @param array<self> $priorityFixers
+     * @param list<self> $priorityFixers
      *
-     * @return array<string>
+     * @return list<string>
      */
     private function getFixerNames(array $priorityFixers): array
     {

diff --git a/.dev-tools/src/Readme/ReadmeCommand.php b/.dev-tools/src/Readme/ReadmeCommand.php
@@ -215,7 +215,7 @@ private function fixers(): string
                     if ($option->getAllowedValues() !== null) {
                         $allowed = \array_map(static fn (string $value): string => \sprintf('\'%s\'', $value), $option->getAllowedValues());
                     } else {
-                        /** @var array<string> $allowed */
+                        /** @var list<string> $allowed */
                         $allowed = $option->getAllowedTypes();
                     }
                     $output .= \sprintf(

diff --git a/src/Analyzer/Analysis/ConstructorAnalysis.php b/src/Analyzer/Analysis/ConstructorAnalysis.php
@@ -37,7 +37,7 @@ public function getConstructorIndex(): int
     }
 
     /**
-     * @return array<string>
+     * @return list<string>
      */
     public function getConstructorParameterNames(): array
     {
@@ -183,7 +183,7 @@ private function getPropertyIndex(int $index, int $openBrace): ?int
     /**
      * @param array<int, string> $array
      *
-     * @return array<int>
+     * @return array<int, int>
      */
     private function getDuplicatesIndices(array $array): array
     {

diff --git a/src/Analyzer/Analysis/DataProviderAnalysis.php b/src/Analyzer/Analysis/DataProviderAnalysis.php
@@ -22,11 +22,11 @@ final class DataProviderAnalysis
     /** @var int */
     private $nameIndex;
 
-    /** @var array<int> */
+    /** @var list<int> */
     private $usageIndices;
 
     /**
-     * @param array<int> $usageIndices
+     * @param list<int> $usageIndices
      */
     public function __construct(string $name, int $nameIndex, array $usageIndices)
     {
@@ -46,7 +46,7 @@ public function getNameIndex(): int
     }
 
     /**
-     * @return array<int>
+     * @return list<int>
      */
     public function getUsageIndices(): array
     {

diff --git a/src/Analyzer/Analysis/SwitchAnalysis.php b/src/Analyzer/Analysis/SwitchAnalysis.php
@@ -22,11 +22,11 @@ final class SwitchAnalysis
     /** @var int */
     private $casesEnd;
 
-    /** @var array<CaseAnalysis> */
+    /** @var list<CaseAnalysis> */
     private $cases = [];
 
     /**
-     * @param array<CaseAnalysis> $cases
+     * @param list<CaseAnalysis> $cases
      */
     public function __construct(int $casesStart, int $casesEnd, array $cases)
     {
@@ -46,7 +46,7 @@ public function getCasesEnd(): int
     }
 
     /**
-     * @return array<CaseAnalysis>
+     * @return list<CaseAnalysis>
      */
     public function getCases(): array
     {

diff --git a/src/Analyzer/ArrayAnalyzer.php b/src/Analyzer/ArrayAnalyzer.php
@@ -21,7 +21,7 @@
 final class ArrayAnalyzer
 {
     /**
-     * @return array<ArrayElementAnalysis>
+     * @return list<ArrayElementAnalysis>
      */
     public function getElements(Tokens $tokens, int $index): array
     {
@@ -52,7 +52,7 @@ public function getElements(Tokens $tokens, int $index): array
     }
 
     /**
-     * @return array<ArrayElementAnalysis>
+     * @return list<ArrayElementAnalysis>
      */
     private function getElementsForArrayContent(Tokens $tokens, int $startIndex, int $endIndex): array
     {

diff --git a/src/Analyzer/DataProviderAnalyzer.php b/src/Analyzer/DataProviderAnalyzer.php
@@ -21,7 +21,7 @@
 final class DataProviderAnalyzer
 {
     /**
-     * @return array<DataProviderAnalysis>
+     * @return list<DataProviderAnalysis>
      */
     public function getDataProviders(Tokens $tokens, int $startIndex, int $endIndex): array
     {
@@ -42,7 +42,7 @@ public function getDataProviders(Tokens $tokens, int $startIndex, int $endIndex)
 
             Preg::matchAll('/@dataProvider\s+([a-zA-Z0-9._:-\\\\x7f-\xff]+)/', $tokens[$docCommentIndex]->getContent(), $matches);
 
-            /** @var array<string> $matches */
+            /** @var list<string> $matches */
             $matches = $matches[1];
 
             foreach ($matches as $dataProviderName) {

diff --git a/src/Analyzer/FunctionAnalyzer.php b/src/Analyzer/FunctionAnalyzer.php
@@ -20,7 +20,7 @@
 final class FunctionAnalyzer
 {
     /**
-     * @return array<ArgumentAnalysis>
+     * @return list<ArgumentAnalysis>
      */
     public static function getFunctionArguments(Tokens $tokens, int $index): array
     {

diff --git a/src/Fixer/CommentedOutFunctionFixer.php b/src/Fixer/CommentedOutFunctionFixer.php
@@ -26,7 +26,7 @@
 
 final class CommentedOutFunctionFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
-    /** @var array<string> */
+    /** @var list<string> */
     private $functions = ['print_r', 'var_dump', 'var_export'];
 
     public function getDefinition(): FixerDefinitionInterface
@@ -52,7 +52,7 @@ public function getConfigurationDefinition(): FixerConfigurationResolverInterfac
     }
 
     /**
-     * @param array<string, array<string>> $configuration
+     * @param array<string, list<string>> $configuration
      */
     public function configure(array $configuration): void
     {

diff --git a/src/Fixer/DataProviderNameFixer.php b/src/Fixer/DataProviderNameFixer.php
@@ -105,7 +105,7 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
     }
 
     /**
-     * @return array<string>
+     * @return list<string>
      */
     public function getSuccessorsNames(): array
     {

diff --git a/src/Fixer/DataProviderReturnTypeFixer.php b/src/Fixer/DataProviderReturnTypeFixer.php
@@ -76,7 +76,7 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
     }
 
     /**
-     * @return array<string>
+     * @return list<string>
      */
     public function getSuccessorsNames(): array
     {

diff --git a/src/Fixer/DataProviderStaticFixer.php b/src/Fixer/DataProviderStaticFixer.php
@@ -99,7 +99,7 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
     }
 
     /**
-     * @return array<string>
+     * @return list<string>
      */
     public function getSuccessorsNames(): array
     {

diff --git a/src/Fixer/InternalClassCasingFixer.php b/src/Fixer/InternalClassCasingFixer.php
@@ -61,7 +61,7 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
     }
 
     /**
-     * @return array<string>
+     * @return list<string>
      */
     public function getSuccessorsNames(): array
     {

diff --git a/src/Fixer/NoCommentedOutCodeFixer.php b/src/Fixer/NoCommentedOutCodeFixer.php
@@ -63,7 +63,6 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
             if (\strpos($tokens[$index]->getContent(), '/*') === 0) {
                 $commentIndices = [$index];
             } else {
-                /** @var array<int> $commentIndices */
                 $commentIndices = $commentsAnalyzer->getCommentBlockIndices($tokens, $index);
             }
 
@@ -82,9 +81,9 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
     }
 
     /**
-     * @param array<int> $commentIndices
+     * @param list<int> $commentIndices
      *
-     * @return array<int>
+     * @return list<int>
      */
     private function getIndicesToRemove(Tokens $tokens, array $commentIndices): array
     {

diff --git a/src/Fixer/NoImportFromGlobalNamespaceFixer.php b/src/Fixer/NoImportFromGlobalNamespaceFixer.php
@@ -90,9 +90,9 @@ private function fixImports(Tokens $tokens, int $startIndex, int $endIndex, bool
     }
 
     /**
-     * @param array<string> $imports
+     * @param list<string> $imports
      *
-     * @return array<string>
+     * @return list<string>
      */
     private function removeImportFromGlobalNamespace(Tokens $tokens, array $imports, int $index): array
     {
@@ -117,7 +117,7 @@ private function removeImportFromGlobalNamespace(Tokens $tokens, array $imports,
     }
 
     /**
-     * @param array<string> $imports
+     * @param list<string> $imports
      */
     private function updateComment(Tokens $tokens, array $imports, int $index): void
     {
@@ -133,7 +133,7 @@ private function updateComment(Tokens $tokens, array $imports, int $index): void
     }
 
     /**
-     * @param array<string> $imports
+     * @param list<string> $imports
      */
     private function updateUsage(Tokens $tokens, array $imports, int $index): void
     {

diff --git a/src/Fixer/NoReferenceInFunctionDefinitionFixer.php b/src/Fixer/NoReferenceInFunctionDefinitionFixer.php
@@ -64,7 +64,7 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
     }
 
     /**
-     * @return array<int>
+     * @return list<int>
      */
     private function getArgumentStartIndices(Tokens $tokens, int $functionNameIndex): array
     {

diff --git a/src/Fixer/PhpUnitAssertArgumentsOrderFixer.php b/src/Fixer/PhpUnitAssertArgumentsOrderFixer.php
@@ -78,7 +78,7 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
     {
         $phpUnitTestCaseIndicator = new PhpUnitTestCaseIndicator();
 
-        /** @var array<int> $indexes */
+        /** @var list<int> $indexes */
         foreach ($phpUnitTestCaseIndicator->findPhpUnitClasses($tokens) as $indexes) {
             $this->fixArgumentsOrder($tokens, $indexes[0], $indexes[1]);
         }
@@ -135,7 +135,7 @@ private static function getNewAssertion(Tokens $tokens, int $index): ?string
     }
 
     /**
-     * @param array<ArgumentAnalysis> $arguments
+     * @param list<ArgumentAnalysis> $arguments
      */
     private static function shouldArgumentsBeSwapped(array $arguments): bool
     {
@@ -151,7 +151,7 @@ private static function shouldArgumentsBeSwapped(array $arguments): bool
     }
 
     /**
-     * @param array<ArgumentAnalysis> $arguments
+     * @param list<ArgumentAnalysis> $arguments
      */
     private static function swapArguments(Tokens $tokens, array $arguments): void
     {

diff --git a/src/Fixer/PhpUnitDedicatedAssertFixer.php b/src/Fixer/PhpUnitDedicatedAssertFixer.php
@@ -84,7 +84,7 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
     {
         $phpUnitTestCaseIndicator = new PhpUnitTestCaseIndicator();
 
-        /** @var array<int> $indexes */
+        /** @var list<int> $indexes */
         foreach ($phpUnitTestCaseIndicator->findPhpUnitClasses($tokens) as $indexes) {
             $this->fixAssertions($tokens, $indexes[0], $indexes[1]);
         }

diff --git a/src/Fixer/PhpUnitNoUselessReturnFixer.php b/src/Fixer/PhpUnitNoUselessReturnFixer.php
@@ -69,7 +69,7 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
     {
         $phpUnitTestCaseIndicator = new PhpUnitTestCaseIndicator();
 
-        /** @var array<int> $indexes */
+        /** @var list<int> $indexes */
         foreach ($phpUnitTestCaseIndicator->findPhpUnitClasses($tokens) as $indexes) {
             $this->removeUselessReturns($tokens, $indexes[0], $indexes[1]);
         }

diff --git a/src/Fixer/PhpdocNoIncorrectVarAnnotationFixer.php b/src/Fixer/PhpdocNoIncorrectVarAnnotationFixer.php
@@ -113,7 +113,7 @@ private function removeForClassElement(Tokens $tokens, int $index, int $property
     }
 
     /**
-     * @param array<string> $allowedVariables
+     * @param list<string> $allowedVariables
      */
     private function removeVarAnnotation(Tokens $tokens, int $index, array $allowedVariables): void
     {