dev: Tools update (PHPStan v1.11.4) (#168)

LastDragon-ru · Jun 8, 2024 · 31279fa · 31279fa
2 parents d84265b + c4826f8
commit 31279fa
Show file tree

Hide file tree

Showing 21 changed files with 1,888 additions and 1,505 deletions.
diff --git a/composer.json b/composer.json
@@ -213,7 +213,7 @@
       "jq --indent 2 '.' composer.json > composer.tmp && mv composer.tmp composer.json"
     ],
     "phpstan": [
-      "./vendor-bin/phpstan/vendor/bin/phpstan analyse"
+      "./vendor-bin/phpstan/vendor/bin/phpstan analyse -v"
     ],
     "phpunit": [
       "./vendor/bin/phpunit"

diff --git a/packages/dev/src/PhpStan/ClassMustBeFinal/Rule.php b/packages/dev/src/PhpStan/ClassMustBeFinal/Rule.php
@@ -2,6 +2,8 @@
 
 namespace LastDragon_ru\LaraASP\Dev\PhpStan\ClassMustBeFinal;
 
+use Illuminate\Support\Str;
+use LastDragon_ru\LaraASP\Dev\Package;
 use Override;
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Class_;
@@ -60,7 +62,9 @@ public function processNode(Node $node, Scope $scope): array {
             return [
                 RuleErrorBuilder::message(
                     sprintf('Class `%s` must be `final`.', $reflection->getName()),
-                )->build(),
+                )
+                    ->identifier(Str::camel(Package::Name).'.classMustBeFinal')
+                    ->build(),
             ];
         }
 

diff --git a/packages/dev/src/PhpStan/ClassMustBeInternal/Rule.php b/packages/dev/src/PhpStan/ClassMustBeInternal/Rule.php
@@ -2,6 +2,8 @@
 
 namespace LastDragon_ru\LaraASP\Dev\PhpStan\ClassMustBeInternal;
 
+use Illuminate\Support\Str;
+use LastDragon_ru\LaraASP\Dev\Package;
 use Override;
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Class_;
@@ -74,7 +76,9 @@ public function processNode(Node $node, Scope $scope): array {
             return [
                 RuleErrorBuilder::message(
                     sprintf('Class `%s` must be marked by `@internal`.', $reflection->getName()),
-                )->build(),
+                )
+                    ->identifier(Str::camel(Package::Name).'.classMustBeInternal')
+                    ->build(),
             ];
         }
 

diff --git a/...es/documentator/src/Preprocessor/Instructions/IncludeGraphqlDirective/InstructionTest.php b/...es/documentator/src/Preprocessor/Instructions/IncludeGraphqlDirective/InstructionTest.php
@@ -4,6 +4,7 @@
 
 // @phpcs:disable Generic.Files.LineLength.TooLong
 
+use ArrayAccess;
 use GraphQL\Language\Parser;
 use LastDragon_ru\LaraASP\Core\Utils\Path;
 use LastDragon_ru\LaraASP\Documentator\Preprocessor\Context;
@@ -64,8 +65,12 @@ public function testInvoke(): void {
     }
 
     public function testInvokeNoPrinter(): void {
-        unset($this->app()[PrinterContract::class]);
+        // Reset
+        if ($this->app() instanceof ArrayAccess) {
+            unset($this->app()[PrinterContract::class]);
+        }
 
+        // Test
         $root     = new Directory(Path::normalize(__DIR__), false);
         $file     = new File(Path::normalize(__FILE__), false);
         $target   = '@test';

diff --git a/packages/documentator/src/Preprocessor/Preprocessor.php b/packages/documentator/src/Preprocessor/Preprocessor.php
@@ -126,7 +126,7 @@ public function getInstructions(): array {
      * @param I|class-string<I> $instruction
      */
     public function addInstruction(Instruction|string $instruction): static {
-        // @phpstan-ignore-next-line Assigment is fine...
+        // @phpstan-ignore-next-line argument.type (Assigment is fine...)
         $this->instructions[$instruction::getName()] = new ResolvedInstruction($this->container, $instruction);
 
         return $this;

diff --git a/packages/eloquent/src/Concerns/SaveOrThrow.php b/packages/eloquent/src/Concerns/SaveOrThrow.php
@@ -25,12 +25,14 @@ public function save(array $options = []): bool {
         return $result;
     }
 
-    /* @phpstan-ignore-next-line `Model::delete()` and `Pivot::::delete()` return different types. */
+    /**
+     * @phpstan-ignore-next-line method.childReturnType (`Model::delete()`&`Pivot::::delete()` return different types)
+     */
     #[Override]
     public function delete(): bool|int|null {
         $result = parent::delete();
 
-        if ($result === false) { // @phpstan-ignore-line
+        if ($result === false) { // @phpstan-ignore-line method.childReturnType, identical.alwaysFalse
             throw new Exception('An unknown error occurred while deleting the model.');
         }
 

diff --git a/packages/eloquent/src/ModelHelperTest.php b/packages/eloquent/src/ModelHelperTest.php
@@ -171,7 +171,7 @@ class ModelHelperTest__Model extends Model {
     /**
      * @noinspection             PhpMissingReturnTypeInspection
      * @phpcsSuppress            SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingAnyTypeHint
-     * @phpstan-ignore-next-line Required for test
+     * @phpstan-ignore-next-line missingType.return (Required for test)
      */
     public function noTypeHint() {
         return $this->belongsTo(self::class);

diff --git a/packages/graphql-printer/src/Blocks/Document/SchemaDefinition.php b/packages/graphql-printer/src/Blocks/Document/SchemaDefinition.php
@@ -78,8 +78,7 @@ static function (NamedTypeNode|ObjectType $type, string $operation) use ($defaul
                 $name   = $type instanceof NamedTypeNode
                     ? $type->name->value
                     : $type->name;
-                $custom = !isset($default[$operation])
-                    || $default[$operation] !== $name;
+                $custom = $default[$operation] !== $name;
 
                 return $custom;
             },

diff --git a/packages/graphql/src/Stream/Directives/Directive.php b/packages/graphql/src/Stream/Directives/Directive.php
@@ -606,7 +606,7 @@ protected function getResolverQuery(string $type, string $field): ?array {
         $value    = new class($type, $field) extends FieldValue {
             /**
              * @noinspection             PhpMissingParentConstructorInspection
-             * @phpstan-ignore-next-line no need to call parent `__construct`
+             * @phpstan-ignore-next-line constructor.missingParentCall (no need to call parent `__construct`)
              */
             public function __construct(
                 private readonly string $typeName,

diff --git a/packages/graphql/src/Testing/SchemaBuilderWrapper.php b/packages/graphql/src/Testing/SchemaBuilderWrapper.php
@@ -25,7 +25,7 @@ class SchemaBuilderWrapper extends SchemaBuilder {
 
     /**
      * @noinspection             PhpMissingParentConstructorInspection
-     * @phpstan-ignore-next-line no need to call parent `__construct`
+     * @phpstan-ignore-next-line constructor.missingParentCall (no need to call parent `__construct`)
      */
     public function __construct(
         protected SchemaBuilder $builder,

diff --git a/packages/serializer/src/Metadata/MetadataFactoryTest.php b/packages/serializer/src/Metadata/MetadataFactoryTest.php
@@ -19,10 +19,18 @@ final class MetadataFactoryTest extends TestCase {
     public function testHasMetadataFor(): void {
         $factory = new MetadataFactory();
 
-        self::assertTrue($factory->hasMetadataFor(MetadataFactoryTest_A::class));   // @phpstan-ignore-line
-        self::assertTrue($factory->hasMetadataFor(new MetadataFactoryTest_A()));    // @phpstan-ignore-line
-        self::assertFalse($factory->hasMetadataFor(JsonSerializable::class));       // @phpstan-ignore-line
-        self::assertFalse($factory->hasMetadataFor('UnknownClass'));                // @phpstan-ignore-line
+        self::assertTrue(
+            $factory->hasMetadataFor(MetadataFactoryTest_A::class), // @phpstan-ignore-line method.alreadyNarrowedType
+        );
+        self::assertTrue(
+            $factory->hasMetadataFor(new MetadataFactoryTest_A()),  // @phpstan-ignore-line method.alreadyNarrowedType
+        );
+        self::assertFalse(
+            $factory->hasMetadataFor(JsonSerializable::class),      // @phpstan-ignore-line method.alreadyNarrowedType
+        );
+        self::assertFalse(
+            $factory->hasMetadataFor('UnknownClass'),               // @phpstan-ignore-line method.impossibleType
+        );
     }
 
     public function testGetMetadataFor(): void {
@@ -144,7 +152,7 @@ class      : MetadataFactoryTest_B::class,
 #[DiscriminatorMap('version', ['b' => MetadataFactoryTest_B::class, 'a' => MetadataFactoryTest_A::class])]
 class MetadataFactoryTest_A implements JsonSerializable {
     public int           $a = 123;
-    public bool          $b; // @phpstan-ignore-line required for tests
+    public bool          $b; // @phpstan-ignore-line property.uninitialized (required for tests)
     protected string     $c = 'should be ignored';
     private string       $d = 'should be ignored';
     public static string $e = 'should be ignored';
@@ -162,7 +170,7 @@ public function jsonSerialize(): mixed {
 class MetadataFactoryTest_B extends MetadataFactoryTest_A {
     /**
      * @var array<array-key, MetadataFactoryTest_A>
-     * @phpstan-ignore-next-line required for tests
+     * @phpstan-ignore-next-line property.uninitialized (required for tests)
      */
     public array $array;
 

diff --git a/packages/serializer/src/ProviderTest.php b/packages/serializer/src/ProviderTest.php
@@ -128,7 +128,7 @@ public function __construct(
         $backedEnum   = ProviderTest__BackedEnum::A;
         $serializable = new ProviderTest__Simple($datetime, $unitEnum, $backedEnum);
         $curcular     = new class() implements Serializable {
-            public Serializable $a; // @phpstan-ignore-line required for tests
+            public Serializable $a; // @phpstan-ignore-line property.uninitialized (required for tests)
         };
         $curcular->a  = $curcular;
 
@@ -374,7 +374,7 @@ public function __construct(
  */
 class ProviderTest__Simple implements Serializable, Stringable, JsonSerializable {
     public int                       $a = 123;
-    public bool                      $b; // @phpstan-ignore-line required for tests
+    public bool                      $b; // @phpstan-ignore-line property.uninitialized (required for tests)
     protected string                 $c = 'should be ignored';
     private string                   $d = 'should be ignored';
     public ?DateTimeInterface        $e = null;
@@ -411,7 +411,7 @@ public function jsonSerialize(): mixed {
  */
 class ProviderTest__Complex implements Serializable {
     public int  $a = 123;
-    public bool $b; // @phpstan-ignore-line required for tests
+    public bool $b; // @phpstan-ignore-line property.uninitialized (required for tests)
 
     /**
      * @var array<int, int>

diff --git a/packages/spa/src/Http/Resources/ResourceCollectionTest.php b/packages/spa/src/Http/Resources/ResourceCollectionTest.php
@@ -28,6 +28,7 @@ public function testConstruct(bool|Exception $expected, string $class): void {
             self::expectExceptionObject($expected);
         }
 
+        // @phpstan-ignore-next-line expr.resultUnused
         new class($class, []) extends ResourceCollection {
             // empty
         };

diff --git a/packages/spa/src/Http/Resources/ResourceTest.php b/packages/spa/src/Http/Resources/ResourceTest.php
@@ -36,6 +36,7 @@ public function testConstruct(bool|Exception $expected, mixed $value): void {
             self::expectExceptionObject($expected);
         }
 
+        // @phpstan-ignore-next-line expr.resultUnused
         new class($value) extends Resource {
             // empty
         };

diff --git a/packages/testing/src/Comparators/DatabaseQueryComparator.php b/packages/testing/src/Comparators/DatabaseQueryComparator.php
@@ -94,7 +94,7 @@ protected function normalize(Query $query): Query {
             $matches = array_flip($matches);
 
             uksort($matches, static function (string|int $a, string|int $b): int {
-                return strlen((string) $b) <=> strlen((string) $a);
+                return strlen("{$b}") <=> strlen("{$a}");
             });
 
             foreach ($matches as $match => $index) {

diff --git a/packages/testing/src/Concerns/Override.php b/packages/testing/src/Concerns/Override.php
@@ -91,7 +91,6 @@ protected function override(string $class, mixed $factory = null): mixed {
             : $factory;
 
         if (is_callable($factory)) {
-            /** @phpstan-ignore-next-line it may return `void` so it is fine here */
             $mock = $factory($mock, $this) ?: $mock;
         } elseif (is_string($factory)) {
             $mock = $this->app()->make($factory);
@@ -112,6 +111,6 @@ protected function override(string $class, mixed $factory = null): mixed {
         );
 
         // Return
-        return $mock; // @phpstan-ignore-line `ContainerExtension` is not so smart yet.
+        return $mock; // @phpstan-ignore-line return.type (`ContainerExtension` is not so smart yet).
     }
 }