feat: add support for typed constants in AlphabeticallyOrderedConstantsSniff (#142)

Co-authored-by: David Kurka <[email protected]>

Author: davidxkurka

src/Cdn77/Sniffs/Ordering/AlphabeticallyOrderedConstantsSniff.php

@@ -30,10 +30,19 @@
 use const T_WHITESPACE;
 
 /**
- * @phpstan-type NameWithValueShape array{
+ * @phpstan-type TypeNameValueShape array{
+ *       type: TypeShape|null,
  *       name: NameShape,
  *       value: ValueShape
  *  }
+ * @phpstan-type TypeNameShape array{
+ *       type: TypeShape|null,
+ *       name: NameShape
+ *  }
+ * @phpstan-type TypeShape array{
+ *       content: string,
+ *       ptr: int
+ *  }
  * @phpstan-type NameShape array{
  *       content: string,
  *       lowercaseContent: string,
@@ -89,7 +98,7 @@ public function process(File $phpcsFile, mixed $stackPtr): void
         }
     }
 
-    /** @param list<NameWithValueShape> $namesWithValues */
+    /** @param list<TypeNameValueShape> $namesWithValues */
     private function fix(File $file, array $namesWithValues): void
     {
         $fixer = $file->fixer;
@@ -104,9 +113,19 @@ private function fix(File $file, array $namesWithValues): void
         foreach ($namesWithValues as $key => $nameWithValue) {
             $sortedNameAndValueToken = $sortedNameAndValueTokens[$key];
 
+            $typePointer = $nameWithValue['type']['ptr'] ?? null;
             $namePointer = $nameWithValue['name']['ptr'];
-            FixerHelper::removeBetweenIncluding($file, $namePointer, $namePointer);
-            $fixer->addContent($namePointer, $sortedNameAndValueToken['name']['content']);
+            FixerHelper::removeBetweenIncluding($file, $typePointer ?? $namePointer, $namePointer);
+            $fixer->addContent(
+                $typePointer ?? $namePointer,
+                $sortedNameAndValueToken['type'] === null ?
+                    $sortedNameAndValueToken['name']['content']
+                    : sprintf(
+                        '%s %s',
+                        $sortedNameAndValueToken['type']['content'],
+                        $sortedNameAndValueToken['name']['content'],
+                    ),
+            );
 
             $value = $nameWithValue['value'];
             FixerHelper::removeBetweenIncluding($file, $value['startPtr'], $value['endPtr']);
@@ -116,7 +135,7 @@ private function fix(File $file, array $namesWithValues): void
         $fixer->endChangeset();
     }
 
-    /** @return array<string, list<NameWithValueShape>> */
+    /** @return array<string, list<TypeNameValueShape>> */
     private function findConstantNamesWithValuesByVisibility(File $phpcsFile): array
     {
         $constantNamesWithValues = [];
@@ -128,13 +147,13 @@ private function findConstantNamesWithValuesByVisibility(File $phpcsFile): array
             }
 
             $visibility = $this->getVisibility($phpcsFile, $stackPtr);
-            $constantName = $this->findConstantName($phpcsFile, $stackPtr);
+            $typeAndConstantName = $this->findTypeAndConstantName($phpcsFile, $stackPtr);
 
-            if ($constantName === null) {
+            if ($typeAndConstantName === null) {
                 continue;
             }
 
-            $equalsTokenPointer = $this->findEqualsPointer($phpcsFile, $constantName['ptr']);
+            $equalsTokenPointer = $this->findEqualsPointer($phpcsFile, $typeAndConstantName['name']['ptr']);
 
             if ($equalsTokenPointer === null) {
                 continue;
@@ -147,7 +166,8 @@ private function findConstantNamesWithValuesByVisibility(File $phpcsFile): array
             }
 
             $constantNamesWithValues[$visibility][] = [
-                'name' => $constantName,
+                'type' => $typeAndConstantName['type'],
+                'name' => $typeAndConstantName['name'],
                 'value' => $value,
             ];
         }
@@ -170,25 +190,52 @@ private function getVisibility(File $phpcsFile, int $constStackPtr): string
             : 'public';
     }
 
-    /** @phpstan-return NameShape|null */
-    private function findConstantName(File $phpcsFile, int $constStackPtr): array|null
+    /** @phpstan-return TypeNameShape|null */
+    private function findTypeAndConstantName(File $phpcsFile, int $constStackPtr): array|null
     {
         $tokens = $phpcsFile->getTokens();
-        $constantNameTokenPointer = $phpcsFile->findNext(
-            types: Tokens::$emptyTokens,
+        $assignmentOperatorTokenPtr = $phpcsFile->findNext(
+            types: [T_EQUAL, T_SEMICOLON],
             start: $constStackPtr + 1,
+        );
+
+        if ($assignmentOperatorTokenPtr === false || $tokens[$assignmentOperatorTokenPtr]['code'] !== T_EQUAL) {
+            return null;
+        }
+
+        $constNameTokenPtr = $phpcsFile->findPrevious(
+            types: Tokens::$emptyTokens,
+            start: $assignmentOperatorTokenPtr - 1,
+            end: $constStackPtr + 1,
             exclude: true,
-            local: true,
         );
 
-        if ($constantNameTokenPointer === false || $tokens[$constantNameTokenPointer]['code'] !== T_STRING) {
+        if ($constNameTokenPtr === false || $tokens[$constNameTokenPtr]['code'] !== T_STRING) {
             return null;
         }
 
+        $type = null;
+        $typeTokenPtr = $phpcsFile->findPrevious(
+            types: Tokens::$emptyTokens,
+            start: $constNameTokenPtr - 1,
+            end: $constStackPtr,
+            exclude: true,
+        );
+
+        if ($typeTokenPtr !== false && $tokens[$typeTokenPtr]['code'] === T_STRING) {
+            $type = [
+                'content' => $tokens[$typeTokenPtr]['content'],
+                'ptr' => $typeTokenPtr,
+            ];
+        }
+
         return [
-            'content' => $tokens[$constantNameTokenPointer]['content'],
-            'lowercaseContent' => strtolower($tokens[$constantNameTokenPointer]['content']),
-            'ptr' => $constantNameTokenPointer,
+            'type' => $type,
+            'name' => [
+                'content' => $tokens[$constNameTokenPtr]['content'],
+                'lowercaseContent' => strtolower($tokens[$constNameTokenPtr]['content']),
+                'ptr' => $constNameTokenPtr,
+            ],
         ];
     }
 

tests/Sniffs/Ordering/data/AlphabeticallyOrderedConstantsSniffTest.fixed.inc

@@ -16,8 +16,8 @@ final class TestClass
     public const C = 'c' . PHP_EOL;
     public const D = [123, 'test'];
 
-    protected const E = 'e';
-    protected const F = 'f';
+    protected const string E = 'e';
+    protected const int F = 123;
     protected const G = 'g';
     protected const Ha = 'h';
     protected const HB = 'h';

tests/Sniffs/Ordering/data/AlphabeticallyOrderedConstantsSniffTest.inc

@@ -16,9 +16,9 @@ final class TestClass
     public const D = [123, 'test'];
     public const B = 'b';
 
-    protected const E = 'e';
     protected const G = 'g';
-    protected const F = 'f';
+    protected const string E = 'e';
+    protected const int F = 123;
     protected const HB = 'h';
     protected const Ha = 'h';