Merge pull request #8530 from paulbalandan/phpdoc-list-type

style: Enable `phpdoc_list_type` fixer
codeigniter4 · Feb 26, 2024 · a718427 · a718427
2 parents ad11363 + 06353a4
commit a718427
Show file tree

Hide file tree

Showing 61 changed files with 174 additions and 270 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -43,38 +43,7 @@
         __DIR__ . '/spark',
     ]);
 
-$overrides = [
-    'phpdoc_array_type'   => true,
-    'phpdoc_no_alias_tag' => [
-        'replacements' => [
-            'type' => 'var',
-            'link' => 'see',
-        ],
-    ],
-    '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',
-        ],
-    ],
-];
+$overrides = [];
 
 $options = [
     'cacheFile' => 'build/.php-cs-fixer.cache',

diff --git a/.php-cs-fixer.no-header.php b/.php-cs-fixer.no-header.php
@@ -29,32 +29,7 @@
         __DIR__ . '/admin/starter/builds',
     ]);
 
-$overrides = [
-    'phpdoc_array_type' => 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',
-        ],
-    ],
-];
+$overrides = [];
 
 $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,30 +39,6 @@
         'import_symbols'                        => false,
         'leading_backslash_in_global_namespace' => true,
     ],
-    'phpdoc_array_type' => 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/Cache.php b/app/Config/Cache.php
@@ -61,7 +61,7 @@ class Cache extends BaseConfig
      *    ['q'] = Enabled, but only take into account the specified list
      *            of query parameters.
      *
-     * @var array<string>|bool
+     * @var bool|list<string>
      */
     public $cacheQueryString = false;
 

diff --git a/app/Config/ContentSecurityPolicy.php b/app/Config/ContentSecurityPolicy.php
@@ -45,28 +45,28 @@ class ContentSecurityPolicy extends BaseConfig
     /**
      * Will default to self if not overridden
      *
-     * @var array<string>|string|null
+     * @var list<string>|string|null
      */
     public $defaultSrc;
 
     /**
      * Lists allowed scripts' URLs.
      *
-     * @var array<string>|string
+     * @var list<string>|string
      */
     public $scriptSrc = 'self';
 
     /**
      * Lists allowed stylesheets' URLs.
      *
-     * @var array<string>|string
+     * @var list<string>|string
      */
     public $styleSrc = 'self';
 
     /**
      * Defines the origins from which images can be loaded.
      *
-     * @var array<string>|string
+     * @var list<string>|string
      */
     public $imageSrc = 'self';
 
@@ -75,36 +75,36 @@ class ContentSecurityPolicy extends BaseConfig
      *
      * Will default to self if not overridden
      *
-     * @var array<string>|string|null
+     * @var list<string>|string|null
      */
     public $baseURI;
 
     /**
      * Lists the URLs for workers and embedded frame contents
      *
-     * @var array<string>|string
+     * @var list<string>|string
      */
     public $childSrc = 'self';
 
     /**
      * Limits the origins that you can connect to (via XHR,
      * WebSockets, and EventSource).
      *
-     * @var array<string>|string
+     * @var list<string>|string
      */
     public $connectSrc = 'self';
 
     /**
      * Specifies the origins that can serve web fonts.
      *
-     * @var array<string>|string
+     * @var list<string>|string
      */
     public $fontSrc;
 
     /**
      * Lists valid endpoints for submission from `<form>` tags.
      *
-     * @var array<string>|string
+     * @var list<string>|string
      */
     public $formAction = 'self';
 
@@ -114,7 +114,7 @@ class ContentSecurityPolicy extends BaseConfig
      * and `<applet>` tags. This directive can't be used in
      * `<meta>` tags and applies only to non-HTML resources.
      *
-     * @var array<string>|string|null
+     * @var list<string>|string|null
      */
     public $frameAncestors;
 
@@ -129,33 +129,33 @@ class ContentSecurityPolicy extends BaseConfig
     /**
      * Restricts the origins allowed to deliver video and audio.
      *
-     * @var array<string>|string|null
+     * @var list<string>|string|null
      */
     public $mediaSrc;
 
     /**
      * Allows control over Flash and other plugins.
      *
-     * @var array<string>|string
+     * @var list<string>|string
      */
     public $objectSrc = 'self';
 
     /**
-     * @var array<string>|string|null
+     * @var list<string>|string|null
      */
     public $manifestSrc;
 
     /**
      * Limits the kinds of plugins a page may invoke.
      *
-     * @var array<string>|string|null
+     * @var list<string>|string|null
      */
     public $pluginTypes;
 
     /**
      * List of actions allowed.
      *
-     * @var array<string>|string|null
+     * @var list<string>|string|null
      */
     public $sandbox;
 

diff --git a/app/Config/Format.php b/app/Config/Format.php
@@ -22,7 +22,7 @@ class Format extends BaseConfig
      * These formats are only checked when the data passed to the respond()
      * method is an array.
      *
-     * @var array<string>
+     * @var list<string>
      */
     public array $supportedResponseFormats = [
         'application/json',

diff --git a/app/Config/Toolbar.php b/app/Config/Toolbar.php
@@ -31,7 +31,7 @@ class Toolbar extends BaseConfig
      * List of toolbar collectors that will be called when Debug Toolbar
      * fires up and collects data from.
      *
-     * @var array<string>
+     * @var list<string>
      */
     public array $collectors = [
         Timers::class,

diff --git a/app/Config/Validation.php b/app/Config/Validation.php
@@ -18,7 +18,7 @@ class Validation extends BaseConfig
      * Stores the classes that contain the
      * rules that are available.
      *
-     * @var array<string>
+     * @var list<string>
      */
     public array $ruleSets = [
         Rules::class,

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 array<class-string<ViewDecoratorInterface>>
+     * @var list<class-string<ViewDecoratorInterface>>
      */
     public array $decorators = [];
 }
diff --git a/phpstan-baseline.php b/phpstan-baseline.php
@@ -1001,16 +1001,6 @@
 	'count' => 2,
 	'path' => __DIR__ . '/system/Database/BaseResult.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Only booleans are allowed in an if condition, array\\<array\\> given\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Database/BaseResult.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Only booleans are allowed in an if condition, array\\<object\\> given\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Database/BaseResult.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Parameter \\#1 \\$className \\(class\\-string\\) of method CodeIgniter\\\\Database\\\\BaseResult\\:\\:getCustomResultObject\\(\\) should be contravariant with parameter \\$className \\(string\\) of method CodeIgniter\\\\Database\\\\ResultInterface\\<TConnection,TResult\\>\\:\\:getCustomResultObject\\(\\)$#',
 	'count' => 1,
@@ -1091,6 +1081,11 @@
 	'count' => 1,
 	'path' => __DIR__ . '/system/Database/Forge.php',
 ];
+$ignoreErrors[] = [
+	'message' => '#^Property CodeIgniter\\\\Database\\\\Forge\\:\\:\\$fields \\(array\\<string, array\\|string\\>\\) does not accept array\\<int\\|string, int\\>\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/system/Database/Forge.php',
+];
 $ignoreErrors[] = [
 	'message' => '#^Method CodeIgniter\\\\Database\\\\Migration\\:\\:down\\(\\) has no return type specified\\.$#',
 	'count' => 1,
@@ -1256,16 +1251,6 @@
 	'count' => 5,
 	'path' => __DIR__ . '/system/Database/OCI8/Connection.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Only booleans are allowed in a negated boolean, array given\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Database/OCI8/Connection.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Only booleans are allowed in a negated boolean, array\\<stdClass\\> given\\.$#',
-	'count' => 1,
-	'path' => __DIR__ . '/system/Database/OCI8/Connection.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^PHPDoc type string of property CodeIgniter\\\\Database\\\\OCI8\\\\Connection\\:\\:\\$escapeChar is not the same as PHPDoc type array\\|string of overridden property CodeIgniter\\\\Database\\\\BaseConnection\\<resource,resource\\>\\:\\:\\$escapeChar\\.$#',
 	'count' => 1,
@@ -3121,6 +3106,11 @@
 	'count' => 1,
 	'path' => __DIR__ . '/system/Test/Mock/MockCURLRequest.php',
 ];
+$ignoreErrors[] = [
+	'message' => '#^Cannot unset offset string on array\\<int, int\\>\\|null\\.$#',
+	'count' => 2,
+	'path' => __DIR__ . '/system/Test/Mock/MockCache.php',
+];
 $ignoreErrors[] = [
 	'message' => '#^Method CodeIgniter\\\\Test\\\\Mock\\\\MockCache\\:\\:assertHas\\(\\) has no return type specified\\.$#',
 	'count' => 1,