style: Enable phpdoc_list_type fixer

paulbalandan · paulbalandan · commit fa9e27ddfbeb · 2024-02-16T23:09:13.000+08:00
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -71,6 +71,7 @@
             'var',
         ],
     ],
+    'phpdoc_list_type' => true,
 ];
 
 $options = [
diff --git a/.php-cs-fixer.no-header.php b/.php-cs-fixer.no-header.php
@@ -29,7 +29,9 @@
         __DIR__ . '/admin/starter/builds',
     ]);
 
-$overrides = [];
+$overrides = [
+    'phpdoc_list_type' => true,
+];
 
 $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,7 @@
         'import_symbols'                        => false,
         'leading_backslash_in_global_namespace' => true,
     ],
+    'phpdoc_list_type' => true,
 ];
 
 $options = [
diff --git a/app/Config/View.php b/app/Config/View.php
@@ -6,8 +6,8 @@
 use CodeIgniter\View\ViewDecoratorInterface;
 
 /**
- * @phpstan-type ParserCallable (callable(mixed): mixed)
- * @phpstan-type ParserCallableString (callable(mixed): mixed)&string
+ * @phpstan-type parser_callable (callable(mixed): mixed)
+ * @phpstan-type parser_callable_string (callable(mixed): mixed)&string
  */
 class View extends BaseView
 {
@@ -35,7 +35,7 @@ class View extends BaseView
      *  { created_on|date(Y-m-d)|esc(attr) }
      *
      * @var array<string, string>
-     * @phpstan-var array<string, ParserCallableString>
+     * @phpstan-var array<string, parser_callable_string>
      */
     public $filters = [];
 
@@ -44,8 +44,8 @@ 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>
-     * @phpstan-var array<string, array<ParserCallableString>|ParserCallableString|ParserCallable>
+     * @var array<string, callable|list<string>|string>
+     * @phpstan-var array<string, list<parser_callable_string>|parser_callable_string|parser_callable>
      */
     public $plugins = [];
 
@@ -56,7 +56,7 @@ class View extends BaseView
      *
      * All classes must implement CodeIgniter\View\ViewDecoratorInterface
      *
-     * @var class-string<ViewDecoratorInterface>[]
+     * @var list<class-string<ViewDecoratorInterface>>
      */
     public array $decorators = [];
 }
diff --git a/system/Autoloader/Autoloader.php b/system/Autoloader/Autoloader.php
@@ -61,7 +61,7 @@ class Autoloader
     /**
      * Stores namespaces as key, and path as values.
      *
-     * @var array<string, array<string>>
+     * @var array<string, list<string>>
      */
     protected $prefixes = [];
 
diff --git a/system/Config/BaseService.php b/system/Config/BaseService.php
@@ -170,7 +170,7 @@ class BaseService
     /**
      * A cache of the names of services classes found.
      *
-     * @var array<string>
+     * @var list<string>
      */
     private static array $serviceNames = [];
 
diff --git a/system/Config/View.php b/system/Config/View.php
@@ -51,8 +51,8 @@ class View extends BaseConfig
      *
      * @psalm-suppress UndefinedDocblockClass
      *
-     * @var array<string, array<string>|callable|string>
-     * @phpstan-var array<string, array<parser_callable_string>|parser_callable_string|parser_callable>
+     * @var array<string, callable|list<string>|string>
+     * @phpstan-var array<string, list<parser_callable_string>|parser_callable_string|parser_callable>
      */
     public $plugins = [];
 
@@ -89,8 +89,8 @@ class View extends BaseConfig
     /**
      * Built-in View plugins.
      *
-     * @var array<string, array<string>|callable|string>
-     * @phpstan-var array<string, array<parser_callable_string>|parser_callable_string|parser_callable>
+     * @var array<string, callable|list<string>|string>
+     * @phpstan-var array<string, list<parser_callable_string>|parser_callable_string|parser_callable>
      */
     protected $corePlugins = [
         'csp_script_nonce'  => '\CodeIgniter\View\Plugins::cspScriptNonce',
@@ -112,7 +112,7 @@ class View extends BaseConfig
      *
      * All classes must implement CodeIgniter\View\ViewDecoratorInterface
      *
-     * @var class-string<ViewDecoratorInterface>[]
+     * @var list<class-string<ViewDecoratorInterface>>
      */
     public array $decorators = [];
 
diff --git a/system/Cookie/Exceptions/CookieException.php b/system/Cookie/Exceptions/CookieException.php
@@ -104,7 +104,7 @@ public static function forInvalidSameSiteNone()
     /**
      * Thrown when the `CookieStore` class is filled with invalid Cookie objects.
      *
-     * @param array<int|string> $data
+     * @param list<int|string> $data
      *
      * @return static
      */
diff --git a/system/Database/BaseBuilder.php b/system/Database/BaseBuilder.php
@@ -116,7 +116,7 @@ class BaseBuilder
     /**
      * QB UNION data
      *
-     * @var array<string>
+     * @var list<string>
      */
     protected array $QBUnion = [];
 
diff --git a/system/Events/Events.php b/system/Events/Events.php
@@ -52,7 +52,7 @@ class Events
      * Stores information about the events
      * for display in the debug toolbar.
      *
-     * @var array<array<string, float|string>>
+     * @var list<array<string, float|string>>
      */
     protected static $performanceLog = [];
 
@@ -275,7 +275,7 @@ public static function simulate(bool $choice = true)
     /**
      * Getter for the performance log records.
      *
-     * @return array<array<string, float|string>>
+     * @return list<array<string, float|string>>
      */
     public static function getPerformanceLogs()
     {
diff --git a/system/View/Parser.php b/system/View/Parser.php
@@ -63,8 +63,8 @@ class Parser extends View
     /**
      * Stores any plugins registered at run-time.
      *
-     * @var array<string, array<string>|callable|string>
-     * @phpstan-var array<string, array<parser_callable_string>|parser_callable_string|parser_callable>
+     * @var array<string, callable|list<string>|string>
+     * @phpstan-var array<string, list<parser_callable_string>|parser_callable_string|parser_callable>
      */
     protected $plugins = [];
 
diff --git a/system/View/View.php b/system/View/View.php
@@ -137,7 +137,7 @@ class View implements RendererInterface
      * The name of the current section being rendered,
      * if any.
      *
-     * @var array<string>
+     * @var list<string>
      */
     protected $sectionStack = [];
 

Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,8 @@`
`6`	`6`	`use CodeIgniter\View\ViewDecoratorInterface;`
`7`	`7`
`8`	`8`	`/**`
`9`		`- * @phpstan-type ParserCallable (callable(mixed): mixed)`
`10`		`- * @phpstan-type ParserCallableString (callable(mixed): mixed)&string`
	`9`	`+ * @phpstan-type parser_callable (callable(mixed): mixed)`
	`10`	`+ * @phpstan-type parser_callable_string (callable(mixed): mixed)&string`
`11`	`11`	`*/`
`12`	`12`	`class View extends BaseView`
`13`	`13`	`{`
`@@ -35,7 +35,7 @@ class View extends BaseView`
`35`	`35`	`* { created_on\|date(Y-m-d)\|esc(attr) }`
`36`	`36`	`*`
`37`	`37`	`* @var array<string, string>`
`38`		`- * @phpstan-var array<string, ParserCallableString>`
	`38`	`+ * @phpstan-var array<string, parser_callable_string>`
`39`	`39`	`*/`
`40`	`40`	`public $filters = [];`
`41`	`41`
`@@ -44,8 +44,8 @@ class View extends BaseView`
`44`	`44`	`* by the core Parser by creating aliases that will be replaced with`
`45`	`45`	`* any callable. Can be single or tag pair.`
`46`	`46`	`*`
`47`		`- * @var array<string, array<string>\|callable\|string>`
`48`		`- * @phpstan-var array<string, array<ParserCallableString>\|ParserCallableString\|ParserCallable>`
	`47`	`+ * @var array<string, callable\|list<string>\|string>`
	`48`	`+ * @phpstan-var array<string, list<parser_callable_string>\|parser_callable_string\|parser_callable>`
`49`	`49`	`*/`
`50`	`50`	`public $plugins = [];`
`51`	`51`
`@@ -56,7 +56,7 @@ class View extends BaseView`
`56`	`56`	`*`
`57`	`57`	`* All classes must implement CodeIgniter\View\ViewDecoratorInterface`
`58`	`58`	`*`
`59`		`- * @var class-string<ViewDecoratorInterface>[]`
	`59`	`+ * @var list<class-string<ViewDecoratorInterface>>`
`60`	`60`	`*/`
`61`	`61`	`public array $decorators = [];`
`62`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ class Autoloader`
`61`	`61`	`/**`
`62`	`62`	`* Stores namespaces as key, and path as values.`
`63`	`63`	`*`
`64`		`- * @var array<string, array<string>>`
	`64`	`+ * @var array<string, list<string>>`
`65`	`65`	`*/`
`66`	`66`	`protected $prefixes = [];`
`67`	`67`
Original file line number	Diff line number	Diff line change
`@@ -170,7 +170,7 @@ class BaseService`
`170`	`170`	`/**`
`171`	`171`	`* A cache of the names of services classes found.`
`172`	`172`	`*`
`173`		`- * @var array<string>`
	`173`	`+ * @var list<string>`
`174`	`174`	`*/`
`175`	`175`	`private static array $serviceNames = [];`
`176`	`176`
Original file line number	Diff line number	Diff line change
`@@ -51,8 +51,8 @@ class View extends BaseConfig`
`51`	`51`	`*`
`52`	`52`	`* @psalm-suppress UndefinedDocblockClass`
`53`	`53`	`*`
`54`		`- * @var array<string, array<string>\|callable\|string>`
`55`		`- * @phpstan-var array<string, array<parser_callable_string>\|parser_callable_string\|parser_callable>`
	`54`	`+ * @var array<string, callable\|list<string>\|string>`
	`55`	`+ * @phpstan-var array<string, list<parser_callable_string>\|parser_callable_string\|parser_callable>`
`56`	`56`	`*/`
`57`	`57`	`public $plugins = [];`
`58`	`58`
`@@ -89,8 +89,8 @@ class View extends BaseConfig`
`89`	`89`	`/**`
`90`	`90`	`* Built-in View plugins.`
`91`	`91`	`*`
`92`		`- * @var array<string, array<string>\|callable\|string>`
`93`		`- * @phpstan-var array<string, array<parser_callable_string>\|parser_callable_string\|parser_callable>`
	`92`	`+ * @var array<string, callable\|list<string>\|string>`
	`93`	`+ * @phpstan-var array<string, list<parser_callable_string>\|parser_callable_string\|parser_callable>`
`94`	`94`	`*/`
`95`	`95`	`protected $corePlugins = [`
`96`	`96`	`'csp_script_nonce' => '\CodeIgniter\View\Plugins::cspScriptNonce',`
`@@ -112,7 +112,7 @@ class View extends BaseConfig`
`112`	`112`	`*`
`113`	`113`	`* All classes must implement CodeIgniter\View\ViewDecoratorInterface`
`114`	`114`	`*`
`115`		`- * @var class-string<ViewDecoratorInterface>[]`
	`115`	`+ * @var list<class-string<ViewDecoratorInterface>>`
`116`	`116`	`*/`
`117`	`117`	`public array $decorators = [];`
`118`	`118`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ public static function forInvalidSameSiteNone()`
`104`	`104`	`/**`
`105`	`105`	* Thrown when the `CookieStore` class is filled with invalid Cookie objects.
`106`	`106`	`*`
`107`		`- * @param array<int\|string> $data`
	`107`	`+ * @param list<int\|string> $data`
`108`	`108`	`*`
`109`	`109`	`* @return static`
`110`	`110`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -116,7 +116,7 @@ class BaseBuilder`
`116`	`116`	`/**`
`117`	`117`	`* QB UNION data`
`118`	`118`	`*`
`119`		`- * @var array<string>`
	`119`	`+ * @var list<string>`
`120`	`120`	`*/`
`121`	`121`	`protected array $QBUnion = [];`
`122`	`122`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ class Events`
`52`	`52`	`* Stores information about the events`
`53`	`53`	`* for display in the debug toolbar.`
`54`	`54`	`*`
`55`		`- * @var array<array<string, float\|string>>`
	`55`	`+ * @var list<array<string, float\|string>>`
`56`	`56`	`*/`
`57`	`57`	`protected static $performanceLog = [];`
`58`	`58`
`@@ -275,7 +275,7 @@ public static function simulate(bool $choice = true)`
`275`	`275`	`/**`
`276`	`276`	`* Getter for the performance log records.`
`277`	`277`	`*`
`278`		`- * @return array<array<string, float\|string>>`
	`278`	`+ * @return list<array<string, float\|string>>`
`279`	`279`	`*/`
`280`	`280`	`public static function getPerformanceLogs()`
`281`	`281`	`{`