Configure groups option of phpdoc_separation

Author: paulbalandan

.php-cs-fixer.dist.php

@@ -38,7 +38,21 @@
         __DIR__ . '/spark',
     ]);
 
-$overrides = [];
+$overrides = [
+    'phpdoc_separation' => [
+        'groups' => [
+            ['immutable', 'psalm-immutable'],
+            ['param', 'phpstan-param', 'psalm-param'],
+            ['phpstan-pure', 'psalm-pure'],
+            ['readonly', 'psalm-readonly'],
+            ['return', 'phpstan-return', 'psalm-return'],
+            ['template', 'phpstan-template', 'psalm-template'],
+            ['template-covariant', 'phpstan-template-covariant', 'psalm-template-covariant'],
+            ['phpstan-type', 'psalm-type'],
+            ['var', 'phpstan-var', 'psalm-var'],
+        ],
+    ],
+];
 
 $options = [
     'cacheFile'    => 'build/.php-cs-fixer.cache',

.php-cs-fixer.no-header.php

@@ -30,7 +30,21 @@
         __DIR__ . '/admin/starter/builds',
     ]);
 
-$overrides = [];
+$overrides = [
+    'phpdoc_separation' => [
+        'groups' => [
+            ['immutable', 'psalm-immutable'],
+            ['param', 'phpstan-param', 'psalm-param'],
+            ['phpstan-pure', 'psalm-pure'],
+            ['readonly', 'psalm-readonly'],
+            ['return', 'phpstan-return', 'psalm-return'],
+            ['template', 'phpstan-template', 'psalm-template'],
+            ['template-covariant', 'phpstan-template-covariant', 'psalm-template-covariant'],
+            ['phpstan-type', 'psalm-type'],
+            ['var', 'phpstan-var', 'psalm-var'],
+        ],
+    ],
+];
 
 $options = [
     'cacheFile'    => 'build/.php-cs-fixer.no-header.cache',

.php-cs-fixer.user-guide.php

@@ -33,6 +33,19 @@
     'php_unit_internal_class'     => false,
     'no_unused_imports'           => false,
     'class_attributes_separation' => false,
+    'phpdoc_separation'           => [
+        'groups' => [
+            ['immutable', 'psalm-immutable'],
+            ['param', 'phpstan-param', 'psalm-param'],
+            ['phpstan-pure', 'psalm-pure'],
+            ['readonly', 'psalm-readonly'],
+            ['return', 'phpstan-return', 'psalm-return'],
+            ['template', 'phpstan-template', 'psalm-template'],
+            ['template-covariant', 'phpstan-template-covariant', 'psalm-template-covariant'],
+            ['phpstan-type', 'psalm-type'],
+            ['var', 'phpstan-var', 'psalm-var'],
+        ],
+    ],
 ];
 
 $options = [

app/Config/App.php

@@ -437,6 +437,7 @@ class App extends BaseConfig
      * Defaults to `Lax` as recommended in this link:
      *
      * @see https://portswigger.net/web-security/csrf/samesite-cookies
+     *
      * @deprecated `Config\Cookie` $samesite property is used.
      *
      * @var string

system/Commands/Utilities/Routes/AutoRouteCollector.php

@@ -36,7 +36,6 @@ public function __construct(string $namespace, string $defaultController, string
 
     /**
      * @return array<int, array<int, string>>
-     *
      * @phpstan-return list<list<string>>
      */
     public function get(): array

system/Commands/Utilities/Routes/AutoRouterImproved/AutoRouteCollector.php

@@ -54,7 +54,6 @@ public function __construct(
 
     /**
      * @return array<int, array<int, string>>
-     *
      * @phpstan-return list<list<string>>
      */
     public function get(): array

system/Commands/Utilities/Routes/AutoRouterImproved/ControllerMethodReader.php

@@ -41,7 +41,6 @@ public function __construct(string $namespace, array $httpMethods)
      * @phpstan-param class-string $class
      *
      * @return array<int, array<string, array|string>>
-     *
      * @phpstan-return list<array<string, string|array>>
      */
     public function read(string $class, string $defaultController = 'Home', string $defaultMethod = 'index'): array

system/Commands/Utilities/Routes/ControllerFinder.php

@@ -37,7 +37,6 @@ public function __construct(string $namespace)
 
     /**
      * @return string[]
-     *
      * @phpstan-return class-string[]
      */
     public function find(): array

system/Commands/Utilities/Routes/ControllerMethodReader.php

@@ -36,7 +36,6 @@ public function __construct(string $namespace)
      * @phpstan-param class-string $class
      *
      * @return array<int, array{route: string, handler: string}>
-     *
      * @phpstan-return list<array{route: string, handler: string}>
      */
     public function read(string $class, string $defaultController = 'Home', string $defaultMethod = 'index'): array

system/Database/BaseConnection.php

@@ -995,7 +995,6 @@ public function getConnectDuration(int $decimals = 6): string
      * @param bool         $fieldExists        Supplied $item contains a column name?
      *
      * @return array|string
-     *
      * @phpstan-return ($item is array ? array : string)
      */
     public function protectIdentifiers($item, bool $prefixSingle = false, ?bool $protectIdentifiers = null, bool $fieldExists = true)
@@ -1598,7 +1597,6 @@ public function isWriteType($sql): bool
      * Must return an array with keys 'code' and 'message':
      *
      * @return array<string, int|string|null>
-     *
      * @phpstan-return array{code: int|string|null, message: string|null}
      */
     abstract public function error(): array;

system/Database/SQLite3/Table.php

@@ -28,7 +28,6 @@ class Table
      * All of the fields this table represents.
      *
      * @var array
-     *
      * @phpstan-var array<string, array<string, bool|int|string|null>>
      */
     protected $fields = [];
@@ -306,7 +305,6 @@ protected function copyData()
      * @param array|bool $fields
      *
      * @return mixed
-     *
      * @phpstan-return ($fields is array ? array : mixed)
      */
     protected function formatFields($fields)

system/HTTP/Response.php

@@ -222,6 +222,7 @@ public function getStatusCode(): int
      *
      * @see http://tools.ietf.org/html/rfc7231#section-6
      * @see http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
+     *
      * @deprecated Use getReasonPhrase()
      *
      * @codeCoverageIgnore

system/HTTP/ResponseInterface.php

@@ -141,6 +141,7 @@ public function setStatusCode(int $code, string $reason = '');
      *
      * @see http://tools.ietf.org/html/rfc7231#section-6
      * @see http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
+     *
      * @deprecated Use getReasonPhrase()
      */
     public function getReason(): string;