Merge pull request #403 from thephpleague/chore/phpstan

Use phpstan

Author: ADmad

.editorconfig

@@ -12,3 +12,6 @@ trim_trailing_whitespace = true
 
 [*.{yml,yaml}]
 indent_size = 2
+
+[*.neon]
+indent_style = tab

.gitattributes

@@ -12,3 +12,4 @@
 /tests export-ignore
 /CHANGELOG.md export-ignore
 /CONTRIBUTING.md export-ignore
+/phpstan.neon export-ignore

.github/workflows/test.yaml

@@ -60,7 +60,7 @@ jobs:
         run: |
           vendor/bin/php-cs-fixer fix --dry-run --diff
 
-  psalm:
+  static-analysis:
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
@@ -69,11 +69,16 @@ jobs:
         with:
           php-version: '8.3'
           extensions: gd, imagick
-          tools: vimeo/psalm:5
+          tools: vimeo/psalm:5, phpstan:1
 
       - name: Composer install
         uses: ramsey/composer-install@v3
 
       - name: psalm
         run: |
           psalm --output-format=github
+
+      - name: phpstan
+        if: always()
+        run: |
+          phpstan --error-format=github

.php-cs-fixer.dist.php

@@ -13,7 +13,7 @@
             'use_nullable_type_declaration' => true,
         ],
         'phpdoc_to_comment' => [
-            'ignored_tags' => ['psalm-suppress'],
+            'ignored_tags' => ['psalm-suppress', 'phpstan-ignore-line', 'phpstan-ignore-next-line'],
         ],
     ])
     ->setFinder($finder)

phpstan.neon

@@ -0,0 +1,7 @@
+parameters:
+	level: 8
+	paths:
+		- src/
+	ignoreErrors:
+		-
+			identifier: missingType.iterableValue

src/Api/Encoder.php

@@ -67,7 +67,7 @@ public function run(ImageInterface $image): EncodedImageInterface
             $format = 'jpg';
         }
 
-        $encoderOptions = ['extension' => $format];
+        $encoderOptions = [];
         switch ($format) {
             case 'avif':
             case 'heic':
@@ -87,7 +87,7 @@ public function run(ImageInterface $image): EncodedImageInterface
                 throw new \Exception("Invalid format provided: {$format}");
         }
 
-        return $image->encodeByExtension(...$encoderOptions);
+        return $image->encodeByExtension($format, ...$encoderOptions);
     }
 
     /**

src/Manipulators/Helpers/Color.php

@@ -85,7 +85,7 @@ public function __construct(string $value)
 
             $rgba = [255, 255, 255];
             $alpha = 0;
-        } while (false);
+        } while (false); // @phpstan-ignore-line
 
         $this->red = $rgba[0];
         $this->green = $rgba[1];

src/Manipulators/Size.php

@@ -25,7 +25,7 @@ public function __construct(?int $maxImageSize = null)
     /**
      * Set the maximum image size.
      *
-     * @param int|null Maximum image size in pixels.
+     * @param int|null $maxImageSize Maximum image size in pixels.
      */
     public function setMaxImageSize(?int $maxImageSize = null): void
     {

src/Server.php

@@ -361,8 +361,8 @@ public function getCachePath(string $path, array $params = []): string
 
         if ($this->cacheWithFileExtensions) {
             /** @psalm-suppress PossiblyUndefinedArrayOffset */
-            $ext = (isset($params['fm']) ? $params['fm'] : pathinfo($path)['extension']);
-            $ext = ('pjpg' === $ext) ? 'jpg' : $ext;
+            $ext = isset($params['fm']) ? $params['fm'] : pathinfo($path, PATHINFO_EXTENSION);
+            $ext = 'pjpg' === $ext ? 'jpg' : $ext;
             $cachedPath .= '.'.$ext;
         }
 

src/Urls/UrlBuilder.php

@@ -74,7 +74,11 @@ public function getUrl(string $path, array $params = []): string
             throw new \InvalidArgumentException('Not a valid path.');
         }
 
-        /** @psalm-suppress PossiblyNullArgument, PossiblyUndefinedArrayOffset */
+        /**
+         * @psalm-suppress PossiblyNullArgument, PossiblyUndefinedArrayOffset
+         *
+         * @phpstan-ignore-next-line
+         */
         $parts['path'] = '/'.trim($parts['path'], '/');
 
         if ($this->signature) {