Auto-fix PEAR.Commenting.FunctionComment.SpacingAfter

squizlabs · Oct 29, 2023 · a69c1d6 · a69c1d6
1 parent 321d252
commit a69c1d6
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/src/Standards/PEAR/Sniffs/Commenting/FunctionCommentSniff.php b/src/Standards/PEAR/Sniffs/Commenting/FunctionCommentSniff.php
@@ -129,7 +129,14 @@ public function process(File $phpcsFile, $stackPtr)
                     && $tokens[$i]['line'] !== $tokens[($i + 1)]['line']
                 ) {
                     $error = 'There must be no blank lines after the function comment';
-                    $phpcsFile->addError($error, $commentEnd, 'SpacingAfter');
+                    $fix   = $phpcsFile->addFixableError($error, $commentEnd, 'SpacingAfter');
+
+                    if ($fix === true) {
+                        for (; $i < $stackPtr && $tokens[$i]['content'] === $phpcsFile->eolChar; $i++) {
+                            $phpcsFile->fixer->replaceToken($i, '');
+                        }
+                    }
+
                     break;
                 }
             }

diff --git a/src/Standards/PEAR/Tests/Commenting/FunctionCommentUnitTest.inc.fixed b/src/Standards/PEAR/Tests/Commenting/FunctionCommentUnitTest.inc.fixed
@@ -453,7 +453,6 @@ class Something implements JsonSerializable {
      *
      * @return mixed
      */
-
     #[ReturnTypeWillChange]
     public function blankLineDetectionA() {}
 
@@ -463,16 +462,13 @@ class Something implements JsonSerializable {
      * @return mixed
      */
     #[ReturnTypeWillChange]
-
     public function blankLineDetectionB() {}
 
     /**
      * Blank line between both docblock and attribute and attribute and function declaration.
      *
      * @return mixed
      */
-
     #[ReturnTypeWillChange]
-
     public function blankLineDetectionC() {}
 }