Allow comment before switch and case statements.

Author: kagg-design

WPForms/Sniffs/Formatting/SwitchSniff.php

@@ -68,9 +68,9 @@ public function process( File $phpcsFile, $stackPtr ) {
 	private function processSwitch( File $phpcsFile, $stackPtr ) {
 
 		$tokens   = $phpcsFile->getTokens();
-		$previous = $phpcsFile->findPrevious( T_WHITESPACE, $stackPtr - 1, null, true );
+		$previous = $phpcsFile->findPrevious( [ T_WHITESPACE, T_COMMENT ], $stackPtr - 1, null, true );
 
-		if ( $previous === false ) {
+		if ( $previous === false || $tokens[ $previous ]['code'] === T_COMMENT ) {
 			return;
 		}
 
@@ -108,11 +108,16 @@ private function processSwitch( File $phpcsFile, $stackPtr ) {
 	private function processCase( File $phpcsFile, $stackPtr ) {
 
 		$tokens            = $phpcsFile->getTokens();
-		$previous          = $phpcsFile->findPrevious( T_WHITESPACE, $stackPtr - 1, null, true );
+		$previous          = $phpcsFile->findPrevious( [ T_WHITESPACE, T_COMMENT ], $stackPtr - 1, null, true );
 		$previousStatement = $phpcsFile->findFirstOnLine( [ T_SWITCH, T_CASE, T_DEFAULT, T_BREAK ], $previous );
 
+		if ( $previousStatement === false ) {
+			$this->addEmptyLineError( $phpcsFile, $stackPtr );
+
+			return;
+		}
+
 		if (
-			! empty( $previousStatement ) &&
 			$tokens[ $previousStatement ]['code'] === T_SWITCH &&
 			$tokens[ $previousStatement ]['line'] !== $tokens[ $stackPtr ]['line'] - 1
 		) {
@@ -122,11 +127,8 @@ private function processCase( File $phpcsFile, $stackPtr ) {
 		}
 
 		if (
-			empty( $previousStatement ) ||
-			(
-				$tokens[ $previousStatement ]['code'] === T_BREAK &&
-				$tokens[ $stackPtr ]['line'] - $tokens[ $previousStatement ]['line'] === 1
-			)
+			$tokens[ $previousStatement ]['code'] === T_BREAK &&
+			$tokens[ $stackPtr ]['line'] - $tokens[ $previousStatement ]['line'] === 1
 		) {
 			$this->addEmptyLineError( $phpcsFile, $stackPtr );
 

WPForms/Tests/TestFiles/Formatting/Switch.php

@@ -6,11 +6,13 @@ public function example( $args ) {
 
 		$this->get_value();
 
+		// Switch comment.
 		switch ( $args ) {
 			case 'a':
 				example( $args );
 				break;
 
+			// Case comment.
 			case 'b':
 			case 'c':
 				$value = 2;
@@ -19,6 +21,7 @@ public function example( $args ) {
 			case 'd':
 				break;
 
+			// Default comment.
 			default:
 				$value = 3;
 		}

WPForms/Tests/Tests/Formatting/SwitchTest.php

@@ -21,7 +21,7 @@ public function testProcess() {
 
 		$phpcsFile = $this->process( new SwitchSniff() );
 
-		$this->fileHasErrors( $phpcsFile, 'AddEmptyLineBefore', [ 60, 66, 86, 91, 94 ] );
-		$this->fileHasErrors( $phpcsFile, 'RemoveEmptyLineBefore', [ 62, 65, 68, 71, 76, 85, 90 ] );
+		$this->fileHasErrors( $phpcsFile, 'AddEmptyLineBefore', [ 63, 69, 89, 94, 97 ] );
+		$this->fileHasErrors( $phpcsFile, 'RemoveEmptyLineBefore', [ 65, 68, 71, 74, 79, 88, 93 ] );
 	}
 }