feat: @PHP84Migration introduction (#7774)

PHP-CS-Fixer · Mar 25, 2024 · 2091e39 · 2091e39
1 parent e980ab2
commit 2091e39
Show file tree

Hide file tree

Showing 23 changed files with 102 additions and 0 deletions.
diff --git a/doc/ruleSets/PHP84Migration.rst b/doc/ruleSets/PHP84Migration.rst
@@ -0,0 +1,11 @@
+============================
+Rule set ``@PHP84Migration``
+============================
+
+Rules to improve code for PHP 8.4 compatibility.
+
+Rules
+-----
+
+- `@PHP83Migration <./PHP83Migration.rst>`_
+- `nullable_type_declaration_for_default_null_value <./../rules/function_notation/nullable_type_declaration_for_default_null_value.rst>`_
diff --git a/doc/ruleSets/index.rst b/doc/ruleSets/index.rst
@@ -24,6 +24,7 @@ List of Available Rule sets
 - `@PHP81Migration <./PHP81Migration.rst>`_
 - `@PHP82Migration <./PHP82Migration.rst>`_
 - `@PHP83Migration <./PHP83Migration.rst>`_
+- `@PHP84Migration <./PHP84Migration.rst>`_
 - `@PHPUnit30Migration:risky <./PHPUnit30MigrationRisky.rst>`_
 - `@PHPUnit32Migration:risky <./PHPUnit32MigrationRisky.rst>`_
 - `@PHPUnit35Migration:risky <./PHPUnit35MigrationRisky.rst>`_

diff --git a/doc/rules/array_notation/array_syntax.rst b/doc/rules/array_notation/array_syntax.rst
@@ -59,6 +59,7 @@ The rule is part of the following rule sets:
 - `@PHP81Migration <./../../ruleSets/PHP81Migration.rst>`_
 - `@PHP82Migration <./../../ruleSets/PHP82Migration.rst>`_
 - `@PHP83Migration <./../../ruleSets/PHP83Migration.rst>`_
+- `@PHP84Migration <./../../ruleSets/PHP84Migration.rst>`_
 - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
 - `@Symfony <./../../ruleSets/Symfony.rst>`_
 

diff --git a/doc/rules/array_notation/no_whitespace_before_comma_in_array.rst b/doc/rules/array_notation/no_whitespace_before_comma_in_array.rst
@@ -77,6 +77,10 @@ The rule is part of the following rule sets:
 
   ``['after_heredoc' => true]``
 
+- `@PHP84Migration <./../../ruleSets/PHP84Migration.rst>`_ with config:
+
+  ``['after_heredoc' => true]``
+
 - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_ with config:
 
   ``['after_heredoc' => true]``

diff --git a/doc/rules/array_notation/normalize_index_brace.rst b/doc/rules/array_notation/normalize_index_brace.rst
@@ -28,6 +28,7 @@ The rule is part of the following rule sets:
 - `@PHP81Migration <./../../ruleSets/PHP81Migration.rst>`_
 - `@PHP82Migration <./../../ruleSets/PHP82Migration.rst>`_
 - `@PHP83Migration <./../../ruleSets/PHP83Migration.rst>`_
+- `@PHP84Migration <./../../ruleSets/PHP84Migration.rst>`_
 - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
 - `@Symfony <./../../ruleSets/Symfony.rst>`_
 

diff --git a/doc/rules/basic/octal_notation.rst b/doc/rules/basic/octal_notation.rst
@@ -25,6 +25,7 @@ The rule is part of the following rule sets:
 - `@PHP81Migration <./../../ruleSets/PHP81Migration.rst>`_
 - `@PHP82Migration <./../../ruleSets/PHP82Migration.rst>`_
 - `@PHP83Migration <./../../ruleSets/PHP83Migration.rst>`_
+- `@PHP84Migration <./../../ruleSets/PHP84Migration.rst>`_
 
 References
 ----------

diff --git a/doc/rules/cast_notation/no_unset_cast.rst b/doc/rules/cast_notation/no_unset_cast.rst
@@ -27,6 +27,7 @@ The rule is part of the following rule sets:
 - `@PHP81Migration <./../../ruleSets/PHP81Migration.rst>`_
 - `@PHP82Migration <./../../ruleSets/PHP82Migration.rst>`_
 - `@PHP83Migration <./../../ruleSets/PHP83Migration.rst>`_
+- `@PHP84Migration <./../../ruleSets/PHP84Migration.rst>`_
 - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
 - `@Symfony <./../../ruleSets/Symfony.rst>`_
 

diff --git a/doc/rules/cast_notation/short_scalar_cast.rst b/doc/rules/cast_notation/short_scalar_cast.rst
@@ -41,6 +41,7 @@ The rule is part of the following rule sets:
 - `@PHP81Migration <./../../ruleSets/PHP81Migration.rst>`_
 - `@PHP82Migration <./../../ruleSets/PHP82Migration.rst>`_
 - `@PHP83Migration <./../../ruleSets/PHP83Migration.rst>`_
+- `@PHP84Migration <./../../ruleSets/PHP84Migration.rst>`_
 - `@PSR12 <./../../ruleSets/PSR12.rst>`_
 - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
 - `@Symfony <./../../ruleSets/Symfony.rst>`_

diff --git a/doc/rules/class_notation/visibility_required.rst b/doc/rules/class_notation/visibility_required.rst
@@ -76,6 +76,7 @@ The rule is part of the following rule sets:
 - `@PHP81Migration <./../../ruleSets/PHP81Migration.rst>`_
 - `@PHP82Migration <./../../ruleSets/PHP82Migration.rst>`_
 - `@PHP83Migration <./../../ruleSets/PHP83Migration.rst>`_
+- `@PHP84Migration <./../../ruleSets/PHP84Migration.rst>`_
 - `@PSR2 <./../../ruleSets/PSR2.rst>`_ with config:
 
   ``['elements' => ['method', 'property']]``

diff --git a/doc/rules/control_structure/trailing_comma_in_multiline.rst b/doc/rules/control_structure/trailing_comma_in_multiline.rst
@@ -127,6 +127,10 @@ The rule is part of the following rule sets:
 
   ``['after_heredoc' => true]``
 
+- `@PHP84Migration <./../../ruleSets/PHP84Migration.rst>`_ with config:
+
+  ``['after_heredoc' => true]``
+
 - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
 - `@Symfony <./../../ruleSets/Symfony.rst>`_
 

diff --git a/doc/rules/function_notation/method_argument_space.rst b/doc/rules/function_notation/method_argument_space.rst
@@ -318,6 +318,10 @@ The rule is part of the following rule sets:
 
   ``['after_heredoc' => true]``
 
+- `@PHP84Migration <./../../ruleSets/PHP84Migration.rst>`_ with config:
+
+  ``['after_heredoc' => true]``
+
 - `@PSR2 <./../../ruleSets/PSR2.rst>`_ with config:
 
   ``['attribute_placement' => 'ignore', 'on_multiline' => 'ensure_fully_multiline']``

diff --git a/doc/rules/function_notation/nullable_type_declaration_for_default_null_value.rst b/doc/rules/function_notation/nullable_type_declaration_for_default_null_value.rst
@@ -117,6 +117,7 @@ Rule sets
 
 The rule is part of the following rule sets:
 
+- `@PHP84Migration <./../../ruleSets/PHP84Migration.rst>`_
 - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
 - `@Symfony <./../../ruleSets/Symfony.rst>`_
 

diff --git a/doc/rules/list_notation/list_syntax.rst b/doc/rules/list_notation/list_syntax.rst
@@ -58,6 +58,7 @@ The rule is part of the following rule sets:
 - `@PHP81Migration <./../../ruleSets/PHP81Migration.rst>`_
 - `@PHP82Migration <./../../ruleSets/PHP82Migration.rst>`_
 - `@PHP83Migration <./../../ruleSets/PHP83Migration.rst>`_
+- `@PHP84Migration <./../../ruleSets/PHP84Migration.rst>`_
 
 References
 ----------

diff --git a/doc/rules/namespace_notation/clean_namespace.rst b/doc/rules/namespace_notation/clean_namespace.rst
@@ -38,6 +38,7 @@ The rule is part of the following rule sets:
 - `@PHP81Migration <./../../ruleSets/PHP81Migration.rst>`_
 - `@PHP82Migration <./../../ruleSets/PHP82Migration.rst>`_
 - `@PHP83Migration <./../../ruleSets/PHP83Migration.rst>`_
+- `@PHP84Migration <./../../ruleSets/PHP84Migration.rst>`_
 - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
 - `@Symfony <./../../ruleSets/Symfony.rst>`_
 

diff --git a/doc/rules/operator/assign_null_coalescing_to_coalesce_equal.rst b/doc/rules/operator/assign_null_coalescing_to_coalesce_equal.rst
@@ -28,6 +28,7 @@ The rule is part of the following rule sets:
 - `@PHP81Migration <./../../ruleSets/PHP81Migration.rst>`_
 - `@PHP82Migration <./../../ruleSets/PHP82Migration.rst>`_
 - `@PHP83Migration <./../../ruleSets/PHP83Migration.rst>`_
+- `@PHP84Migration <./../../ruleSets/PHP84Migration.rst>`_
 
 References
 ----------

diff --git a/doc/rules/operator/ternary_to_null_coalescing.rst b/doc/rules/operator/ternary_to_null_coalescing.rst
@@ -31,6 +31,7 @@ The rule is part of the following rule sets:
 - `@PHP81Migration <./../../ruleSets/PHP81Migration.rst>`_
 - `@PHP82Migration <./../../ruleSets/PHP82Migration.rst>`_
 - `@PHP83Migration <./../../ruleSets/PHP83Migration.rst>`_
+- `@PHP84Migration <./../../ruleSets/PHP84Migration.rst>`_
 
 References
 ----------

diff --git a/doc/rules/string_notation/simple_to_complex_string_variable.rst b/doc/rules/string_notation/simple_to_complex_string_variable.rst
@@ -47,6 +47,7 @@ The rule is part of the following rule sets:
 
 - `@PHP82Migration <./../../ruleSets/PHP82Migration.rst>`_
 - `@PHP83Migration <./../../ruleSets/PHP83Migration.rst>`_
+- `@PHP84Migration <./../../ruleSets/PHP84Migration.rst>`_
 - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
 - `@Symfony <./../../ruleSets/Symfony.rst>`_
 

diff --git a/doc/rules/whitespace/heredoc_indentation.rst b/doc/rules/whitespace/heredoc_indentation.rst
@@ -75,6 +75,7 @@ The rule is part of the following rule sets:
 - `@PHP81Migration <./../../ruleSets/PHP81Migration.rst>`_
 - `@PHP82Migration <./../../ruleSets/PHP82Migration.rst>`_
 - `@PHP83Migration <./../../ruleSets/PHP83Migration.rst>`_
+- `@PHP84Migration <./../../ruleSets/PHP84Migration.rst>`_
 
 References
 ----------

diff --git a/src/RuleSet/Sets/PHP84MigrationSet.php b/src/RuleSet/Sets/PHP84MigrationSet.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of PHP CS Fixer.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace PhpCsFixer\RuleSet\Sets;
+
+use PhpCsFixer\RuleSet\AbstractMigrationSetDescription;
+
+/**
+ * @internal
+ */
+final class PHP84MigrationSet extends AbstractMigrationSetDescription
+{
+    public function getRules(): array
+    {
+        return [
+            '@PHP83Migration' => true,
+            'nullable_type_declaration_for_default_null_value' => true,
+        ];
+    }
+}
diff --git a/tests/Fixtures/Integration/set/@PHP84Migration.test b/tests/Fixtures/Integration/set/@PHP84Migration.test
@@ -0,0 +1,6 @@
+--TEST--
+Integration of @PHP84Migration.
+--RULESET--
+{"@PHP84Migration": true}
+--REQUIREMENTS--
+{"php": 80400}
diff --git a/tests/Fixtures/Integration/set/@PHP84Migration.test-in.php b/tests/Fixtures/Integration/set/@PHP84Migration.test-in.php
@@ -0,0 +1,3 @@
+<?php
+
+function sample(string $str = null) {}
diff --git a/tests/Fixtures/Integration/set/@PHP84Migration.test-out.php b/tests/Fixtures/Integration/set/@PHP84Migration.test-out.php
@@ -0,0 +1,3 @@
+<?php
+
+function sample(?string $str = null) {}
diff --git a/tests/RuleSet/Sets/PHP84MigrationSetTest.php b/tests/RuleSet/Sets/PHP84MigrationSetTest.php
@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of PHP CS Fixer.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace PhpCsFixer\Tests\RuleSet\Sets;
+
+/**
+ * @internal
+ *
+ * @covers \PhpCsFixer\RuleSet\Sets\PHP84MigrationSet
+ */
+final class PHP84MigrationSetTest extends AbstractSetTestCase {}