Merge pull request #192 from magento-commerce/imported-loginesta-magento-coding-standard-419

[Imported] Allow to skip see tag in annotation with specific deprecated comment

Author: sivaschenko

Magento2/Helpers/Commenting/PHPDocFormattingValidator.php

@@ -123,6 +123,12 @@ public function hasDeprecatedWellFormatted($commentStartPtr, $tokens)
         }
         $seePtr = $this->getTagPosition('@see', $commentStartPtr, $tokens);
         if ($seePtr === -1) {
+            if (preg_match(
+                "/This [a-zA-Z]* will be removed in version \d.\d.\d without replacement/",
+                $tokens[$deprecatedPtr + 2]['content']
+            )) {
+                return true;
+            }
             return false;
         }
 

Magento2/Tests/Annotation/MethodAnnotationStructureUnitTest.inc

@@ -369,4 +369,24 @@ class MethodAnnotationFixture
     {
         return true;
     }
+
+    /**
+     * This deprecated function is correct even though it only contains the @deprecated tag.
+     *
+     * @deprecated This method will be removed in version 1.0.0 without replacement
+     */
+    public function correctBecauseOfKeywordPhrase()
+    {
+        return false;
+    }
+
+    /**
+     * This deprecated function is correct even though it only contains the @deprecated tag.
+     *
+     * @deprecated WOW! This method will be removed in version 1.0.0 without replacement
+     */
+    public function alsoCorrectBecauseOfKeywordPhrase()
+    {
+        return false;
+    }
 }

Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.1.inc

@@ -162,3 +162,20 @@ class OldHandler
 {
 
 }
+
+/**
+ * @deprecated This class will be removed in version 1.0.0 without replacement
+ */
+class DeprecatedButHandler
+{
+
+}
+
+/**
+ * @deprecated It's also deprecated - This class will be removed in version 1.0.0 without replacement
+ */
+class AlsoDeprecatedButHandler
+{
+
+}
+

Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.2.inc

@@ -153,3 +153,19 @@ interface DoNotCareHandler
 {
 
 }
+
+/**
+ * @deprecated This interface will be removed in version 1.0.0 without replacement
+ */
+interface DeprecatedButHandler
+{
+
+}
+
+/**
+ * @deprecated Yeah! This interface will be removed in version 1.0.0 without replacement
+ */
+interface AlsoDeprecatedButHandler
+{
+
+}

Magento2/Tests/Commenting/ClassPropertyPHPDocFormattingUnitTest.inc

@@ -194,4 +194,10 @@ class correctlyFormattedClassMemberDocBlock
      * @see Message with some reference
      */
     protected string $itIsCorrect;
+
+    /**
+     * @var string
+     * @deprecated This property will be removed in version 1.0.0 without replacement
+     */
+    protected string $deprecatedWithKeyword;
 }

Magento2/Tests/Commenting/ConstantsPHPDocFormattingUnitTest.2.inc

@@ -63,4 +63,14 @@ class Profiler
      * @see
      */
     const d = 100;
+
+    /**
+     * @deprecated This constant will be removed in version 1.0.0 without replacement
+     */
+    const KEYWORD_PHRASE = false;
+
+    /**
+     * @deprecated It's awesome - This constant will be removed in version 1.0.0 without replacement
+     */
+    const WITH_KEYWORD_PHRASE = false;
 }