phpstan: prefer using list<> syntax whenever possible

rebing · Mar 4, 2024 · 1f779a3 · 1f779a3
1 parent b82745f
commit 1f779a3
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 21 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -10,6 +10,11 @@ parameters:
 			count: 1
 			path: src/GraphQL.php
 
+		-
+			message: "#^Method Rebing\\\\GraphQL\\\\GraphQL\\:\\:getGlobalResolverMiddlewares\\(\\) should return list\\<class\\-string\\|object\\> but returns array\\.$#"
+			count: 1
+			path: src/GraphQL.php
+
 		-
 			message: "#^Parameter \\#1 \\$config of class GraphQL\\\\Type\\\\Definition\\\\ObjectType constructor expects array\\{name\\?\\: string\\|null, description\\?\\: string\\|null, resolveField\\?\\: \\(callable\\(mixed, array\\<string, mixed\\>, mixed, GraphQL\\\\Type\\\\Definition\\\\ResolveInfo\\)\\: mixed\\)\\|null, fields\\: \\(callable\\(\\)\\: iterable\\)\\|iterable, interfaces\\?\\: \\(callable\\(\\)\\: iterable\\<callable\\(\\)\\: GraphQL\\\\Type\\\\Definition\\\\InterfaceType\\|GraphQL\\\\Type\\\\Definition\\\\InterfaceType\\>\\)\\|iterable\\<\\(callable\\(\\)\\: GraphQL\\\\Type\\\\Definition\\\\InterfaceType\\)\\|GraphQL\\\\Type\\\\Definition\\\\InterfaceType\\>, isTypeOf\\?\\: \\(callable\\(mixed, mixed, GraphQL\\\\Type\\\\Definition\\\\ResolveInfo\\)\\: \\(bool\\|GraphQL\\\\Deferred\\|null\\)\\)\\|null, astNode\\?\\: GraphQL\\\\Language\\\\AST\\\\ObjectTypeDefinitionNode\\|null, extensionASTNodes\\?\\: array\\<int, GraphQL\\\\Language\\\\AST\\\\ObjectTypeExtensionNode\\>\\|null\\}, non\\-empty\\-array\\<string, array\\<int\\|string, non\\-empty\\-array\\<string, mixed\\>\\|\\(ArrayAccess&Rebing\\\\GraphQL\\\\Support\\\\Field\\)\\>\\|string\\> given\\.$#"
 			count: 1
@@ -125,6 +130,11 @@ parameters:
 			count: 1
 			path: src/Support/Field.php
 
+		-
+			message: "#^Method Rebing\\\\GraphQL\\\\Support\\\\Field\\:\\:appendGlobalMiddlewares\\(\\) should return list\\<class\\-string\\|object\\> but returns array\\.$#"
+			count: 1
+			path: src/Support/Field.php
+
 		-
 			message: "#^Method Rebing\\\\GraphQL\\\\Support\\\\Field\\:\\:attributes\\(\\) return type has no value type specified in iterable type array\\.$#"
 			count: 1

diff --git a/src/GraphQL.php b/src/GraphQL.php
@@ -41,7 +41,7 @@ class GraphQL
     /** @var Container */
     protected $app;
 
-    /** @var array<Schema> */
+    /** @var array<string,Schema> */
     protected $schemas = [];
 
     /**
@@ -54,7 +54,7 @@ class GraphQL
     /**
      * These middleware are executed before all resolve methods
      *
-     * @var array<object|class-string>
+     * @var list<object|class-string>
      */
     protected $globalResolverMiddlewares = [];
 
@@ -153,7 +153,7 @@ protected function executeAndReturnResult(string $schemaName, Schema $schema, Op
     }
 
     /**
-     * @param array<string> $middleware
+     * @param list<string> $middleware
      * @param mixed $rootValue
      * @param mixed $contextValue
      */
@@ -167,7 +167,7 @@ protected function executeViaMiddleware(array $middleware, string $schemaName, S
     }
 
     /**
-     * @return array<string>
+     * @return list<class-string>
      */
     protected function executionMiddleware(string $schemaName): array
     {
@@ -183,8 +183,8 @@ protected function executionMiddleware(string $schemaName): array
     }
 
     /**
-     * @phpstan-param array<class-string> $middlewares
-     * @phpstan-return array<class-string>
+     * @phpstan-param list<class-string> $middlewares
+     * @phpstan-return list<class-string>
      */
     protected function appendGraphqlExecutionMiddleware(array $middlewares): array
     {
@@ -202,7 +202,7 @@ public function appendGlobalResolverMiddleware(object|string $class): void
     }
 
     /**
-     * @phpstan-return array<object|class-string>
+     * @phpstan-return list<object|class-string>
      */
     public function getGlobalResolverMiddlewares(): array
     {
@@ -471,7 +471,7 @@ public function getTypes(): array
     }
 
     /**
-     * @return array<Schema>
+     * @return array<string,Schema>
      */
     public function getSchemas(): array
     {

diff --git a/src/Helpers.php b/src/Helpers.php
@@ -12,8 +12,8 @@ class Helpers
      *
      * Apply a callback to a value or each value in an array.
      *
-     * @param mixed|array<mixed> $valueOrValues
-     * @return mixed|array<mixed>
+     * @param mixed|list<mixed> $valueOrValues
+     * @return mixed|list<mixed>
      */
     public static function applyEach(Closure $callback, $valueOrValues)
     {

diff --git a/src/Support/Contracts/ConfigConvertible.php b/src/Support/Contracts/ConfigConvertible.php
@@ -9,12 +9,12 @@ interface ConfigConvertible
 {
     /**
      * @return array{
-     *                execution_middleware?:array<class-string<AbstractExecutionMiddleware>>,
+     *                execution_middleware?:list<class-string<AbstractExecutionMiddleware>>,
      *                method?:string|string[],
      *                middleware?:array<string|class-string>,
-     *                mutation?:array<string,class-string>|array<class-string>,
-     *                query:array<string,class-string>|array<class-string>,
-     *                types?:array<string,class-string>|array<class-string>
+     *                mutation?:array<string,class-string>|list<class-string>,
+     *                query:array<string,class-string>|list<class-string>,
+     *                types?:array<string,class-string>|list<class-string>
      *                }
      */
     public function toConfig(): array;

diff --git a/src/Support/Field.php b/src/Support/Field.php
@@ -24,7 +24,7 @@ abstract class Field
     /** @var array<string,mixed> */
     protected $attributes = [];
 
-    /** @var string[] */
+    /** @var list<class-string> */
     protected $middleware = [];
 
     /**
@@ -139,16 +139,16 @@ public function getValidator(array $args, array $rules): ValidatorContract
     }
 
     /**
-     * @return array<string>
+     * @return list<class-string>
      */
     protected function getMiddleware(): array
     {
         return $this->middleware;
     }
 
     /**
-     * @return array<class-string|object>
-     * @phpstan-param array<string> $middleware
+     * @return list<class-string|object>
+     * @phpstan-param list<string> $middleware
      */
     protected function appendGlobalMiddlewares(array $middleware): array
     {

diff --git a/tests/Database/EmptyQueryTest.php b/tests/Database/EmptyQueryTest.php
@@ -10,7 +10,7 @@ class EmptyQueryTest extends TestCaseDatabase
 {
     /**
      * @dataProvider dataForEmptyQuery
-     * @param array<mixed> $parameters
+     * @param list<mixed> $parameters
      */
     public function testEmptyQuery(array $parameters, string $expectedError): void
     {
@@ -132,7 +132,7 @@ static function (array $result): array {
     }
 
     /**
-     * @return array<mixed>
+     * @return list<mixed>
      */
     public static function dataForEmptyQuery(): array
     {

diff --git a/tests/Support/Objects/ExampleRuleTestingInputObject.php b/tests/Support/Objects/ExampleRuleTestingInputObject.php
@@ -55,7 +55,7 @@ public function fields(): array
     /**
      * @param mixed $root
      * @param array<string,mixed> $args
-     * @return array<string>
+     * @return list<string>
      */
     public function resolve($root, array $args): array
     {