Squiz/BlockComment: add fixer for LastLineIndent error

squizlabs · Feb 27, 2018 · c24f544 · c24f544
1 parent 5ea5103
commit c24f544
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 5 deletions.
diff --git a/src/Standards/Squiz/Sniffs/Commenting/BlockCommentSniff.php b/src/Standards/Squiz/Sniffs/Commenting/BlockCommentSniff.php
@@ -333,8 +333,21 @@ public function process(File $phpcsFile, $stackPtr)
                 ];
 
                 $error = 'Last line of comment aligned incorrectly; expected %s but found %s';
-                $phpcsFile->addError($error, $commentLines[$lastIndex], 'LastLineIndent', $data);
-            }
+                $fix   = $phpcsFile->addFixableError($error, $commentLines[$lastIndex], 'LastLineIndent', $data);
+                if ($fix === true) {
+                    if (isset($tokens[$line]['orig_content']) === true
+                        && $tokens[$line]['orig_content'][0] === "\t"
+                    ) {
+                        // Line is indented using tabs.
+                        $padding  = str_repeat("\t", floor($expected / $this->tabWidth));
+                        $padding .= str_repeat(' ', ($expected % $this->tabWidth));
+                    } else {
+                        $padding = str_repeat(' ', $expected);
+                    }
+
+                    $phpcsFile->fixer->replaceToken($commentLines[$lastIndex], $padding.$commentText);
+                }
+            }//end if
         }//end if
 
         // Check that the lines before and after this comment are blank.

diff --git a/src/Standards/Squiz/Tests/Commenting/BlockCommentUnitTest.inc.fixed b/src/Standards/Squiz/Tests/Commenting/BlockCommentUnitTest.inc.fixed
@@ -42,11 +42,11 @@ $code = 'should not be here';
 
 /*
     Closing comment not aligned
-    */
+*/
 
 /*
     Closing comment not aligned
- */
+*/
 
 // Not allowed
 
@@ -91,7 +91,7 @@ function func()
     /*
         Test
         here
-       */
+    */
 
 }//end func()