Merge pull request #1039 from PHPCSStandards/phpcs-4.0/feature/squiz-variablecomment-make-tagnotallowed-modular

Squiz/VariableComment: make errorcode for "TagNotAllowed" warning modular

Author: jrfnl

phpcs.xml.dist

@@ -47,7 +47,10 @@
     <rule ref="Squiz.Commenting.PostStatementComment">
         <exclude name="Squiz.Commenting.PostStatementComment.AnnotationFound"/>
     </rule>
-    <rule ref="Squiz.Commenting.VariableComment"/>
+    <rule ref="Squiz.Commenting.VariableComment">
+        <exclude name="Squiz.Commenting.VariableComment.DeprecatedTagNotAllowed"/>
+        <exclude name="Squiz.Commenting.VariableComment.LinkTagNotAllowed"/>
+    </rule>
     <rule ref="Squiz.Formatting.OperatorBracket"/>
     <rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing"/>
     <rule ref="Squiz.Operators.ComparisonOperatorUsage"/>
@@ -154,9 +157,4 @@
         <exclude-pattern>src/Standards/Generic/Sniffs/Commenting/TodoSniff\.php</exclude-pattern>
         <exclude-pattern>src/Standards/Generic/Tests/Commenting/TodoUnitTest\.php</exclude-pattern>
     </rule>
-
-    <!-- @see https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/122#discussion_r1414167897 -->
-    <rule ref="Squiz.Commenting.VariableComment">
-        <exclude-pattern>src/Util/Tokens\.php</exclude-pattern>
-    </rule>
 </ruleset>

src/Standards/Squiz/Sniffs/Commenting/VariableCommentSniff.php

@@ -111,7 +111,8 @@ public function processMemberVar(File $phpcsFile, $stackPtr)
             } else {
                 $error = '%s tag is not allowed in member variable comment';
                 $data  = [$tokens[$tag]['content']];
-                $phpcsFile->addWarning($error, $tag, 'TagNotAllowed', $data);
+                $code  = ucwords(ltrim($tokens[$tag]['content'], '@')).'TagNotAllowed';
+                $phpcsFile->addWarning($error, $tag, $code, $data);
             }//end if
         }//end foreach
 

src/Standards/Squiz/Tests/Commenting/VariableCommentUnitTest.inc

@@ -476,3 +476,26 @@ class PHP84FinalProperties {
      */
     final int $hasDocblock;
 }
+
+// phpcs:disable Squiz.Commenting.VariableComment.SinceTagNotAllowed
+// phpcs:disable Squiz.Commenting.VariableComment.DeprecatedTagNotAllowed
+class AllowMoreForSelectivelyIgnoringDisallowedTags {
+    /**
+     * @var string
+     *
+     * @since      3.1
+     * @deprecated 10.5
+     */
+    public string $propertyWithExtraTags;
+
+    /**
+     * @var string
+     *
+     * @link       https://example.org/some-link
+     * @api
+     * @param string This tag is not allowed.
+     */
+    public $theAboveExtraTagsAreStillNotAllowed;
+}
+
+// phpcs:enable Squiz.Commenting.VariableComment

src/Standards/Squiz/Tests/Commenting/VariableCommentUnitTest.inc.fixed

@@ -476,3 +476,26 @@ class PHP84FinalProperties {
      */
     final int $hasDocblock;
 }
+
+// phpcs:disable Squiz.Commenting.VariableComment.SinceTagNotAllowed
+// phpcs:disable Squiz.Commenting.VariableComment.DeprecatedTagNotAllowed
+class AllowMoreForSelectivelyIgnoringDisallowedTags {
+    /**
+     * @var string
+     *
+     * @since      3.1
+     * @deprecated 10.5
+     */
+    public string $propertyWithExtraTags;
+
+    /**
+     * @var string
+     *
+     * @link       https://example.org/some-link
+     * @api
+     * @param string This tag is not allowed.
+     */
+    public $theAboveExtraTagsAreStillNotAllowed;
+}
+
+// phpcs:enable Squiz.Commenting.VariableComment

src/Standards/Squiz/Tests/Commenting/VariableCommentUnitTest.php

@@ -81,7 +81,12 @@ public function getErrorList()
      */
     public function getWarningList()
     {
-        return [93 => 1];
+        return [
+            93  => 1,
+            494 => 1,
+            495 => 1,
+            496 => 1,
+        ];
 
     }//end getWarningList()