Merge remote-tracking branch 'upstream/develop' into eslint-quotes

Author: fredden

.github/workflows/php.yml

@@ -20,8 +20,9 @@ jobs:
         dependencies:
           - "lowest"
           - "highest"
-        experimental:
-          - false
+        exclude:
+          - php-version: "8.1"
+            dependencies: "lowest"
     name: Tests with PHP ${{ matrix.php-version }} and ${{ matrix.dependencies }} dependencies
 
     steps:
@@ -36,6 +37,7 @@ jobs:
       uses: shivammathur/setup-php@v2
       with:
         php-version: ${{ matrix.php-version }}
+        ini-file: development
       env:
         COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

.gitignore

@@ -9,3 +9,4 @@
 .vscode/
 
 .phpunit.result.cache
+.DS_Store

Magento2/Helpers/Commenting/PHPDocFormattingValidator.php

@@ -121,15 +121,17 @@ public function hasDeprecatedWellFormatted($commentStartPtr, $tokens)
         if ($deprecatedPtr === -1) {
             return true;
         }
-
-        $seeTagRequired = false;
-        if ($tokens[$deprecatedPtr + 2]['code'] !== T_DOC_COMMENT_STRING) {
-            $seeTagRequired = true;
-        }
         $seePtr = $this->getTagPosition('@see', $commentStartPtr, $tokens);
         if ($seePtr === -1) {
-            return !$seeTagRequired;
+            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;
         }
+
         return $tokens[$seePtr + 2]['code'] === T_DOC_COMMENT_STRING;
     }
 

Magento2/Rector/Tests/AddArrayAccessInterfaceReturnTypes/config/configured_rule.php

@@ -1,14 +1,13 @@
 <?php
 /**
- * Copyright 2021 Adobe
+ * Copyright 2022 Adobe
  * See COPYING.txt for license details.
  */
 declare(strict_types=1);
 
 use Magento2\Rector\Src\AddArrayAccessInterfaceReturnTypes;
-use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Rector\Config\RectorConfig;
 
-return static function (ContainerConfigurator $containerConfigurator): void {
-    $services = $containerConfigurator->services();
-    $services->set(AddArrayAccessInterfaceReturnTypes::class);
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(AddArrayAccessInterfaceReturnTypes::class);
 };

Magento2/Rector/Tests/ReplaceMbStrposNullLimit/config/configured_rule.php

@@ -1,14 +1,13 @@
 <?php
 /**
- * Copyright 2021 Adobe
+ * Copyright 2022 Adobe
  * See COPYING.txt for license details.
  */
 declare(strict_types=1);
 
 use Magento2\Rector\Src\ReplaceMbStrposNullLimit;
-use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Rector\Config\RectorConfig;
 
-return static function (ContainerConfigurator $containerConfigurator): void {
-    $services = $containerConfigurator->services();
-    $services->set(ReplaceMbStrposNullLimit::class);
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(ReplaceMbStrposNullLimit::class);
 };

Magento2/Rector/Tests/ReplaceNewDateTimeNull/config/configured_rule.php

@@ -1,14 +1,13 @@
 <?php
 /**
- * Copyright 2021 Adobe
+ * Copyright 2022 Adobe
  * See COPYING.txt for license details.
  */
 declare(strict_types=1);
 
 use Magento2\Rector\Src\ReplaceNewDateTimeNull;
-use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Rector\Config\RectorConfig;
 
-return static function (ContainerConfigurator $containerConfigurator): void {
-    $services = $containerConfigurator->services();
-    $services->set(ReplaceNewDateTimeNull::class);
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(ReplaceNewDateTimeNull::class);
 };

Magento2/Rector/Tests/ReplacePregSplitNullLimit/config/configured_rule.php

@@ -1,14 +1,13 @@
 <?php
 /**
- * Copyright 2021 Adobe
+ * Copyright 2022 Adobe
  * See COPYING.txt for license details.
  */
 declare(strict_types=1);
 
 use Magento2\Rector\Src\ReplacePregSplitNullLimit;
-use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Rector\Config\RectorConfig;
 
-return static function (ContainerConfigurator $containerConfigurator): void {
-    $services = $containerConfigurator->services();
-    $services->set(ReplacePregSplitNullLimit::class);
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(ReplacePregSplitNullLimit::class);
 };

Magento2/Sniffs/Annotation/MethodAnnotationStructureSniff.php

@@ -7,6 +7,7 @@
 
 namespace Magento2\Sniffs\Annotation;
 
+use Magento2\Helpers\Commenting\PHPDocFormattingValidator;
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
 
@@ -20,12 +21,18 @@ class MethodAnnotationStructureSniff implements Sniff
      */
     private $annotationFormatValidator;
 
+    /**
+     * @var PHPDocFormattingValidator
+     */
+    private $PHPDocFormattingValidator;
+
     /**
      * AnnotationStructureSniff constructor.
      */
     public function __construct()
     {
         $this->annotationFormatValidator = new AnnotationFormatValidator();
+        $this->PHPDocFormattingValidator = new PHPDocFormattingValidator();
     }
 
     /**
@@ -50,6 +57,17 @@ public function process(File $phpcsFile, $stackPtr)
             $phpcsFile->addError('Comment block is missing', $stackPtr, 'MethodArguments');
             return;
         }
+
+        if ($this->PHPDocFormattingValidator->hasDeprecatedWellFormatted($commentStartPtr, $tokens) !== true) {
+            $phpcsFile->addWarning(
+                'Motivation behind the added @deprecated tag MUST be explained. '
+                . '@see tag MUST be used with reference to new implementation when code is deprecated '
+                . 'and there is a new alternative.',
+                $stackPtr,
+                'InvalidDeprecatedTagUsage'
+            );
+        }
+
         $commentCloserPtr = $tokens[$commentStartPtr]['comment_closer'];
         $functionPtrContent = $tokens[$stackPtr + 2]['content'];
         if (preg_match('/(?i)__construct/', $functionPtrContent)) {

Magento2/Sniffs/CodeAnalysis/EmptyBlockSniff.php

@@ -37,6 +37,17 @@ public function process(File $phpcsFile, $stackPtr)
             return;
         }
 
+        // Ignore empty constructor function blocks when using property promotion
+        if ($tokens[$stackPtr]['code'] === T_FUNCTION &&
+            strpos($phpcsFile->getDeclarationName($stackPtr), '__construct') === 0 &&
+            count($phpcsFile->getMethodParameters($stackPtr)) > 0 &&
+            array_reduce($phpcsFile->getMethodParameters($stackPtr), static function ($result, $methodParam) {
+                return $result && isset($methodParam['property_visibility']);
+            }, true)) {
+
+            return;
+        }
+
         parent::process($phpcsFile, $stackPtr);
     }//end process()
 }

Magento2/Sniffs/Commenting/ClassPropertyPHPDocFormattingSniff.php

@@ -67,6 +67,15 @@ public function processMemberVar(File $phpcsFile, $stackPtr)
         }
 
         $commentStart = $tokens[$commentEnd]['comment_opener'];
+        if ($this->PHPDocFormattingValidator->hasDeprecatedWellFormatted($commentStart, $tokens) !== true) {
+            $phpcsFile->addWarning(
+                'Motivation behind the added @deprecated tag MUST be explained. '
+                . '@see tag MUST be used with reference to new implementation when code is deprecated '
+                . 'and there is a new alternative.',
+                $stackPtr,
+                'InvalidDeprecatedTagUsage'
+            );
+        }
         $varAnnotationPosition = null;
         foreach ($tokens[$commentStart]['comment_tags'] as $tag) {
             if ($tokens[$tag]['content'] === '@var') {