Add PHPStan

Author: hlecorche

.github/workflows/tests.yml

@@ -101,9 +101,9 @@ jobs:
                 if: matrix.coding-standards != true
                 run: composer remove friendsofphp/php-cs-fixer --dev --no-update
 
-            -   name: Remove vimeo/psalm
+            -   name: Remove phpstan/phpstan
                 if: matrix.static-analysis != true
-                run: composer remove vimeo/psalm --dev --no-update
+                run: composer remove phpstan/phpstan --dev --no-update
 
             -   name: Configure Symfony Flex
                 if: matrix.symfony-version
@@ -130,6 +130,6 @@ jobs:
                 if: matrix.coding-standards
                 run: cat LICENSE |grep -E "\(c\) ([0-9]+\-)*`date +%Y`"
 
-            -   name: Run Psalm
+            -   name: Run PHPStan
                 if: matrix.static-analysis
-                run: php vendor/bin/psalm --stats --output-format=github
+                run: php vendor/bin/phpstan --no-progress --error-format=github

UPGRADE-2.0.md

@@ -2,3 +2,4 @@
 
 * Remove deprecated `unix2dos_path` option
 * The default value of the `escape` option is now an empty string (previously `\`), to ensure compliance with RFC 4180
+* Update signature : `public function write($data): void` to `public function write(array $data): void`

composer.json

@@ -22,8 +22,8 @@
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.0",
-        "phpunit/phpunit": "^9.0",
-        "vimeo/psalm": "^5"
+        "phpstan/phpstan": "^2.1",
+        "phpunit/phpunit": "^9.0"
     },
     "config": {
         "sort-packages": true

phpstan-baseline.neon

@@ -0,0 +1,5 @@
+parameters:
+    ignoreErrors:
+        -
+            message: '#Parameter \#3 \$options of class Ecommit\\CsvTableGenerator\\Csv constructor expects array.+array<string, mixed> given#'
+            path: tests/

phpstan.neon.dist

@@ -0,0 +1,9 @@
+includes:
+    - phpstan-baseline.neon
+    - vendor/phpstan/phpstan/conf/bleedingEdge.neon
+
+parameters:
+    level: max
+    paths:
+        - src
+        - tests

psalm.xml

@@ -15,15 +15,33 @@
 
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
+/**
+ * @phpstan-type Options array{
+ *     header?: ?array<?string>,
+ *     max_lines?: ?int,
+ *     delimiter?: string,
+ *     enclosure?: string,
+ *     eol?: self::EOL_*,
+ *     escape?: string,
+ *     add_utf8_bom?: bool,
+ * }
+ * @phpstan-type ResolvedOptions array{
+ *     header: ?array<?string>,
+ *     max_lines: ?int,
+ *     delimiter: string,
+ *     enclosure: string,
+ *     eol: self::EOL_*,
+ *     escape: string,
+ *     add_utf8_bom: bool,
+ *  }
+ */
 class Csv
 {
     public const EOL_LF = 'LF';
     public const EOL_CRLF = 'CR+LF';
 
     /**
-     * @var resource|false|null
-     *
-     * @psalm-var resource|closed-resource|false|null
+     * @var resource|closed-resource|false|null
      */
     protected mixed $handle = null;
 
@@ -32,7 +50,7 @@ class Csv
     protected string $currentPathname;
 
     /**
-     * @var array<string, string>|null
+     * @var array<?string>|null
      */
     protected ?array $header;
 
@@ -49,9 +67,9 @@ class Csv
     /**
      * Constructor.
      *
-     * @param string $pathDir  Path folder
-     * @param string $filename Filename (without path folder and extension)
-     * @param array  $options  See README.md
+     * @param string  $pathDir  Path folder
+     * @param string  $filename Filename (without path folder and extension)
+     * @param Options $options  See README.md
      */
     public function __construct(string $pathDir, string $filename, array $options = [])
     {
@@ -73,6 +91,7 @@ public function __construct(string $pathDir, string $filename, array $options =
         $resolver->setAllowedTypes('escape', 'string');
         $resolver->setAllowedTypes('add_utf8_bom', 'bool');
         $this->configureOptions($resolver);
+        /** @var ResolvedOptions $options */
         $options = $resolver->resolve($options);
 
         // Test folder
@@ -153,22 +172,20 @@ protected function newFile(): void
     /**
      * Add line in CSV file.
      *
-     * @param array $data
+     * @param array<?scalar> $data
      */
-    public function write($data): void
+    public function write(array $data): void
     {
-        if (!\is_resource($this->handle)) {
-            throw new \Exception(\sprintf('Handle does not exist. File %s', $this->filename));
-        }
-
         // New file
         if (null !== $this->maxLines && $this->maxLines == $this->lines) {
             $this->newFile();
         }
 
         // Write
         $eol = (self::EOL_CRLF === $this->eol) ? "\r\n" : "\n";
-        /** @psalm-suppress TooManyArguments */
+        if (!\is_resource($this->handle)) {
+            throw new \Exception(\sprintf('Handle does not exist. File %s', $this->filename));
+        }
         $result = fputcsv($this->handle, $data, $this->delimiter, $this->enclosure, $this->escape, $eol);
         if (false === $result) {
             throw new \Exception(\sprintf('Error during the writing in %s file', $this->filename));

src/Csv.php

@@ -18,7 +18,7 @@
 
 class CsvTest extends TestCase
 {
-    protected $path;
+    protected string $path;
 
     protected function setUp(): void
     {
@@ -39,9 +39,12 @@ protected function deleteDir(): void
         }
 
         $files = glob($this->path.'/*');
-        foreach ($files as $file) {
-            is_dir($file) ? $this->deleteDir($file) : unlink($file);
+        if ($files) {
+            foreach ($files as $file) {
+                is_dir($file) ? $this->deleteDir() : unlink($file);
+            }
         }
+
         rmdir($this->path);
     }
 
@@ -355,11 +358,17 @@ public function testGetCurrentPathnameSecondFile(Csv $csv): void
         $csv->close();
     }
 
+    /**
+     * @param array<string, mixed> $options
+     */
     protected function createCsv(array $options = []): Csv
     {
         return new Csv($this->path, 'my-csv', $options);
     }
 
+    /**
+     * @param array<?scalar> $expectedRows
+     */
     protected function assertCsvFile(string $filename, array $expectedRows, bool $useCrlf = false, string $beforeContent = ''): void
     {
         $this->assertFileExists($this->path.'/'.$filename, 'File not found');