style: also align @phpstan-type and @phpstan-var

paulbalandan · paulbalandan · commit c5a63bbc15d3 · 2024-02-16T23:14:47.000+08:00
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -62,6 +62,8 @@
             'phpstan-param',
             'phpstan-property',
             'phpstan-return',
+            'phpstan-type',
+            'phpstan-var',
             'property',
             'property-read',
             'property-write',
diff --git a/.php-cs-fixer.no-header.php b/.php-cs-fixer.no-header.php
@@ -29,7 +29,31 @@
         __DIR__ . '/admin/starter/builds',
     ]);
 
-$overrides = [];
+$overrides = [
+    'phpdoc_align' => [
+        'align'   => 'vertical',
+        'spacing' => 1,
+        'tags'    => [
+            'method',
+            'param',
+            'phpstan-assert',
+            'phpstan-assert-if-true',
+            'phpstan-assert-if-false',
+            'phpstan-param',
+            'phpstan-property',
+            'phpstan-return',
+            'phpstan-type',
+            'phpstan-var',
+            'property',
+            'property-read',
+            'property-write',
+            'return',
+            'throws',
+            'type',
+            'var',
+        ],
+    ],
+];
 
 $options = [
     'cacheFile' => 'build/.php-cs-fixer.no-header.cache',
diff --git a/.php-cs-fixer.user-guide.php b/.php-cs-fixer.user-guide.php
@@ -39,6 +39,29 @@
         'import_symbols'                        => false,
         'leading_backslash_in_global_namespace' => true,
     ],
+    'phpdoc_align' => [
+        'align'   => 'vertical',
+        'spacing' => 1,
+        'tags'    => [
+            'method',
+            'param',
+            'phpstan-assert',
+            'phpstan-assert-if-true',
+            'phpstan-assert-if-false',
+            'phpstan-param',
+            'phpstan-property',
+            'phpstan-return',
+            'phpstan-type',
+            'phpstan-var',
+            'property',
+            'property-read',
+            'property-write',
+            'return',
+            'throws',
+            'type',
+            'var',
+        ],
+    ],
 ];
 
 $options = [
diff --git a/app/Config/View.php b/app/Config/View.php
@@ -34,7 +34,7 @@ class View extends BaseView
      *  { title|esc(js) }
      *  { created_on|date(Y-m-d)|esc(attr) }
      *
-     * @var array<string, string>
+     * @var         array<string, string>
      * @phpstan-var array<string, ParserCallableString>
      */
     public $filters = [];
@@ -44,7 +44,7 @@ class View extends BaseView
      * by the core Parser by creating aliases that will be replaced with
      * any callable. Can be single or tag pair.
      *
-     * @var array<string, array<string>|callable|string>
+     * @var         array<string, array<string>|callable|string>
      * @phpstan-var array<string, array<ParserCallableString>|ParserCallableString|ParserCallable>
      */
     public $plugins = [];
diff --git a/system/BaseModel.php b/system/BaseModel.php
@@ -42,15 +42,15 @@
  *      - process various callbacks
  *      - allow intermingling calls to the db connection
  *
- * @phpstan-type row_array array<int|string, float|int|null|string>
+ * @phpstan-type row_array               array<int|string, float|int|null|string>
  * @phpstan-type event_data_beforeinsert array{data: row_array}
- * @phpstan-type event_data_afterinsert array{id: int|string, data: row_array, result: bool}
- * @phpstan-type event_data_beforefind array{id?: int|string, method: string, singleton: bool, limit?: int, offset?: int}
- * @phpstan-type event_data_afterfind array{id: int|string|null|list<int|string>, data: row_array|list<row_array>|object|null, method: string, singleton: bool}
+ * @phpstan-type event_data_afterinsert  array{id: int|string, data: row_array, result: bool}
+ * @phpstan-type event_data_beforefind   array{id?: int|string, method: string, singleton: bool, limit?: int, offset?: int}
+ * @phpstan-type event_data_afterfind    array{id: int|string|null|list<int|string>, data: row_array|list<row_array>|object|null, method: string, singleton: bool}
  * @phpstan-type event_data_beforeupdate array{id: null|list<int|string>, data: row_array}
- * @phpstan-type event_data_afterupdate array{id: null|list<int|string>, data: row_array|object, result: bool}
+ * @phpstan-type event_data_afterupdate  array{id: null|list<int|string>, data: row_array|object, result: bool}
  * @phpstan-type event_data_beforedelete array{id: null|list<int|string>, purge: bool}
- * @phpstan-type event_data_afterdelete array{id: null|list<int|string>, data: null, purge: bool, result: bool}
+ * @phpstan-type event_data_afterdelete  array{id: null|list<int|string>, data: null, purge: bool, result: bool}
  */
 abstract class BaseModel
 {
diff --git a/system/Config/View.php b/system/Config/View.php
@@ -39,7 +39,7 @@ class View extends BaseConfig
      *
      * @psalm-suppress UndefinedDocblockClass
      *
-     * @var array<string, string>
+     * @var         array<string, string>
      * @phpstan-var array<string, parser_callable_string>
      */
     public $filters = [];
@@ -51,15 +51,15 @@ class View extends BaseConfig
      *
      * @psalm-suppress UndefinedDocblockClass
      *
-     * @var array<string, array<string>|callable|string>
+     * @var         array<string, array<string>|callable|string>
      * @phpstan-var array<string, array<parser_callable_string>|parser_callable_string|parser_callable>
      */
     public $plugins = [];
 
     /**
      * Built-in View filters.
      *
-     * @var array<string, string>
+     * @var         array<string, string>
      * @phpstan-var array<string, parser_callable_string>
      */
     protected $coreFilters = [
@@ -89,7 +89,7 @@ class View extends BaseConfig
     /**
      * Built-in View plugins.
      *
-     * @var array<string, array<string>|callable|string>
+     * @var         array<string, array<string>|callable|string>
      * @phpstan-var array<string, array<parser_callable_string>|parser_callable_string|parser_callable>
      */
     protected $corePlugins = [
diff --git a/system/Database/BaseConnection.php b/system/Database/BaseConnection.php
@@ -195,15 +195,15 @@ abstract class BaseConnection implements ConnectionInterface
     /**
      * Connection ID
      *
-     * @var false|object|resource
+     * @var         false|object|resource
      * @phpstan-var false|TConnection
      */
     public $connID = false;
 
     /**
      * Result ID
      *
-     * @var false|object|resource
+     * @var         false|object|resource
      * @phpstan-var false|TResult
      */
     public $resultID = false;
diff --git a/system/Database/BasePreparedQuery.php b/system/Database/BasePreparedQuery.php
@@ -29,7 +29,7 @@ abstract class BasePreparedQuery implements PreparedQueryInterface
     /**
      * The prepared statement itself.
      *
-     * @var object|resource|null
+     * @var         object|resource|null
      * @phpstan-var TStatement|null
      */
     protected $statement;
@@ -59,7 +59,7 @@ abstract class BasePreparedQuery implements PreparedQueryInterface
     /**
      * A reference to the db connection to use.
      *
-     * @var BaseConnection
+     * @var         BaseConnection
      * @phpstan-var BaseConnection<TConnection, TResult>
      */
     protected $db;
diff --git a/system/Database/BaseResult.php b/system/Database/BaseResult.php
@@ -25,15 +25,15 @@ abstract class BaseResult implements ResultInterface
     /**
      * Connection ID
      *
-     * @var object|resource
+     * @var         object|resource
      * @phpstan-var TConnection
      */
     public $connID;
 
     /**
      * Result ID
      *
-     * @var false|object|resource
+     * @var         false|object|resource
      * @phpstan-var false|TResult
      */
     public $resultID;
diff --git a/system/View/Parser.php b/system/View/Parser.php
@@ -63,7 +63,7 @@ class Parser extends View
     /**
      * Stores any plugins registered at run-time.
      *
-     * @var array<string, array<string>|callable|string>
+     * @var         array<string, array<string>|callable|string>
      * @phpstan-var array<string, array<parser_callable_string>|parser_callable_string|parser_callable>
      */
     protected $plugins = [];

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ class View extends BaseConfig`
`39`	`39`	`*`
`40`	`40`	`* @psalm-suppress UndefinedDocblockClass`
`41`	`41`	`*`
`42`		`- * @var array<string, string>`
	`42`	`+ * @var array<string, string>`
`43`	`43`	`* @phpstan-var array<string, parser_callable_string>`
`44`	`44`	`*/`
`45`	`45`	`public $filters = [];`
`@@ -51,15 +51,15 @@ class View extends BaseConfig`
`51`	`51`	`*`
`52`	`52`	`* @psalm-suppress UndefinedDocblockClass`
`53`	`53`	`*`
`54`		`- * @var array<string, array<string>\|callable\|string>`
	`54`	`+ * @var array<string, array<string>\|callable\|string>`
`55`	`55`	`* @phpstan-var array<string, array<parser_callable_string>\|parser_callable_string\|parser_callable>`
`56`	`56`	`*/`
`57`	`57`	`public $plugins = [];`
`58`	`58`
`59`	`59`	`/**`
`60`	`60`	`* Built-in View filters.`
`61`	`61`	`*`
`62`		`- * @var array<string, string>`
	`62`	`+ * @var array<string, string>`
`63`	`63`	`* @phpstan-var array<string, parser_callable_string>`
`64`	`64`	`*/`
`65`	`65`	`protected $coreFilters = [`
`@@ -89,7 +89,7 @@ class View extends BaseConfig`
`89`	`89`	`/**`
`90`	`90`	`* Built-in View plugins.`
`91`	`91`	`*`
`92`		`- * @var array<string, array<string>\|callable\|string>`
	`92`	`+ * @var array<string, array<string>\|callable\|string>`
`93`	`93`	`* @phpstan-var array<string, array<parser_callable_string>\|parser_callable_string\|parser_callable>`
`94`	`94`	`*/`
`95`	`95`	`protected $corePlugins = [`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ class Parser extends View`
`63`	`63`	`/**`
`64`	`64`	`* Stores any plugins registered at run-time.`
`65`	`65`	`*`
`66`		`- * @var array<string, array<string>\|callable\|string>`
	`66`	`+ * @var array<string, array<string>\|callable\|string>`
`67`	`67`	`* @phpstan-var array<string, array<parser_callable_string>\|parser_callable_string\|parser_callable>`
`68`	`68`	`*/`
`69`	`69`	`protected $plugins = [];`