Fixed bug #2868 : phpcs:ignore annotation doesnt work inside a docblock

squizlabs · Feb 23, 2020 · 8909858 · 8909858
1 parent db617f1
commit 8909858
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 3 deletions.
diff --git a/package.xml b/package.xml
@@ -35,6 +35,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
   - Fixed bug #2850 : Generic.PHP.LowerCaseKeyword complains __HALT_COMPILER is uppercase
   - Fixed bug #2853 : Undefined variable error when using Info report
     -- Thanks to Juliette Reinders Folmer for the patch
+  - Fixed bug #2868 : phpcs:ignore annotation doesnt work inside a docblock
  </notes>
  <contents>
   <dir name="/">

diff --git a/src/Tokenizers/Tokenizer.php b/src/Tokenizers/Tokenizer.php
@@ -332,6 +332,7 @@ private function createPositionMap()
                             }
 
                             if ($this->tokens[$prev]['code'] === T_WHITESPACE
+                                || $this->tokens[$prev]['code'] === T_DOC_COMMENT_WHITESPACE
                                 || ($this->tokens[$prev]['code'] === T_INLINE_HTML
                                 && trim($this->tokens[$prev]['content']) === '')
                             ) {
@@ -340,7 +341,9 @@ private function createPositionMap()
 
                             $lineHasOtherTokens = true;
 
-                            if ($this->tokens[$prev]['code'] === T_OPEN_TAG) {
+                            if ($this->tokens[$prev]['code'] === T_OPEN_TAG
+                                || $this->tokens[$prev]['code'] === T_DOC_COMMENT_STAR
+                            ) {
                                 continue;
                             }
 
@@ -367,6 +370,7 @@ private function createPositionMap()
                             }
 
                             if ($this->tokens[$next]['code'] === T_WHITESPACE
+                                || $this->tokens[$next]['code'] === T_DOC_COMMENT_WHITESPACE
                                 || ($this->tokens[$next]['code'] === T_INLINE_HTML
                                 && trim($this->tokens[$next]['content']) === '')
                             ) {

diff --git a/tests/Core/ErrorSuppressionTest.php b/tests/Core/ErrorSuppressionTest.php
@@ -335,7 +335,10 @@ public function testSuppressLine()
     {
         $config            = new Config();
         $config->standards = ['Generic'];
-        $config->sniffs    = ['Generic.PHP.LowerCaseConstant'];
+        $config->sniffs    = [
+            'Generic.PHP.LowerCaseConstant',
+            'Generic.Files.LineLength',
+        ];
 
         $ruleset = new Ruleset($config);
 
@@ -379,7 +382,7 @@ public function testSuppressLine()
         $this->assertEquals(1, $numErrors);
         $this->assertCount(1, $errors);
 
-         // Process with @ suppression on line before.
+        // Process with @ suppression on line before.
         $content = '<?php '.PHP_EOL.'/* @phpcs:ignore */'.PHP_EOL.'$var = FALSE;'.PHP_EOL.'$var = FALSE;';
         $file    = new DummyFile($content, $ruleset, $config);
         $file->process();
@@ -399,6 +402,16 @@ public function testSuppressLine()
         $this->assertEquals(1, $numErrors);
         $this->assertCount(1, $errors);
 
+        // Process with @ suppression on line before inside docblock.
+        $content = '<?php '.PHP_EOL.'/**'.PHP_EOL.' * Comment here'.PHP_EOL.' * @phpcs:ignore'.PHP_EOL.' * '.str_repeat('a ', 50).PHP_EOL.'*/';
+        $file    = new DummyFile($content, $ruleset, $config);
+        $file->process();
+
+        $errors    = $file->getErrors();
+        $numErrors = $file->getErrorCount();
+        $this->assertEquals(0, $numErrors);
+        $this->assertCount(0, $errors);
+
         // Process with suppression on same line.
         $content = '<?php '.PHP_EOL.'$var = FALSE; // phpcs:ignore'.PHP_EOL.'$var = FALSE;';
         $file    = new DummyFile($content, $ruleset, $config);