Use lineDistance method to exclude comment lines from consideration.

Author: kagg-design

WPForms/Sniffs/Formatting/SwitchSniff.php

@@ -74,13 +74,13 @@ private function processSwitch( File $phpcsFile, $stackPtr ) {
 			return;
 		}
 
-		if ( $tokens[ $stackPtr ]['line'] - $tokens[ $previous ]['line'] === 1 ) {
+		if ( $this->lineDistance( $phpcsFile, $stackPtr, $previous ) === 1 ) {
 			$this->addEmptyLineError( $phpcsFile, $stackPtr );
 		}
 
 		$beforeClose = $phpcsFile->findPrevious( T_WHITESPACE, $tokens[ $stackPtr ]['scope_closer'] - 1, null, true );
 
-		if ( $tokens[ $tokens[ $stackPtr ]['scope_closer'] ]['line'] - $tokens[ $beforeClose ]['line'] !== 1 ) {
+		if ( $this->lineDistance( $phpcsFile, $tokens[ $stackPtr ]['scope_closer'], $beforeClose ) !== 1 ) {
 			$this->removeEmptyLineError( $phpcsFile, $tokens[ $stackPtr ]['scope_closer'] );
 		}
 
@@ -90,7 +90,7 @@ private function processSwitch( File $phpcsFile, $stackPtr ) {
 			return;
 		}
 
-		if ( $tokens[ $next ]['line'] - $tokens[ $tokens[ $stackPtr ]['scope_closer'] ]['line'] > 1 ) {
+		if ( $this->lineDistance( $phpcsFile, $next, $tokens[ $stackPtr ]['scope_closer'] ) > 1 ) {
 			return;
 		}
 
@@ -158,7 +158,25 @@ private function lineDistance( File $phpcsFile, $endPtr, $startPtr ) {
 
 		$tokens = $phpcsFile->getTokens();
 
-		return $tokens[ $endPtr ]['line'] - $tokens[ $startPtr ]['line'];
+		$ptr = $startPtr + 1;
+
+		$commentLines = [];
+
+		while ( $ptr < $endPtr ) {
+			if (
+				$tokens[ $ptr ]['code'] === T_COMMENT &&
+				$phpcsFile->findFirstOnLine( [ T_WHITESPACE, T_COMMENT ], $ptr, true ) === false
+			) {
+				$commentLines[] = $tokens[ $ptr ]['line'];
+			}
+
+			$ptr ++;
+		}
+
+		return max(
+			0,
+			$tokens[ $endPtr ]['line'] - $tokens[ $startPtr ]['line'] - count( array_unique( $commentLines ) )
+		);
 	}
 
 	/**

WPForms/Tests/TestFiles/Formatting/Switch.php

@@ -8,6 +8,7 @@ public function example( $args ) {
 
 		// Switch comment.
 		switch ( $args ) {
+			// Case comment.
 			case 'a':
 				example( $args );
 				break;

WPForms/Tests/Tests/Formatting/SwitchTest.php

@@ -21,7 +21,7 @@ public function testProcess() {
 
 		$phpcsFile = $this->process( new SwitchSniff() );
 
-		$this->fileHasErrors( $phpcsFile, 'AddEmptyLineBefore', [ 63, 69, 89, 94, 97 ] );
-		$this->fileHasErrors( $phpcsFile, 'RemoveEmptyLineBefore', [ 65, 68, 71, 74, 79, 88, 93 ] );
+		$this->fileHasErrors( $phpcsFile, 'AddEmptyLineBefore', [ 64, 70, 90, 95, 98 ] );
+		$this->fileHasErrors( $phpcsFile, 'RemoveEmptyLineBefore', [ 66, 69, 72, 75, 80, 89, 94 ] );
 	}
 }