DevKit updates for 2.x branch (#608)

* DevKit updates * Fix cs * Fix phpstan * DevKit updates Co-authored-by: Vincent Langlet <vincentlanglet@hotmail.fr>
sonata-project · Sep 3, 2022 · 2134571 · 2134571
1 parent 57e20da
commit 2134571
Show file tree

Hide file tree

Showing 15 changed files with 23 additions and 4 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -45,6 +45,11 @@
     'nullable_type_declaration_for_default_null_value' => ['use_nullable_type_declaration' => true],
     'ordered_class_elements' => true,
     'ordered_imports' => ['sort_algorithm' => 'alpha', 'imports_order' => ['class', 'function', 'const']],
+    'phpdoc_order' => ['order' => ['var', 'param', 'throws', 'return', 'phpstan-var', 'psalm-var', 'phpstan-param', 'psalm-param', 'phpstan-return', 'psalm-return']],
+    'phpdoc_separation' => ['groups' => [
+        ['phpstan-template', 'phpstan-template-covariant', 'phpstan-extends', 'phpstan-implements', 'phpstan-var', 'psalm-var', 'phpstan-param', 'psalm-param', 'phpstan-return', 'psalm-return'],
+        ['psalm-suppress', 'phpstan-ignore-next-line'],
+    ]],
     'php_unit_strict' => true,
     'php_unit_test_case_static_method_calls' => true,
     'phpdoc_to_comment' => ['ignored_tags' => ['psalm-suppress', 'phpstan-var']],

diff --git a/src/Source/AbstractXmlSourceIterator.php b/src/Source/AbstractXmlSourceIterator.php
@@ -27,6 +27,7 @@ abstract class AbstractXmlSourceIterator implements SourceIteratorInterface
 
     /**
      * @var resource|null
+     *
      * @phpstan-var resource|null
      * @psalm-var resource|closed-resource|null
      */

diff --git a/src/Source/CsvSourceIterator.php b/src/Source/CsvSourceIterator.php
@@ -24,6 +24,7 @@ final class CsvSourceIterator implements SourceIteratorInterface
 
     /**
      * @var resource|null
+     *
      * @phpstan-var resource|null
      * @psalm-var resource|closed-resource|null
      */

diff --git a/src/Source/DoctrineODMQuerySourceIterator.php b/src/Source/DoctrineODMQuerySourceIterator.php
@@ -36,6 +36,7 @@ public function __construct(Query $query, array $fields, string $dateTimeFormat
     /**
      * @return array<string, mixed>
      */
+    #[\ReturnTypeWillChange]
     public function current()
     {
         $current = $this->iterator->current();

diff --git a/src/Source/DoctrineORMQuerySourceIterator.php b/src/Source/DoctrineORMQuerySourceIterator.php
@@ -43,6 +43,7 @@ public function __construct(Query $query, array $fields, string $dateTimeFormat
     /**
      * @return array<string, mixed>
      */
+    #[\ReturnTypeWillChange]
     public function current()
     {
         $current = $this->iterator->current();

diff --git a/src/Source/IteratorCallbackSourceIterator.php b/src/Source/IteratorCallbackSourceIterator.php
@@ -39,6 +39,7 @@ public function __construct(\Iterator $iterator, \Closure $transformer)
     /**
      * @return array<mixed>
      */
+    #[\ReturnTypeWillChange]
     public function current()
     {
         return \call_user_func($this->transformer, $this->iterator->current());

diff --git a/src/Source/SymfonySitemapSourceIterator.php b/src/Source/SymfonySitemapSourceIterator.php
@@ -47,6 +47,7 @@ public function __construct(
     /**
      * @return array<string, mixed>
      */
+    #[\ReturnTypeWillChange]
     public function current()
     {
         $data = $this->source->current();
@@ -65,6 +66,7 @@ public function next(): void
         $this->source->next();
     }
 
+    #[\ReturnTypeWillChange]
     public function key()
     {
         return $this->source->key();

diff --git a/src/Writer/CsvWriter.php b/src/Writer/CsvWriter.php
@@ -30,6 +30,7 @@ final class CsvWriter implements TypedWriterInterface
 
     /**
      * @var resource|null
+     *
      * @phpstan-var resource|null
      * @psalm-var resource|closed-resource|null
      */

diff --git a/src/Writer/GsaFeedWriter.php b/src/Writer/GsaFeedWriter.php
@@ -34,6 +34,7 @@ final class GsaFeedWriter implements WriterInterface
 
     /**
      * @var resource|null
+     *
      * @phpstan-var resource|null
      * @psalm-var resource|closed-resource|null
      */

diff --git a/src/Writer/JsonWriter.php b/src/Writer/JsonWriter.php
@@ -22,6 +22,7 @@ final class JsonWriter implements TypedWriterInterface
 
     /**
      * @var resource|null
+     *
      * @phpstan-var resource|null
      * @psalm-var resource|closed-resource|null
      */

diff --git a/src/Writer/SitemapWriter.php b/src/Writer/SitemapWriter.php
@@ -31,6 +31,7 @@ final class SitemapWriter implements WriterInterface
 
     /**
      * @var resource|null
+     *
      * @phpstan-var resource|null
      * @psalm-var resource|closed-resource|null
      */

diff --git a/src/Writer/WriterInterface.php b/src/Writer/WriterInterface.php
@@ -18,18 +18,18 @@
 interface WriterInterface
 {
     /**
-     * @return void
-     *
      * @throws SonataExporterException
+     *
+     * @return void
      */
     public function open();
 
     /**
      * @param mixed[] $data
      *
-     * @return void
-     *
      * @throws SonataExporterException
+     *
+     * @return void
      */
     public function write(array $data);
 

diff --git a/src/Writer/XlsWriter.php b/src/Writer/XlsWriter.php
@@ -22,6 +22,7 @@ final class XlsWriter implements TypedWriterInterface
 
     /**
      * @var resource|null
+     *
      * @phpstan-var resource|null
      * @psalm-var resource|closed-resource|null
      */

diff --git a/src/Writer/XmlExcelWriter.php b/src/Writer/XmlExcelWriter.php
@@ -24,6 +24,7 @@ final class XmlExcelWriter implements WriterInterface
 
     /**
      * @var resource|null
+     *
      * @phpstan-var resource|null
      * @psalm-var resource|closed-resource|null
      */

diff --git a/src/Writer/XmlWriter.php b/src/Writer/XmlWriter.php
@@ -25,6 +25,7 @@ final class XmlWriter implements TypedWriterInterface
 
     /**
      * @var resource|null
+     *
      * @phpstan-var resource|null
      * @psalm-var resource|closed-resource|null
      */