Clean up docblocks (#2390)

Author: spawnia

src/Console/PrintSchemaCommand.php

@@ -5,9 +5,7 @@
 use GraphQL\Type\Introspection;
 use GraphQL\Utils\SchemaPrinter;
 use Illuminate\Console\Command;
-use Illuminate\Contracts\Filesystem\Filesystem;
 use Illuminate\Filesystem\FilesystemManager;
-use Illuminate\Support\Facades\Storage;
 use Nuwave\Lighthouse\Federation\FederationPrinter;
 use Nuwave\Lighthouse\Schema\AST\ASTCache;
 use Nuwave\Lighthouse\Schema\SchemaBuilder;
@@ -56,9 +54,10 @@ public function handle(ASTCache $cache, FilesystemManager $filesystemManager, Sc
 
         if ($this->option('write')) {
             $disk = $this->option('disk');
-            if (! is_string($disk) && ! is_null($disk)) {
+            if (! is_string($disk) && ! is_null($disk)) { // @phpstan-ignore-line can be array
                 $diskType = gettype($disk);
                 $this->error("Expected option disk to be string or null, got: {$diskType}.");
+
                 return;
             }
 

src/Deprecation/DetectDeprecatedUsage.php

@@ -25,13 +25,13 @@ class DetectDeprecatedUsage extends ValidationRule
     /** @var DeprecationHandler */
     protected $deprecationHandler;
 
-    /** @param DeprecationHandler $deprecationHandler */
+    /** @param  DeprecationHandler  $deprecationHandler */
     public function __construct(callable $deprecationHandler)
     {
         $this->deprecationHandler = $deprecationHandler;
     }
 
-    /** @param DeprecationHandler $deprecationHandler */
+    /** @param  DeprecationHandler  $deprecationHandler */
     public static function handle(callable $deprecationHandler): void
     {
         DocumentValidator::addRule(new static($deprecationHandler));

src/Exceptions/DefinitionException.php

@@ -2,7 +2,6 @@
 
 namespace Nuwave\Lighthouse\Exceptions;
 
-use Exception;
 use GraphQL\Error\ClientAware;
 
 /**

src/Execution/Arguments/ArgPartitioner.php

@@ -85,7 +85,7 @@ public static function relationMethods(
     /**
      * Attach a nested argument resolver to an argument.
      *
-     * @param \ReflectionClass<\Illuminate\Database\Eloquent\Model>|null $model
+     * @param  \ReflectionClass<\Illuminate\Database\Eloquent\Model>|null  $model
      */
     protected static function attachNestedArgResolver(string $name, Argument &$argument, ?\ReflectionClass $model): void
     {

src/Federation/BatchedEntityResolver.php

@@ -7,7 +7,7 @@ interface BatchedEntityResolver
     /**
      * Resolve multiple entities of a single type in one batch.
      *
-     * @param array<string, array<string, mixed>> $representations
+     * @param  array<string, array<string, mixed>>  $representations
      *
      * @return iterable<string, mixed> must preserve the count and keys of $representations
      */

src/Federation/EntityResolverProvider.php

@@ -261,7 +261,7 @@ public function firstSatisfiedKeyFields(Collection $keyFieldsSelections, array $
             ?? throw new Error('Representation does not satisfy any set of uniquely identifying keys: ' . \Safe\json_encode($representation));
     }
 
-    /** @param array<string, mixed> $representation */
+    /** @param  array<string, mixed>  $representation */
     protected function hydrateExternalFields(Model $model, array $representation, ObjectTypeDefinitionNode $definition): void
     {
         foreach ($definition->fields as $field) {

src/GraphQL.php

@@ -64,7 +64,7 @@ public function __construct(
      *
      * @api
      *
-     * @param array<string, mixed>|null $variables
+     * @param  array<string, mixed>|null  $variables
      *
      * @return array<string, mixed>
      */
@@ -95,7 +95,7 @@ public function executeQueryString(
      * you will probably want to call `->toArray($debug)` on it,
      * with $debug being a combination of flags in @see \GraphQL\Error\DebugFlag
      *
-     * @param array<string, mixed>|null $variables
+     * @param  array<string, mixed>|null  $variables
      *
      * @return array<string, mixed>
      */

src/Pagination/PaginationArgs.php

@@ -78,7 +78,7 @@ protected static function calculateCurrentPage(int $first, int $after, int $defa
      *
      * @param  \Illuminate\Database\Query\Builder|\Laravel\Scout\Builder|\Illuminate\Database\Eloquent\Builder<TModel>|\Illuminate\Database\Eloquent\Relations\Relation<TModel>  $builder
      *
-     * @return Paginator<TModel>
+     * @return \Illuminate\Contracts\Pagination\Paginator<TModel>
      */
     public function applyToBuilder(QueryBuilder|ScoutBuilder|EloquentBuilder|Relation $builder): Paginator
     {

src/Pagination/PaginatorField.php

@@ -13,9 +13,9 @@ class PaginatorField
      * @return array{
      *     count: int,
      *     currentPage: int,
-     *     firstItem: int,
+     *     firstItem: int|null,
      *     hasMorePages: bool,
-     *     lastItem: int,
+     *     lastItem: int|null,
      *     lastPage: int,
      *     perPage: int,
      *     total: int,

src/Pagination/SimplePaginatorField.php

@@ -15,8 +15,8 @@ class SimplePaginatorField
      * @return array{
      *     count: int,
      *     currentPage: int,
-     *     firstItem: int,
-     *     lastItem: int,
+     *     firstItem: int|null,
+     *     lastItem: int|null,
      *     perPage: int,
      *     hasMorePages: bool,
      * }