Merge pull request #96 from PHPCSStandards/feature/qa-remove-unreachable-code

jrfnl · web-flow · commit 931f4753d36b · 2023-12-04T16:42:58.000+01:00
QA: remove unreachable code
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -142,6 +142,11 @@
         <type>error</type>
     </rule>
 
+    <!-- Do not allow unreachable code. -->
+    <rule ref="Squiz.PHP.NonExecutableCode">
+        <type>error</type>
+    </rule>
+
     <!-- The testing bootstrap file uses string concats to stop IDEs seeing the class aliases -->
     <rule ref="Generic.Strings.UnnecessaryStringConcat">
         <exclude-pattern>tests/bootstrap\.php</exclude-pattern>
diff --git a/src/Sniffs/AbstractScopeSniff.php b/src/Sniffs/AbstractScopeSniff.php
@@ -148,8 +148,6 @@ final public function process(File $phpcsFile, $stackPtr)
             return min($skipTokens);
         }
 
-        return;
-
     }//end process()
 
 
diff --git a/src/Standards/Generic/Tests/Classes/DuplicateClassNameUnitTest.php b/src/Standards/Generic/Tests/Classes/DuplicateClassNameUnitTest.php
@@ -50,27 +50,26 @@ public function getWarningList($testFile='')
                 12 => 1,
                 13 => 1,
             ];
-            break;
+
         case 'DuplicateClassNameUnitTest.2.inc':
             return [
                 2 => 1,
                 3 => 1,
                 4 => 1,
                 5 => 1,
             ];
-            break;
+
         case 'DuplicateClassNameUnitTest.5.inc':
             return [
                 3 => 1,
                 7 => 1,
             ];
-            break;
+
         case 'DuplicateClassNameUnitTest.6.inc':
             return [10 => 1];
-            break;
+
         default:
             return [];
-            break;
         }//end switch
 
     }//end getWarningList()
diff --git a/src/Standards/Generic/Tests/Files/InlineHTMLUnitTest.php b/src/Standards/Generic/Tests/Files/InlineHTMLUnitTest.php
@@ -30,16 +30,15 @@ public function getErrorList($testFile='')
         switch ($testFile) {
         case 'InlineHTMLUnitTest.3.inc':
             return [4 => 1];
-            break;
+
         case 'InlineHTMLUnitTest.4.inc':
             return [1 => 1];
-            break;
+
         case 'InlineHTMLUnitTest.7.inc':
             return [1 => 1];
-            break;
+
         default:
             return [];
-            break;
         }//end switch
 
     }//end getErrorList()
diff --git a/src/Standards/Generic/Tests/Files/LineLengthUnitTest.php b/src/Standards/Generic/Tests/Files/LineLengthUnitTest.php
@@ -50,14 +50,13 @@ public function getErrorList($testFile='')
                 45 => 1,
                 82 => 1,
             ];
-            break;
+
         case 'LineLengthUnitTest.2.inc':
         case 'LineLengthUnitTest.3.inc':
             return [7 => 1];
-            break;
+
         default:
             return [];
-            break;
         }//end switch
 
     }//end getErrorList()
@@ -89,20 +88,19 @@ public function getWarningList($testFile='')
                 75 => 1,
                 84 => 1,
             ];
-            break;
+
         case 'LineLengthUnitTest.2.inc':
         case 'LineLengthUnitTest.3.inc':
             return [6 => 1];
-            break;
+
         case 'LineLengthUnitTest.4.inc':
             return [
                 10 => 1,
                 14 => 1,
             ];
-            break;
+
         default:
             return [];
-            break;
         }//end switch
 
     }//end getWarningList()
diff --git a/src/Standards/Generic/Tests/Formatting/MultipleStatementAlignmentUnitTest.php b/src/Standards/Generic/Tests/Formatting/MultipleStatementAlignmentUnitTest.php
@@ -122,7 +122,7 @@ public function getWarningList($testFile='MultipleStatementAlignmentUnitTest.inc
                 499 => 1,
                 500 => 1,
             ];
-        break;
+
         case 'MultipleStatementAlignmentUnitTest.js':
             return [
                 11  => 1,
@@ -154,10 +154,9 @@ public function getWarningList($testFile='MultipleStatementAlignmentUnitTest.inc
                 114 => 1,
                 117 => 1,
             ];
-            break;
+
         default:
             return [];
-            break;
         }//end switch
 
     }//end getWarningList()
diff --git a/src/Standards/Generic/Tests/PHP/CharacterBeforePHPOpeningTagUnitTest.php b/src/Standards/Generic/Tests/PHP/CharacterBeforePHPOpeningTagUnitTest.php
@@ -30,10 +30,9 @@ public function getErrorList($testFile='')
         switch ($testFile) {
         case 'CharacterBeforePHPOpeningTagUnitTest.1.inc':
             return [2 => 1];
-            break;
+
         default:
             return [];
-            break;
         }//end switch
 
     }//end getErrorList()
diff --git a/src/Standards/Generic/Tests/PHP/ClosingPHPTagUnitTest.php b/src/Standards/Generic/Tests/PHP/ClosingPHPTagUnitTest.php
@@ -30,12 +30,12 @@ public function getErrorList($testFile='')
         switch ($testFile) {
         case 'ClosingPHPTagUnitTest.1.inc':
             return [9 => 1];
+
         case 'ClosingPHPTagUnitTest.2.inc':
             return [5 => 1];
-            break;
+
         default:
             return [];
-            break;
         }
 
     }//end getErrorList()
diff --git a/src/Standards/Generic/Tests/PHP/LowerCaseConstantUnitTest.php b/src/Standards/Generic/Tests/PHP/LowerCaseConstantUnitTest.php
@@ -52,7 +52,7 @@ public function getErrorList($testFile='LowerCaseConstantUnitTest.inc')
                 95  => 1,
                 100 => 2,
             ];
-        break;
+
         case 'LowerCaseConstantUnitTest.js':
             return [
                 2  => 1,
@@ -64,10 +64,9 @@ public function getErrorList($testFile='LowerCaseConstantUnitTest.inc')
                 13 => 1,
                 14 => 1,
             ];
-            break;
+
         default:
             return [];
-            break;
         }//end switch
 
     }//end getErrorList()
diff --git a/src/Standards/Generic/Tests/PHP/RequireStrictTypesUnitTest.php b/src/Standards/Generic/Tests/PHP/RequireStrictTypesUnitTest.php
@@ -30,7 +30,6 @@ public function getErrorList($testFile='')
         switch ($testFile) {
         case 'RequireStrictTypesUnitTest.1.inc':
             return [];
-            break;
         }
 
         return [1 => 1];
diff --git a/src/Standards/Generic/Tests/PHP/SyntaxUnitTest.php b/src/Standards/Generic/Tests/PHP/SyntaxUnitTest.php
@@ -32,10 +32,9 @@ public function getErrorList($testFile='')
         case 'SyntaxUnitTest.1.inc':
         case 'SyntaxUnitTest.2.inc':
             return [3 => 1];
-            break;
+
         default:
             return [];
-            break;
         }
 
     }//end getErrorList()
diff --git a/src/Standards/Generic/Tests/Strings/UnnecessaryStringConcatUnitTest.php b/src/Standards/Generic/Tests/Strings/UnnecessaryStringConcatUnitTest.php
@@ -37,7 +37,7 @@ public function getErrorList($testFile='UnnecessaryStringConcatUnitTest.inc')
                 19 => 1,
                 20 => 1,
             ];
-            break;
+
         case 'UnnecessaryStringConcatUnitTest.js':
             return [
                 1  => 1,
@@ -46,10 +46,9 @@ public function getErrorList($testFile='UnnecessaryStringConcatUnitTest.inc')
                 14 => 1,
                 15 => 1,
             ];
-            break;
+
         default:
             return [];
-            break;
         }//end switch
 
     }//end getErrorList()
diff --git a/src/Standards/Generic/Tests/WhiteSpace/DisallowSpaceIndentUnitTest.php b/src/Standards/Generic/Tests/WhiteSpace/DisallowSpaceIndentUnitTest.php
@@ -85,7 +85,7 @@ public function getErrorList($testFile='DisallowSpaceIndentUnitTest.1.inc')
                 117 => 1,
                 118 => 1,
             ];
-            break;
+
         case 'DisallowSpaceIndentUnitTest.3.inc':
             return [
                 2  => 1,
@@ -96,16 +96,15 @@ public function getErrorList($testFile='DisallowSpaceIndentUnitTest.1.inc')
                 14 => 1,
                 15 => 1,
             ];
-            break;
+
         case 'DisallowSpaceIndentUnitTest.js':
             return [3 => 1];
-            break;
+
         case 'DisallowSpaceIndentUnitTest.css':
             return [2 => 1];
-            break;
+
         default:
             return [];
-            break;
         }//end switch
 
     }//end getErrorList()
diff --git a/src/Standards/Squiz/Sniffs/WhiteSpace/MemberVarSpacingSniff.php b/src/Standards/Squiz/Sniffs/WhiteSpace/MemberVarSpacingSniff.php
@@ -212,8 +212,6 @@ protected function processMemberVar(File $phpcsFile, $stackPtr)
             return $endOfStatement;
         }
 
-        return;
-
     }//end processMemberVar()
 
 
diff --git a/src/Standards/Squiz/Tests/Commenting/LongConditionClosingCommentUnitTest.php b/src/Standards/Squiz/Tests/Commenting/LongConditionClosingCommentUnitTest.php
@@ -60,7 +60,7 @@ public function getErrorList($testFile='LongConditionClosingCommentUnitTest.inc'
                 1008 => 1,
                 1032 => 1,
             ];
-            break;
+
         case 'LongConditionClosingCommentUnitTest.js':
             return [
                 47  => 1,
@@ -76,10 +76,9 @@ public function getErrorList($testFile='LongConditionClosingCommentUnitTest.inc'
                 439 => 1,
                 444 => 1,
             ];
-            break;
+
         default:
             return [];
-            break;
         }//end switch
 
     }//end getErrorList()
diff --git a/src/Standards/Squiz/Tests/Formatting/OperatorBracketUnitTest.php b/src/Standards/Squiz/Tests/Formatting/OperatorBracketUnitTest.php
@@ -73,7 +73,7 @@ public function getErrorList($testFile='OperatorBracketUnitTest.inc')
                 193 => 1,
                 194 => 2,
             ];
-            break;
+
         case 'OperatorBracketUnitTest.js':
             return [
                 5   => 1,
@@ -90,10 +90,9 @@ public function getErrorList($testFile='OperatorBracketUnitTest.inc')
                 63  => 1,
                 108 => 1,
             ];
-             break;
+
         default:
             return [];
-            break;
         }//end switch
 
     }//end getErrorList()
diff --git a/src/Standards/Squiz/Tests/Operators/ComparisonOperatorUsageUnitTest.php b/src/Standards/Squiz/Tests/Operators/ComparisonOperatorUsageUnitTest.php
@@ -59,7 +59,7 @@ public function getErrorList($testFile='ComparisonOperatorUsageUnitTest.inc')
                 131 => 1,
                 135 => 1,
             ];
-            break;
+
         case 'ComparisonOperatorUsageUnitTest.js':
             return [
                 5  => 1,
@@ -74,10 +74,9 @@ public function getErrorList($testFile='ComparisonOperatorUsageUnitTest.inc')
                 67 => 1,
                 71 => 1,
             ];
-            break;
+
         default:
             return [];
-            break;
         }//end switch
 
     }//end getErrorList()
diff --git a/src/Standards/Squiz/Tests/PHP/CommentedOutCodeUnitTest.php b/src/Standards/Squiz/Tests/PHP/CommentedOutCodeUnitTest.php
@@ -58,16 +58,15 @@ public function getWarningList($testFile='CommentedOutCodeUnitTest.inc')
                 147 => 1,
                 158 => 1,
             ];
-            break;
+
         case 'CommentedOutCodeUnitTest.css':
             return [
                 7  => 1,
                 16 => 1,
             ];
-            break;
+
         default:
             return [];
-            break;
         }//end switch
 
     }//end getWarningList()
diff --git a/src/Standards/Squiz/Tests/PHP/DisallowInlineIfUnitTest.php b/src/Standards/Squiz/Tests/PHP/DisallowInlineIfUnitTest.php
@@ -33,13 +33,12 @@ public function getErrorList($testFile='DisallowInlineIfUnitTest.inc')
                 8  => 1,
                 18 => 1,
             ];
-            break;
+
         case 'DisallowInlineIfUnitTest.js':
             return [1 => 1];
-            break;
+
         default:
             return [];
-            break;
         }//end switch
 
     }//end getErrorList()
diff --git a/src/Standards/Squiz/Tests/PHP/DisallowSizeFunctionsInLoopsUnitTest.php b/src/Standards/Squiz/Tests/PHP/DisallowSizeFunctionsInLoopsUnitTest.php
@@ -43,13 +43,12 @@ public function getErrorList($testFile='DisallowSizeFunctionsInLoopsUnitTest.inc
                 44 => 1,
                 46 => 1,
             ];
-            break;
+
         case 'DisallowSizeFunctionsInLoopsUnitTest.js':
             return [1 => 1];
-            break;
+
         default:
             return [];
-            break;
         }//end switch
 
     }//end getErrorList()
diff --git a/src/Standards/Squiz/Tests/PHP/NonExecutableCodeUnitTest.php b/src/Standards/Squiz/Tests/PHP/NonExecutableCodeUnitTest.php
diff --git a/src/Standards/Squiz/Tests/WhiteSpace/ControlStructureSpacingUnitTest.php b/src/Standards/Squiz/Tests/WhiteSpace/ControlStructureSpacingUnitTest.php
diff --git a/src/Standards/Squiz/Tests/WhiteSpace/FunctionClosingBraceSpaceUnitTest.php b/src/Standards/Squiz/Tests/WhiteSpace/FunctionClosingBraceSpaceUnitTest.php
diff --git a/src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.php b/src/Standards/Squiz/Tests/WhiteSpace/OperatorSpacingUnitTest.php
diff --git a/src/Standards/Squiz/Tests/WhiteSpace/SemicolonSpacingUnitTest.php b/src/Standards/Squiz/Tests/WhiteSpace/SemicolonSpacingUnitTest.php
diff --git a/src/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.php b/src/Standards/Squiz/Tests/WhiteSpace/SuperfluousWhitespaceUnitTest.php
diff --git a/tests/Standards/AbstractSniffUnitTest.php b/tests/Standards/AbstractSniffUnitTest.php

Original file line number	Diff line number	Diff line change
`@@ -148,8 +148,6 @@ final public function process(File $phpcsFile, $stackPtr)`
`148`	`148`	`return min($skipTokens);`
`149`	`149`	`}`
`150`	`150`
`151`		`- return;`
`152`		`-`
`153`	`151`	`}//end process()`
`154`	`152`
`155`	`153`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,6 @@ public function getErrorList($testFile='')`
`30`	`30`	`switch ($testFile) {`
`31`	`31`	`case 'RequireStrictTypesUnitTest.1.inc':`
`32`	`32`	`return [];`
`33`		`- break;`
`34`	`33`	`}`
`35`	`34`
`36`	`35`	`return [1 => 1];`