Comment Placement sniff - allow comments in the first column after PH…

…P opening tag
webimpress · May 2, 2019 · aaf8ca9 · aaf8ca9
1 parent d0d09ff
commit aaf8ca9
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 4 deletions.
diff --git a/src/WebimpressCodingStandard/Sniffs/Commenting/PlacementSniff.php b/src/WebimpressCodingStandard/Sniffs/Commenting/PlacementSniff.php
@@ -30,7 +30,8 @@ public function process(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
 
-        if ($tokens[$stackPtr - 1]['code'] !== T_WHITESPACE
+        if ($tokens[$stackPtr]['column'] !== 1
+            && $tokens[$stackPtr - 1]['code'] !== T_WHITESPACE
             && ($tokens[$stackPtr - 1]['code'] !== T_COMMENT
                 || $tokens[$stackPtr - 1]['line'] === $tokens[$stackPtr]['line'])
         ) {

diff --git a/test/Sniffs/Commenting/PlacementUnitTest.inc b/test/Sniffs/Commenting/PlacementUnitTest.inc
@@ -1,4 +1,5 @@
 <?php
+/* comment */
 
 echo /* 1 */ 'hey';
 echo 'world';// hey

diff --git a/test/Sniffs/Commenting/PlacementUnitTest.inc.fixed b/test/Sniffs/Commenting/PlacementUnitTest.inc.fixed
@@ -1,4 +1,5 @@
 <?php
+/* comment */
 
 echo   'hey'; /* 1 */
 echo 'world'; // hey

diff --git a/test/Sniffs/Commenting/PlacementUnitTest.php b/test/Sniffs/Commenting/PlacementUnitTest.php
@@ -11,10 +11,10 @@ class PlacementUnitTest extends AbstractTestCase
     protected function getErrorList(string $testFile = '') : array
     {
         return [
-            3 => 1,
             4 => 1,
-            6 => 3,
-            8 => 3,
+            5 => 1,
+            7 => 3,
+            9 => 3,
         ];
     }
-Original file line number
+Diff line change
@@ Expand Up / @@ -11,10 +11,10 @@ class PlacementUnitTest extends AbstractTestCase @@
         protected function getErrorList(string $testFile = '') : array
         {
             return [
-=> 1,
 => 1,
-=> 3,
-=> 3,
+=> 1,
+=> 3,
+=> 3,
             ];
         }
@@ Expand Down @@