BlockControlStructureSpacingSniff: Fixed false positive

Author: kukulich

SlevomatCodingStandard/Sniffs/ControlStructures/AbstractControlStructureSpacing.php

@@ -463,7 +463,19 @@ private function findControlStructureEnd(File $phpcsFile, int $controlStructureP
 
 			foreach ($pointers as $pointer) {
 				if (TokenHelper::findPrevious($phpcsFile, T_SWITCH, $pointer - 1) === $switchPointer) {
-					return TokenHelper::findPreviousExcluding($phpcsFile, T_WHITESPACE, $pointer - 1);
+					$pointerBeforeCaseOrDefault = TokenHelper::findPreviousExcluding($phpcsFile, T_WHITESPACE, $pointer - 1);
+					if (
+						in_array($tokens[$pointerBeforeCaseOrDefault]['code'], Tokens::$commentTokens, true)
+						&& $tokens[$pointerBeforeCaseOrDefault]['line'] + 1 === $tokens[$pointer]['line']
+					) {
+						$pointerBeforeCaseOrDefault = TokenHelper::findPreviousExcluding(
+							$phpcsFile,
+							T_WHITESPACE,
+							$pointerBeforeCaseOrDefault - 1
+						);
+					}
+
+					return $pointerBeforeCaseOrDefault;
 				}
 			}
 

tests/Sniffs/ControlStructures/BlockControlStructureSpacingSniffTest.php

@@ -358,6 +358,8 @@ public function testSwitchErrors(): void
 			'Expected 1 line before "case", found 2.'
 		);
 
+		self::assertNoSniffError($report, 44);
+
 		self::assertAllFixedInFile($report);
 	}
 

tests/Sniffs/ControlStructures/data/blockControlStructureSpacingSwitchErrors.fixed.php

@@ -35,3 +35,16 @@
     case 2:
         return 2;
 }
+
+switch ($foo) {
+	case 1:
+	case 2:
+		echo 'Group 1';
+		break;
+
+	// Group 2
+	case 3:
+	case 4:
+		echo 'Group 2';
+		break;
+}

tests/Sniffs/ControlStructures/data/blockControlStructureSpacingSwitchErrors.php

@@ -38,3 +38,16 @@
     case 2:
         return 2;
 }
+
+switch ($foo) {
+	case 1:
+	case 2:
+		echo 'Group 1';
+		break;
+
+	// Group 2
+	case 3:
+	case 4:
+		echo 'Group 2';
+		break;
+}

tests/Sniffs/ControlStructures/data/blockControlStructureSpacingWithDefaultSettingsNoErrors.php

@@ -101,13 +101,13 @@ function () {
 };
 
 switch ($foo) {
-    case 'bar':
+	case 'bar':
 
-    case 'baz':
-        return true;
+	case 'baz':
+		return true;
 
-    case 'lorem':
-        return false;
+	case 'lorem':
+		return false;
 }
 
 if (true) {