Squiz/BlockComment: don't autofix mid-line inline comments

This was causing fixer conflicts with other sniffs dealing with code whitespace rules.
squizlabs · Feb 27, 2018 · d735ce8 · d735ce8
1 parent a15dd0a
commit d735ce8
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 4 deletions.
diff --git a/src/Standards/Squiz/Sniffs/Commenting/BlockCommentSniff.php b/src/Standards/Squiz/Sniffs/Commenting/BlockCommentSniff.php
@@ -159,10 +159,17 @@ public function process(File $phpcsFile, $stackPtr)
 
         if (count($commentLines) === 1) {
             $error = 'Single line block comment not allowed; use inline ("// text") comment instead';
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'SingleLine');
-            if ($fix === true) {
-                $comment = '// '.$commentText.$phpcsFile->eolChar;
-                $phpcsFile->fixer->replaceToken($stackPtr, $comment);
+
+            // Only fix comments when they are the last token on a line.
+            $nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true);
+            if ($tokens[$stackPtr]['line'] !== $tokens[$nextNonEmpty]['line']) {
+                $fix = $phpcsFile->addFixableError($error, $stackPtr, 'SingleLine');
+                if ($fix === true) {
+                    $comment = '// '.$commentText.$phpcsFile->eolChar;
+                    $phpcsFile->fixer->replaceToken($stackPtr, $comment);
+                }
+            } else {
+                $phpcsFile->addError($error, $stackPtr, 'SingleLine');
             }
 
             return;

diff --git a/src/Standards/Squiz/Tests/Commenting/BlockCommentUnitTest.inc b/src/Standards/Squiz/Tests/Commenting/BlockCommentUnitTest.inc
@@ -227,3 +227,7 @@ class TabTest {
 	/*
      *
 	*/
+
+// Mid-line inline comment style should not be auto-fixed.
+if (true || /* test */ -1 == $b) {}
+$y = 10 + /* test */ -2;
diff --git a/src/Standards/Squiz/Tests/Commenting/BlockCommentUnitTest.inc.fixed b/src/Standards/Squiz/Tests/Commenting/BlockCommentUnitTest.inc.fixed
@@ -229,3 +229,7 @@ class TabTest {
 	 * Test distinguishing between two distinct block comments which directly follow each other.
 	 */
 
+
+// Mid-line inline comment style should not be auto-fixed.
+if (true || /* test */ -1 == $b) {}
+$y = 10 + /* test */ -2;
diff --git a/src/Standards/Squiz/Tests/Commenting/BlockCommentUnitTest.php b/src/Standards/Squiz/Tests/Commenting/BlockCommentUnitTest.php
@@ -73,6 +73,8 @@ public function getErrorList()
             214 => 1,
             226 => 1,
             227 => 1,
+            232 => 1,
+            233 => 1,
         ];
 
         return $errors;