Merge pull request #58 from VincentLanglet/fixComment

✨ Add fixer for docComment

Author: VincentLanglet

SymfonyCustom/Sniffs/Commenting/DocCommentSniff.php

@@ -61,7 +61,36 @@ public function process(File $phpcsFile, $stackPtr)
         if (false === $short) {
             // No content at all.
             $error = 'Doc comment is empty';
-            $phpcsFile->addError($error, $stackPtr, 'Empty');
+
+            $next = $phpcsFile->findNext(T_WHITESPACE, $commentEnd + 1, null, true);
+            $hasSameLineNext = $next && $tokens[$next]['line'] === $tokens[$commentEnd]['line'];
+            $previous = $phpcsFile->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true);
+            $hasSameLinePrevious = $tokens[$previous]['line'] === $tokens[$stackPtr]['line'];
+
+            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Empty');
+
+            if (true === $fix) {
+                $phpcsFile->fixer->beginChangeset();
+
+                $end = $hasSameLineNext ? $next : $commentEnd + 1;
+                for ($i = $stackPtr; $i < $end; $i++) {
+                    $phpcsFile->fixer->replaceToken($i, '');
+                }
+
+                if (!$hasSameLineNext) {
+                    $previous = $phpcsFile->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true);
+                    for ($i = $stackPtr - 1; $i > $previous; $i--) {
+                        if ($tokens[$i]['line'] < $tokens[$stackPtr]['line']) {
+                            $phpcsFile->fixer->replaceToken($i, '');
+                            break;
+                        }
+
+                        $phpcsFile->fixer->replaceToken($i, '');
+                    }
+                }
+
+                $phpcsFile->fixer->endChangeset();
+            }
 
             return;
         }

SymfonyCustom/Tests/Commenting/DocCommentUnitTest.inc

@@ -32,4 +32,14 @@ class Test
 
     /**
      * Short description.   */
+
+    private $a; /**  */
+
+    private $b; /**  */ private $c;
+
+    /**  */ private $d;
+
+    private $e; /**
+                 *
+                 */ private $f;
 }

SymfonyCustom/Tests/Commenting/DocCommentUnitTest.inc.fixed

@@ -6,14 +6,8 @@ class Test
      * Short description.
      */
 
-    /**
-     *
-     */
 
-    /**
-     */
 
-    /** */
 
     /**
      * Short description.
@@ -32,4 +26,12 @@ class Test
     /**
      * Short description.
      */
+
+    private $a;
+
+    private $b; private $c;
+
+    private $d;
+
+    private $e; private $f;
 }

SymfonyCustom/Tests/Commenting/DocCommentUnitTest.php

@@ -29,6 +29,10 @@ public function getErrorList()
             26 => 1,
             28 => 1,
             34 => 1,
+            36 => 1,
+            38 => 1,
+            40 => 1,
+            42 => 1,
         ];
     }