added fixer for Property Comment sniff

Author: xalopp

Sniffs/Commenting/PropertyCommentSniff.php

@@ -95,13 +95,7 @@ protected function processTokenWithinScope(
         if ($code === T_DOC_COMMENT_CLOSE_TAG) {
             $commentStart = $tokens[$commentEnd]['comment_opener'];
 
-            if ($tokens[$commentStart]['line'] === $tokens[$commentEnd]['line']) {
-                $phpcsFile->addError(
-                    'property doc comment must be multi line',
-                    $commentEnd,
-                    'NotMultiLineDocBlock'
-                );
-            }
+            $isCommentOneLiner = $tokens[$commentStart]['line'] === $tokens[$commentEnd]['line'];
 
             $length         = $commentEnd - $commentStart + 1;
             $tokensAsString = $phpcsFile->getTokensAsString(
@@ -116,15 +110,44 @@ protected function processTokenWithinScope(
                     $commentStart,
                     'NoVarDefined'
                 );
-            } else if ($varCount > 1) {
+            } elseif ($varCount > 1) {
                 $phpcsFile->addError(
                     'property doc comment must no multiple @var annotations',
                     $commentStart,
                     'MultipleVarDefined'
                 );
             }
+
+            if ($varCount === 1) {
+                if ($isCommentOneLiner) {
+                    $fix = $phpcsFile->addFixableError(
+                        'property doc comment must be multi line',
+                        $commentEnd,
+                        'NotMultiLineDocBlock'
+                    );
+
+                    if ($fix) {
+                        $phpcsFile->fixer->beginChangeset();
+                        $phpcsFile->fixer->addContent($commentStart, "\n     *");
+                        $phpcsFile->fixer->replaceToken(
+                            $commentEnd - 1,
+                            rtrim($tokens[$commentEnd - 1]['content'])
+                        );
+                        $phpcsFile->fixer->addContentBefore($commentEnd, "\n     ");
+                        $phpcsFile->fixer->endChangeset();
+                    }
+                }
+            } else {
+                if ($isCommentOneLiner) {
+                    $phpcsFile->addError(
+                        'property doc comment must be multi line',
+                        $commentEnd,
+                        'NotMultiLineDocBlock'
+                    );
+                }
+            }
         } elseif ($code === T_COMMENT) {
-            $commentStart = $phpcsFile->findPrevious([T_COMMENT], $commentEnd, null, true);
+            $commentStart = $phpcsFile->findPrevious(T_COMMENT, $commentEnd, null, true);
             $phpcsFile->addError(
                 'property doc comment must begin with /**',
                 $commentStart + 1,

Tests/Commenting/PropertyCommentUnitTest.fail.inc.fixed

@@ -0,0 +1,38 @@
+<?php
+
+class X
+{
+    public $publicPropertySelfDescriptive;
+
+    /**
+     * @var int
+     */
+    public $publicProperty = 1;
+
+    /**
+     * @varx array
+     *
+     * array of foo => bar arrays
+     */
+    private $_privateProperty = [['foo' => 'bar']];
+
+    /**
+     * @var
+     *
+     * foo
+     *
+     * @var array
+     */
+    private $_tmi;
+
+    /** stuff */
+    private $_moar;
+
+    /*
+     * no doc block
+     */
+    private $_priv;
+
+    // no doc block
+    private $_otherPriv;
+}