Merge pull request #132 from michalbundyra/bugfix/131

Fixes comment placement at the end of the line
webimpress · Nov 27, 2020 · 2df266a · 2df266a
2 parents 3199cc5 + b1c0cbc
commit 2df266a
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/src/WebimpressCodingStandard/Sniffs/Commenting/PlacementSniff.php b/src/WebimpressCodingStandard/Sniffs/Commenting/PlacementSniff.php
@@ -9,8 +9,11 @@
 use PHP_CodeSniffer\Util\Tokens;
 
 use function implode;
+use function substr;
 
+use const T_CLOSE_TAG;
 use const T_COMMENT;
+use const T_OPEN_TAG;
 use const T_WHITESPACE;
 
 class PlacementSniff implements Sniff
@@ -34,6 +37,8 @@ public function process(File $phpcsFile, $stackPtr)
             && $tokens[$stackPtr - 1]['code'] !== T_WHITESPACE
             && ($tokens[$stackPtr - 1]['code'] !== T_COMMENT
                 || $tokens[$stackPtr - 1]['line'] === $tokens[$stackPtr]['line'])
+            && ($tokens[$stackPtr - 1]['code'] !== T_OPEN_TAG
+                || substr($tokens[$stackPtr - 1]['content'], -1) !== ' ')
         ) {
             $error = 'Expected at least one space before comment';
             $fix = $phpcsFile->addFixableError($error, $stackPtr, 'MissingSpaceBefore');
@@ -44,7 +49,7 @@ public function process(File $phpcsFile, $stackPtr)
         }
 
         $lastInLine = $stackPtr;
-        while ($next = $phpcsFile->findNext(Tokens::$emptyTokens, $lastInLine + 1, null, true)) {
+        while ($next = $phpcsFile->findNext(Tokens::$emptyTokens + [T_CLOSE_TAG], $lastInLine + 1, null, true)) {
             if ($tokens[$next]['line'] === $tokens[$stackPtr]['line']) {
                 $lastInLine = $next;
                 continue;

diff --git a/test/Sniffs/Commenting/PlacementUnitTest.inc b/test/Sniffs/Commenting/PlacementUnitTest.inc
@@ -13,3 +13,8 @@ $foo = 'bar';
 
 // comment1
 // comment2
+
+?>
+
+<?php // single line ?>
+<?php   /* comment */ ?>
diff --git a/test/Sniffs/Commenting/PlacementUnitTest.inc.fixed b/test/Sniffs/Commenting/PlacementUnitTest.inc.fixed
@@ -13,3 +13,8 @@ $foo = 'bar';
 
 // comment1
 // comment2
+
+?>
+
+<?php // single line ?>
+<?php   /* comment */ ?>