Add PhpdocArrayStyleFixer (#421)

Author: kubawerlos

CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG for PHP CS Fixer: custom fixers
 
+## v3.1.0
+- Add PhpdocArrayStyleFixer
+
 ## v3.0.0
 - Drop support for PHP CS Fixer v2
 - Add StringableInterfaceFixer

README.md

@@ -3,7 +3,7 @@
 [![Latest stable version](https://img.shields.io/packagist/v/kubawerlos/php-cs-fixer-custom-fixers.svg?label=current%20version)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 [![PHP version](https://img.shields.io/packagist/php-v/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://php.net)
 [![License](https://img.shields.io/github/license/kubawerlos/php-cs-fixer-custom-fixers.svg)](LICENSE)
-![Tests](https://img.shields.io/badge/tests-2684-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-2716-brightgreen.svg)
 [![Downloads](https://img.shields.io/packagist/dt/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 
 [![CI Status](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/workflows/CI/badge.svg?branch=main&event=push)](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/actions)
@@ -326,6 +326,17 @@ PHPUnit `fail`, `markTestIncomplete` and `markTestSkipped` functions should not
  }
 ```
 
+#### PhpdocArrayStyleFixer
+Generic array style should be used in PHPDoc.
+```diff
+ <?php
+ /**
+- * @return int[]
++ * @return array<int>
+ */
+ function foo() { return [1, 2]; }
+```
+
 #### PhpdocNoIncorrectVarAnnotationFixer
 The `@var` annotations must be used correctly in code.
 ```diff

dev-tools/src/Fixer/OrderedClassElementsInternalFixer.php

@@ -97,8 +97,8 @@ function usort(array &$elements): void
  \usort(
  $elements,
  /**
- * @param string[] $a
- * @param string[] $b
+ * @param array<string> $a
+ * @param array<string> $b
  */
  static function (array $a, array $b): int {
  if (

dev-tools/src/Fixer/PriorityInternalFixer.php

@@ -58,7 +58,7 @@ public function isRisky(): bool
 
  public function fix(\SplFileInfo $file, Tokens $tokens): void
  {
- /** @var int[] $indices */
+ /** @var array<int> $indices */
  $indices = $tokens->findSequence([[\T_EXTENDS], [\T_STRING, 'AbstractFixer']]);
 
  /** @var int $sequencesStartIndex */
@@ -77,7 +77,7 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
 
  $endIndex = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_CURLY_BRACE, $startIndex);
 
- /** @var int[] $indices */
+ /** @var array<int> $indices */
  $indices = $tokens->findSequence([[\T_PUBLIC], [\T_FUNCTION], [\T_STRING, 'getPriority']], $startIndex, $endIndex);
 
  /** @var int $sequencesStartIndex */

dev-tools/src/Priority/PriorityCollection.php

@@ -20,7 +20,7 @@
 
 final class PriorityCollection
 {
- /** @var PriorityFixer[] */
+ /** @var array<PriorityFixer> */
  private $priorityFixers = [];
 
  public static function create(): self

dev-tools/src/Priority/PriorityFixer.php

@@ -20,10 +20,10 @@ final class PriorityFixer
  /** @var FixerInterface */
  private $fixer;
 
- /** @var self[] */
+ /** @var array<self> */
  private $fixersToRunAfter = [];
 
- /** @var self[] */
+ /** @var array<self> */
  private $fixersToRunBefore = [];
 
  /** @var null|int */
@@ -60,25 +60,25 @@ public function getPriority(): int
  }
 
  /**
- * @return string[]
+ * @return array<string>
  */
  public function getFixerToRunAfterNames(): array
  {
  return $this->getFixerNames($this->fixersToRunAfter);
  }
 
  /**
- * @return string[]
+ * @return array<string>
  */
  public function getFixerToRunBeforeNames(): array
  {
  return $this->getFixerNames($this->fixersToRunBefore);
  }
 
  /**
- * @param self[] $priorityFixers
+ * @param array<self> $priorityFixers
  *
- * @return string[]
+ * @return array<string>
  */
  private function getFixerNames(array $priorityFixers): array
  {

dev-tools/src/Readme/ReadmeCommand.php

@@ -199,7 +199,7 @@ private function fixers(): string
  return \sprintf('\'%s\'', $value);
  }, $option->getAllowedValues());
  } else {
- /** @var string[] $allowed */
+ /** @var array<string> $allowed */
  $allowed = $option->getAllowedTypes();
  }
  $output .= \sprintf(

src/Analyzer/Analysis/DataProviderAnalysis.php

@@ -24,11 +24,11 @@ final class DataProviderAnalysis
  /** @var int */
  private $nameIndex;
 
- /** @var int[] */
+ /** @var array<int> */
  private $usageIndices;
 
  /**
- * @param int[] $usageIndices
+ * @param array<int> $usageIndices
  */
  public function __construct(string $name, int $nameIndex, array $usageIndices)
  {
@@ -48,7 +48,7 @@ public function getNameIndex(): int
  }
 
  /**
- * @return int[]
+ * @return array<int>
  */
  public function getUsageIndices(): array
  {

src/Analyzer/ArrayAnalyzer.php

@@ -24,7 +24,7 @@
 final class ArrayAnalyzer
 {
  /**
- * @return ArrayElementAnalysis[]
+ * @return array<ArrayElementAnalysis>
  */
  public function getElements(Tokens $tokens, int $index): array
  {
@@ -58,7 +58,7 @@ public function getElements(Tokens $tokens, int $index): array
  }
 
  /**
- * @return ArrayElementAnalysis[]
+ * @return array<ArrayElementAnalysis>
  */
  private function getElementsForArrayContent(Tokens $tokens, int $startIndex, int $endIndex): array
  {

src/Analyzer/DataProviderAnalyzer.php

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