Feat: Add OrderedClassElementsFixer with specified order of elements …

…(part of #94)
lmc-eu · May 23, 2024 · 837c3f3 · 837c3f3
1 parent 6312ff0
commit 837c3f3
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 0 deletions.
diff --git a/ecs.php b/ecs.php
@@ -55,6 +55,7 @@
 use PhpCsFixer\Fixer\CastNotation\ShortScalarCastFixer;
 use PhpCsFixer\Fixer\ClassNotation\ClassAttributesSeparationFixer;
 use PhpCsFixer\Fixer\ClassNotation\NoBlankLinesAfterClassOpeningFixer;
+use PhpCsFixer\Fixer\ClassNotation\OrderedClassElementsFixer;
 use PhpCsFixer\Fixer\ClassNotation\SelfAccessorFixer;
 use PhpCsFixer\Fixer\ClassNotation\SingleTraitInsertPerStatementFixer;
 use PhpCsFixer\Fixer\ClassNotation\VisibilityRequiredFixer;
@@ -519,6 +520,23 @@
             'use_trait',
         ],
     ])
+    // Elements of classes/interfaces/traits/enums should be in the defined order
+    ->withConfiguredRule(
+        OrderedClassElementsFixer::class,
+        [
+            'order' => [
+                'use_trait',
+                'case', // enum values should be before other elements
+                'constant',
+                'property',
+                'construct',
+                'destruct',
+                'magic',
+                'phpunit', // phpunit special methods like setUp should be before test methods
+                'method',
+            ],
+        ],
+    )
     ->withSkip([
         // We allow empty catch statements (but they must have comment - see EmptyCatchCommentSniff)
         EmptyStatementSniff::class . '.DetectedCatch' => null,

diff --git a/tests/Integration/Fixtures/Basic.correct.php.inc b/tests/Integration/Fixtures/Basic.correct.php.inc
@@ -4,8 +4,13 @@ use Bar\Foo; // NoUnneededImportAliasFixer
 
 class Basic
 {
+    use SomeUsefulTrait; // OrderedClassElementsFixer
     public const FOO = 'foo'; // ClassAttributesSeparationFixer
 
+    public const MY_PUBLIC_CONST = 333; // OrderedClassElementsFixer
+
+    protected int $myProperty = 666; // OrderedClassElementsFixer
+
     public function isEqual($a, ?string $b): ?bool // VisibilityRequiredFixer, CompactNullableTypeDeclarationFixer
     {
         // TrimArraySpacesFixer

diff --git a/tests/Integration/Fixtures/Basic.wrong.php.inc b/tests/Integration/Fixtures/Basic.wrong.php.inc
@@ -29,6 +29,8 @@ class Basic
         return false; // BlankLineBeforeStatementFixer
     }
 
+    public const MY_PUBLIC_CONST = 333; // OrderedClassElementsFixer
+
     public function fooBar(mixed $foo): mixed
     {
         // PhpdocToCommentFixer
@@ -47,4 +49,8 @@ class Basic
         // TernaryToElvisOperatorFixer
         return ($foo ? $foo : 'not true');
     }
+
+    protected int $myProperty = 666; // OrderedClassElementsFixer
+
+    use SomeUsefulTrait; // OrderedClassElementsFixer
 }