✨ Do not required blank line for custom annotations

Author: Vincent Langlet

Symfony3Custom/Sniffs/Commenting/DocCommentGroupSameTypeSniff.php

@@ -5,6 +5,42 @@
  */
 class Symfony3Custom_Sniffs_Commenting_DocCommentGroupSameTypeSniff implements PHP_CodeSniffer_Sniff
 {
+    /**
+     * A list of PHPDoc tags that are checked.
+     *
+     * @var array
+     */
+    public $tags = array(
+        '@api',
+        '@author',
+        '@category',
+        '@copyright',
+        '@deprecated',
+        '@example',
+        '@filesource',
+        '@global',
+        '@ignore',
+        '@internal',
+        '@license',
+        '@link',
+        '@method',
+        '@package',
+        '@param',
+        '@property',
+        '@property-read',
+        '@property-write',
+        '@return',
+        '@see',
+        '@since',
+        '@source',
+        '@subpackage',
+        '@throws',
+        '@todo',
+        '@uses',
+        '@var',
+        '@version',
+    );
+
     /**
      * A list of tokenizers this sniff supports.
      *
@@ -39,23 +75,40 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
                 $stackPtr
             );
 
+            $previousTag = $phpcsFile->findPrevious(
+                T_DOC_COMMENT_TAG,
+                $commentTag - 1,
+                $stackPtr
+            );
+
             if (false !== $previousString) {
                 $previousStringLine = $tokens[$previousString]['line'];
+                $previousTagLine = $tokens[$previousTag]['line'];
+                $previousLine = max($previousStringLine, $previousTagLine);
 
-                if (isset($previousTagLine)) {
-                    $previousLine = max($previousStringLine, $previousTagLine);
-                } else {
-                    $previousLine = $previousStringLine;
-                }
+                $currentIsCustom = ! in_array($currentType, $this->tags);
+                $previousIsCustom = ! in_array($previousType, $this->tags);
 
-                if ($previousType === $currentType) {
+                if (($previousType === $currentType)
+                    || ($currentIsCustom && $previousIsCustom)
+                ) {
                     if ($previousLine !== $commentTagLine - 1) {
-                        $fix = $phpcsFile->addFixableError(
-                            'Expected no empty lines '
-                            . 'between annotations of the same type',
-                            $commentTag,
-                            'SameType'
-                        );
+
+                        if ($previousType === $currentType) {
+                            $fix = $phpcsFile->addFixableError(
+                                'Expected no empty lines '
+                                . 'between annotations of the same type',
+                                $commentTag,
+                                'SameType'
+                            );
+                        } else {
+                            $fix = $phpcsFile->addFixableError(
+                                'Expected no empty lines '
+                                . 'between custom annotations',
+                                $commentTag,
+                                'CustomType'
+                            );
+                        }
 
                         if ($fix === true) {
                             $phpcsFile->fixer->beginChangeset();
@@ -113,7 +166,6 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
             }
 
             $previousType = $currentType;
-            $previousTagLine = $commentTagLine;
         }
     }
 

Symfony3Custom/Tests/Commenting/DocCommentGroupSameTypeUnitTest.inc

@@ -5,7 +5,8 @@
  * @see http://doc.example.com/
  *
  * @see SomeClass::someMethod()
- * @Route()
+ * @Route("/{id}/", name="test")
+ * @Security()
  * @param string $a
  *
  *

Symfony3Custom/Tests/Commenting/DocCommentGroupSameTypeUnitTest.inc.fixed

@@ -6,7 +6,8 @@
  * @see http://doc.example.com/
  * @see SomeClass::someMethod()
  *
- * @Route()
+ * @Route("/{id}/", name="test")
+ * @Security()
  *
  * @param string $a
  * @param string $b

Symfony3Custom/Tests/Commenting/DocCommentGroupSameTypeUnitTest.php

@@ -22,13 +22,13 @@ public function getErrorList()
             5 => 1,
             7 => 1,
             8 => 1,
-            9 => 1,
-            12 => 1,
+            10 => 1,
             13 => 1,
             14 => 1,
-            19 => 1,
-            28 => 1,
-            32 => 1,
+            15 => 1,
+            20 => 1,
+            29 => 1,
+            33 => 1,
         );
     }