Merge pull request #50 from VincentLanglet/varWithoutName

✨ Add check for var name in comment

Author: VincentLanglet

SymfonyCustom/Sniffs/Commenting/VariableCommentSniff.php

@@ -94,6 +94,19 @@ public function processMemberVar(File $phpcsFile, $stackPtr)
             return;
         }
 
+        $content = explode(' ', $tokens[$string]['content']);
+        if (in_array($tokens[$stackPtr]['content'], $content)) {
+            $error = '@var annotations should not contain the variable name';
+            $fix = $phpcsFile->addFixableError($error, $foundVar, 'NamedVar');
+
+            if (true === $fix) {
+                $newContent = array_filter($content, function ($value) use ($tokens, $stackPtr) {
+                    return $tokens[$stackPtr]['content'] !== $value;
+                });
+                $phpcsFile->fixer->replaceToken($string, implode(' ', $newContent));
+            }
+        }
+
         $this->processWhitespace($phpcsFile, $commentStart);
     }
 

SymfonyCustom/Tests/Commenting/VariableCommentUnitTest.inc

@@ -104,6 +104,7 @@ class VariableCommentUnitTest
      */
     protected function checkVariable($var1, $var2)
     {
+        /** @var string $var4 */
         $var4 = 'A normal variable';
         $var5 = PHP_CodeSniffer_Tokens::$operators;
         echo "Printing $var1 $var2 in a double quoted  string\n";
@@ -125,4 +126,9 @@ class VariableCommentUnitTest
      * @var int
      */
     private $noNewLine;
+
+    /**
+     * @var string $withVarName
+     */
+    private $withVarName;
 }

SymfonyCustom/Tests/Commenting/VariableCommentUnitTest.inc.fixed

@@ -104,6 +104,7 @@ class VariableCommentUnitTest
      */
     protected function checkVariable($var1, $var2)
     {
+        /** @var string $var4 */
         $var4 = 'A normal variable';
         $var5 = PHP_CodeSniffer_Tokens::$operators;
         echo "Printing $var1 $var2 in a double quoted  string\n";
@@ -126,4 +127,9 @@ class VariableCommentUnitTest
      * @var int
      */
     private $noNewLine;
+
+    /**
+     * @var string
+     */
+    private $withVarName;
 }

SymfonyCustom/Tests/Commenting/VariableCommentUnitTest.php

@@ -28,8 +28,9 @@ public function getErrorList()
             64  => 1,
             73  => 1,
             84  => 1,
-            122 => 1,
-            124 => 1,
+            123 => 1,
+            125 => 1,
+            131 => 1,
         ];
     }