Removed all parse error warnings from sniffs (#990)

jrfnl · gsherwood · web-flow · commit c0bd2bb00675 · 2025-04-15T12:32:17.000+02:00
* Removed all parse error warnings from sniffs

Ref:
* squizlabs/PHP_CodeSniffer 2455

---------

Co-authored-by: Greg Sherwood &lt;gsherwood@squiz.net&gt;
Co-authored-by: jrfnl &lt;jrfnl@users.noreply.github.com&gt;
diff --git a/src/Standards/Generic/Sniffs/Classes/OpeningBraceSameLineSniff.php b/src/Standards/Generic/Sniffs/Classes/OpeningBraceSameLineSniff.php
@@ -49,8 +49,7 @@ public function process(File $phpcsFile, $stackPtr)
         $errorData       = [strtolower($tokens[$stackPtr]['content']).' '.$tokens[$scopeIdentifier]['content']];
 
         if (isset($tokens[$stackPtr]['scope_opener']) === false) {
-            $error = 'Possible parse error: %s missing opening or closing brace';
-            $phpcsFile->addWarning($error, $stackPtr, 'MissingBrace', $errorData);
+            // Parse error or live coding.
             return;
         }
 
diff --git a/src/Standards/Generic/Tests/Classes/OpeningBraceSameLineUnitTest.inc b/src/Standards/Generic/Tests/Classes/OpeningBraceSameLineUnitTest.inc
@@ -47,7 +47,7 @@ class Test_Class_Bad_H extends Test_Class_Bad_G			{
 class Test_Class_Bad_I implements Test_Interface_Bad_C{
 }
 
-// This one should be flagged as a potential parse error.
+// This one should be ignored as a potential parse error.
 class Test_Class_Bad_H
 
 // This is OK.
diff --git a/src/Standards/Generic/Tests/Classes/OpeningBraceSameLineUnitTest.inc.fixed b/src/Standards/Generic/Tests/Classes/OpeningBraceSameLineUnitTest.inc.fixed
@@ -47,7 +47,7 @@ class Test_Class_Bad_H extends Test_Class_Bad_G {
 class Test_Class_Bad_I implements Test_Interface_Bad_C {
 }
 
-// This one should be flagged as a potential parse error.
+// This one should be ignored as a potential parse error.
 class Test_Class_Bad_H
 
 // This is OK.
diff --git a/src/Standards/Generic/Tests/Classes/OpeningBraceSameLineUnitTest.php b/src/Standards/Generic/Tests/Classes/OpeningBraceSameLineUnitTest.php
@@ -60,7 +60,7 @@ public function getErrorList()
      */
     public function getWarningList()
     {
-        return [51 => 1];
+        return [];
 
     }//end getWarningList()
 
diff --git a/src/Standards/PEAR/Sniffs/Classes/ClassDeclarationSniff.php b/src/Standards/PEAR/Sniffs/Classes/ClassDeclarationSniff.php
@@ -48,8 +48,7 @@ public function process(File $phpcsFile, $stackPtr)
         $errorData = [strtolower($tokens[$stackPtr]['content'])];
 
         if (isset($tokens[$stackPtr]['scope_opener']) === false) {
-            $error = 'Possible parse error: %s missing opening or closing brace';
-            $phpcsFile->addWarning($error, $stackPtr, 'MissingBrace', $errorData);
+            // Parse error or live coding.
             return;
         }
 
diff --git a/src/Standards/PEAR/Tests/Classes/ClassDeclarationUnitTest.2.inc b/src/Standards/PEAR/Tests/Classes/ClassDeclarationUnitTest.2.inc
@@ -7,5 +7,5 @@ if (!class_exists('ClassOpeningBraceTabIndented')) {
 }
 
 
-// Needs to be last test in the file. Intentional parse error.
+// Needs to be last test in the file. Intentional parse error. Should be ignored.
 class MyParseError extends Exception
diff --git a/src/Standards/PEAR/Tests/Classes/ClassDeclarationUnitTest.php b/src/Standards/PEAR/Tests/Classes/ClassDeclarationUnitTest.php
@@ -88,10 +88,6 @@ public function getErrorList($testFile='')
      */
     public function getWarningList($testFile='')
     {
-        if ($testFile === 'ClassDeclarationUnitTest.2.inc') {
-            return [11 => 1];
-        }
-
         return[];
 
     }//end getWarningList()
diff --git a/src/Standards/Squiz/Sniffs/Classes/ValidClassNameSniff.php b/src/Standards/Squiz/Sniffs/Classes/ValidClassNameSniff.php
@@ -49,9 +49,7 @@ public function process(File $phpcsFile, $stackPtr)
         $tokens = $phpcsFile->getTokens();
 
         if (isset($tokens[$stackPtr]['scope_opener']) === false) {
-            $error = 'Possible parse error: %s missing opening or closing brace';
-            $data  = [$tokens[$stackPtr]['content']];
-            $phpcsFile->addWarning($error, $stackPtr, 'MissingBrace', $data);
+            // Parse error or live coding.
             return;
         }
 
diff --git a/src/Standards/Squiz/Sniffs/Commenting/ClosingDeclarationCommentSniff.php b/src/Standards/Squiz/Sniffs/Commenting/ClosingDeclarationCommentSniff.php
@@ -62,8 +62,7 @@ public function process(File $phpcsFile, $stackPtr)
             }
 
             if (isset($tokens[$stackPtr]['scope_closer']) === false) {
-                $error = 'Possible parse error: non-abstract method defined as abstract';
-                $phpcsFile->addWarning($error, $stackPtr, 'Abstract');
+                // Parse error or live coding.
                 return;
             }
 
@@ -80,9 +79,7 @@ public function process(File $phpcsFile, $stackPtr)
         }//end if
 
         if (isset($tokens[$stackPtr]['scope_closer']) === false) {
-            $error = 'Possible parse error: %s missing opening or closing brace';
-            $data  = [$tokens[$stackPtr]['content']];
-            $phpcsFile->addWarning($error, $stackPtr, 'MissingBrace', $data);
+            // Parse error or live coding.
             return;
         }
 
diff --git a/src/Standards/Squiz/Sniffs/ControlStructures/ForEachLoopDeclarationSniff.php b/src/Standards/Squiz/Sniffs/ControlStructures/ForEachLoopDeclarationSniff.php
@@ -59,14 +59,12 @@ public function process(File $phpcsFile, $stackPtr)
 
         $openingBracket = $phpcsFile->findNext(T_OPEN_PARENTHESIS, $stackPtr);
         if ($openingBracket === false) {
-            $error = 'Possible parse error: FOREACH has no opening parenthesis';
-            $phpcsFile->addWarning($error, $stackPtr, 'MissingOpenParenthesis');
+            // Parse error or live coding.
             return;
         }
 
         if (isset($tokens[$openingBracket]['parenthesis_closer']) === false) {
-            $error = 'Possible parse error: FOREACH has no closing parenthesis';
-            $phpcsFile->addWarning($error, $stackPtr, 'MissingCloseParenthesis');
+            // Parse error or live coding.
             return;
         }
 
@@ -134,8 +132,7 @@ public function process(File $phpcsFile, $stackPtr)
 
         $asToken = $phpcsFile->findNext(T_AS, $openingBracket);
         if ($asToken === false) {
-            $error = 'Possible parse error: FOREACH has no AS statement';
-            $phpcsFile->addWarning($error, $stackPtr, 'MissingAs');
+            // Parse error or live coding.
             return;
         }
 
diff --git a/src/Standards/Squiz/Sniffs/ControlStructures/ForLoopDeclarationSniff.php b/src/Standards/Squiz/Sniffs/ControlStructures/ForLoopDeclarationSniff.php
@@ -67,8 +67,7 @@ public function process(File $phpcsFile, $stackPtr)
 
         $openingBracket = $phpcsFile->findNext(T_OPEN_PARENTHESIS, $stackPtr);
         if ($openingBracket === false || isset($tokens[$openingBracket]['parenthesis_closer']) === false) {
-            $error = 'Possible parse error: no opening/closing parenthesis for FOR keyword';
-            $phpcsFile->addWarning($error, $stackPtr, 'NoOpenBracket');
+            // Parse error or live coding.
             return;
         }
 
diff --git a/src/Standards/Squiz/Sniffs/ControlStructures/SwitchDeclarationSniff.php b/src/Standards/Squiz/Sniffs/ControlStructures/SwitchDeclarationSniff.php
@@ -123,8 +123,7 @@ public function process(File $phpcsFile, $stackPtr)
             }
 
             if (isset($tokens[$nextCase]['scope_opener']) === false) {
-                $error = 'Possible parse error: CASE missing opening colon';
-                $phpcsFile->addWarning($error, $nextCase, 'MissingColon');
+                // Parse error or live coding.
                 continue;
             }
 
diff --git a/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.1.inc b/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.1.inc
@@ -68,7 +68,7 @@ interface TestClass
 
 class MyClass
 {
-    public function myFunction();
+    public function parseErrorMustBeIgnored();
 }//end class
 
 // Closures don't need end comments.
diff --git a/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.1.inc.fixed b/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.1.inc.fixed
@@ -68,7 +68,7 @@ interface TestClass
 
 class MyClass
 {
-    public function myFunction();
+    public function parseErrorMustBeIgnored();
 }//end class
 
 // Closures don't need end comments.
diff --git a/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.2.inc b/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.2.inc
@@ -2,6 +2,6 @@
 
 // Intentional parse error (missing opening bracket).
 // This should be the only test in this file.
-// Testing that the sniff is triggered.
+// Testing that the sniff stays silent.
 
 class MissingOpeningBracket
diff --git a/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.3.inc b/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.3.inc
@@ -2,6 +2,6 @@
 
 // Intentional parse error (missing closing bracket).
 // This should be the only test in this file.
-// Testing that the sniff is triggered.
+// Testing that the sniff stays silent.
 
 class MissingClosingBracket {
diff --git a/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.php b/src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.php
@@ -78,17 +78,7 @@ public function getErrorList($testFile='')
      */
     public function getWarningList($testFile='')
     {
-        switch ($testFile) {
-        case 'ClosingDeclarationCommentUnitTest.1.inc':
-            return [71 => 1];
-
-        case 'ClosingDeclarationCommentUnitTest.2.inc':
-        case 'ClosingDeclarationCommentUnitTest.3.inc':
-            return [7 => 1];
-
-        default:
-            return [];
-        }
+        return [];
 
     }//end getWarningList()
 
diff --git a/src/Standards/Squiz/Tests/ControlStructures/ForLoopDeclarationUnitTest.2.inc b/src/Standards/Squiz/Tests/ControlStructures/ForLoopDeclarationUnitTest.2.inc
@@ -2,5 +2,5 @@
 
 // Parse error/live coding test (no parentheses).
 // This test has to be the only test in the file!
-// Testing the "NoOpenBracket" warning.
+// This should be ignored.
 for
diff --git a/src/Standards/Squiz/Tests/ControlStructures/ForLoopDeclarationUnitTest.3.inc b/src/Standards/Squiz/Tests/ControlStructures/ForLoopDeclarationUnitTest.3.inc
@@ -2,5 +2,5 @@
 
 // Parse error/live coding test (no close parenthesis).
 // This test has to be the only test in the file!
-// Testing the "NoOpenBracket" warning.
+// This should be ignored.
 for ($i = 10;
diff --git a/src/Standards/Squiz/Tests/ControlStructures/ForLoopDeclarationUnitTest.php b/src/Standards/Squiz/Tests/ControlStructures/ForLoopDeclarationUnitTest.php
@@ -86,14 +86,7 @@ public function getErrorList($testFile='')
      */
     public function getWarningList($testFile='')
     {
-        switch ($testFile) {
-        case 'ForLoopDeclarationUnitTest.2.inc':
-        case 'ForLoopDeclarationUnitTest.3.inc':
-            return [6 => 1];
-
-        default:
-            return [];
-        }//end switch
+        return [];
 
     }//end getWarningList()
 

Original file line number	Diff line number	Diff line change
`@@ -49,8 +49,7 @@ public function process(File $phpcsFile, $stackPtr)`
`49`	`49`	`$errorData = [strtolower($tokens[$stackPtr]['content']).' '.$tokens[$scopeIdentifier]['content']];`
`50`	`50`
`51`	`51`	`if (isset($tokens[$stackPtr]['scope_opener']) === false) {`
`52`		`- $error = 'Possible parse error: %s missing opening or closing brace';`
`53`		`- $phpcsFile->addWarning($error, $stackPtr, 'MissingBrace', $errorData);`
	`52`	`+ // Parse error or live coding.`
`54`	`53`	`return;`
`55`	`54`	`}`
`56`	`55`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ class Test_Class_Bad_H extends Test_Class_Bad_G {`
`47`	`47`	`class Test_Class_Bad_I implements Test_Interface_Bad_C{`
`48`	`48`	`}`
`49`	`49`
`50`		`-// This one should be flagged as a potential parse error.`
	`50`	`+// This one should be ignored as a potential parse error.`
`51`	`51`	`class Test_Class_Bad_H`
`52`	`52`
`53`	`53`	`// This is OK.`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ public function getErrorList()`
`60`	`60`	`*/`
`61`	`61`	`public function getWarningList()`
`62`	`62`	`{`
`63`		`- return [51 => 1];`
	`63`	`+ return [];`
`64`	`64`
`65`	`65`	`}//end getWarningList()`
`66`	`66`
Original file line number	Diff line number	Diff line change
`@@ -48,8 +48,7 @@ public function process(File $phpcsFile, $stackPtr)`
`48`	`48`	`$errorData = [strtolower($tokens[$stackPtr]['content'])];`
`49`	`49`
`50`	`50`	`if (isset($tokens[$stackPtr]['scope_opener']) === false) {`
`51`		`- $error = 'Possible parse error: %s missing opening or closing brace';`
`52`		`- $phpcsFile->addWarning($error, $stackPtr, 'MissingBrace', $errorData);`
	`51`	`+ // Parse error or live coding.`
`53`	`52`	`return;`
`54`	`53`	`}`
`55`	`54`
Original file line number	Diff line number	Diff line change
`@@ -7,5 +7,5 @@ if (!class_exists('ClassOpeningBraceTabIndented')) {`
`7`	`7`	`}`
`8`	`8`
`9`	`9`
`10`		`-// Needs to be last test in the file. Intentional parse error.`
	`10`	`+// Needs to be last test in the file. Intentional parse error. Should be ignored.`
`11`	`11`	`class MyParseError extends Exception`
Original file line number	Diff line number	Diff line change
`@@ -49,9 +49,7 @@ public function process(File $phpcsFile, $stackPtr)`
`49`	`49`	`$tokens = $phpcsFile->getTokens();`
`50`	`50`
`51`	`51`	`if (isset($tokens[$stackPtr]['scope_opener']) === false) {`
`52`		`- $error = 'Possible parse error: %s missing opening or closing brace';`
`53`		`- $data = [$tokens[$stackPtr]['content']];`
`54`		`- $phpcsFile->addWarning($error, $stackPtr, 'MissingBrace', $data);`
	`52`	`+ // Parse error or live coding.`
`55`	`53`	`return;`
`56`	`54`	`}`
`57`	`55`
Original file line number	Diff line number	Diff line change
`@@ -62,8 +62,7 @@ public function process(File $phpcsFile, $stackPtr)`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`if (isset($tokens[$stackPtr]['scope_closer']) === false) {`
`65`		`- $error = 'Possible parse error: non-abstract method defined as abstract';`
`66`		`- $phpcsFile->addWarning($error, $stackPtr, 'Abstract');`
	`65`	`+ // Parse error or live coding.`
`67`	`66`	`return;`
`68`	`67`	`}`
`69`	`68`
`@@ -80,9 +79,7 @@ public function process(File $phpcsFile, $stackPtr)`
`80`	`79`	`}//end if`
`81`	`80`
`82`	`81`	`if (isset($tokens[$stackPtr]['scope_closer']) === false) {`
`83`		`- $error = 'Possible parse error: %s missing opening or closing brace';`
`84`		`- $data = [$tokens[$stackPtr]['content']];`
`85`		`- $phpcsFile->addWarning($error, $stackPtr, 'MissingBrace', $data);`
	`82`	`+ // Parse error or live coding.`
`86`	`83`	`return;`
`87`	`84`	`}`
`88`	`85`
Original file line number	Diff line number	Diff line change
`@@ -67,8 +67,7 @@ public function process(File $phpcsFile, $stackPtr)`
`67`	`67`
`68`	`68`	`$openingBracket = $phpcsFile->findNext(T_OPEN_PARENTHESIS, $stackPtr);`
`69`	`69`	`if ($openingBracket === false \|\| isset($tokens[$openingBracket]['parenthesis_closer']) === false) {`
`70`		`- $error = 'Possible parse error: no opening/closing parenthesis for FOR keyword';`
`71`		`- $phpcsFile->addWarning($error, $stackPtr, 'NoOpenBracket');`
	`70`	`+ // Parse error or live coding.`
`72`	`71`	`return;`
`73`	`72`	`}`
`74`	`73`
Original file line number	Diff line number	Diff line change
`@@ -123,8 +123,7 @@ public function process(File $phpcsFile, $stackPtr)`
`123`	`123`	`}`
`124`	`124`
`125`	`125`	`if (isset($tokens[$nextCase]['scope_opener']) === false) {`
`126`		`- $error = 'Possible parse error: CASE missing opening colon';`
`127`		`- $phpcsFile->addWarning($error, $nextCase, 'MissingColon');`
	`126`	`+ // Parse error or live coding.`
`128`	`127`	`continue;`
`129`	`128`	`}`
`130`	`129`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ interface TestClass`
`68`	`68`
`69`	`69`	`class MyClass`
`70`	`70`	`{`
`71`		`- public function myFunction();`
	`71`	`+ public function parseErrorMustBeIgnored();`
`72`	`72`	`}//end class`
`73`	`73`
`74`	`74`	`// Closures don't need end comments.`