Merge remote-tracking branch 'upstream/develop' into auto-fix/remove-…

…useless-comments
magento · Mar 30, 2023 · 252371e · 252371e
2 parents 5936239 + bc6b0f6
commit 252371e
Show file tree

Hide file tree

Showing 15 changed files with 186 additions and 26 deletions.
diff --git a/Magento2/Sniffs/Commenting/ClassAndInterfacePHPDocFormattingSniff.php b/Magento2/Sniffs/Commenting/ClassAndInterfacePHPDocFormattingSniff.php
@@ -24,6 +24,7 @@ class ClassAndInterfacePHPDocFormattingSniff implements Sniff
      * @var string[] List of tags that can not be used in comments
      */
     public $forbiddenTags = [
+        '@author',
         '@category',
         '@package',
         '@subpackage'

diff --git a/Magento2/Sniffs/Less/ClassNamingSniff.php b/Magento2/Sniffs/Less/ClassNamingSniff.php
@@ -66,7 +66,10 @@ public function process(File $phpcsFile, $stackPtr)
                 [implode("", $matches[0])]
             );
         }
-        if (strpos($className, self::STRING_HELPER_CLASSES_PREFIX, 2) !== false) {
+
+        if (strlen($className) > 1 && strpos($className, self::STRING_HELPER_CLASSES_PREFIX, 2) !== false
+            && !str_starts_with($className, 'admin__')
+        ) {
             $phpcsFile->addError(
                 'CSS class names should be separated with "-" (dash) instead of "_" (underscore)',
                 $stackPtr,

diff --git a/Magento2/Sniffs/PHP/ShortEchoSyntaxSniff.php b/Magento2/Sniffs/PHP/ShortEchoSyntaxSniff.php
@@ -37,11 +37,30 @@ public function process(File $phpcsFile, $stackPtr)
 
         $nextToken = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true);
         if ($tokens[$nextToken]['code'] == T_ECHO) {
-            $phpcsFile->addWarning(
+            $fix = $phpcsFile->addFixableWarning(
                 'Short echo tag syntax must be used; expected "<?=" but found "<?php echo"',
                 $stackPtr,
                 'ShortEchoTag'
             );
+
+            if ($fix) {
+                $phpcsFile->fixer->beginChangeset();
+
+                if (($nextToken - $stackPtr) === 1) {
+                    $phpcsFile->fixer->replaceToken($stackPtr, '<?=');
+                } else {
+                    $phpcsFile->fixer->replaceToken($stackPtr, '<?= ');
+                }
+
+                for ($i = $stackPtr + 1; $i < $nextToken; $i++) {
+                    if ($tokens[$i]['code'] === T_WHITESPACE) {
+                        $phpcsFile->fixer->replaceToken($i, '');
+                    }
+                }
+
+                $phpcsFile->fixer->replaceToken($nextToken, '');
+                $phpcsFile->fixer->endChangeset();
+            }
         }
     }
 }
diff --git a/Magento2/Sniffs/Security/XssTemplateSniff.php b/Magento2/Sniffs/Security/XssTemplateSniff.php
@@ -135,6 +135,7 @@ public function process(File $phpcsFile, $stackPtr)
             $statement = array_shift($this->statements);
             $this->detectUnescapedString($statement);
         }
+        $this->hasDisallowedAnnotation = false;
     }
 
     /**

diff --git a/Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.1.inc b/Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.1.inc
@@ -60,9 +60,9 @@ class EmptyHandler
  * @api is ok here
  * @deprecated can be used in this context
  * @see is ok here
- * @author is actually ok
+ * @author should not be used
  * @category is irrelevant
- * @package is not ment to be used
+ * @package should not be used
  * @subpackage does not belong here
  */
 class ExampleHandler

diff --git a/Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.1.inc.fixed b/Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.1.inc.fixed
@@ -44,7 +44,6 @@ class EmptyHandler
  * @api is ok here
  * @deprecated can be used in this context
  * @see is ok here
- * @author is actually ok
  */
 class ExampleHandler
 {

diff --git a/Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.2.inc b/Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.2.inc
@@ -60,9 +60,9 @@ interface EmptyHandler
  * @api is ok here
  * @deprecated can be used in this context
  * @see is ok here
- * @author is actually ok
+ * @author should not be used
  * @category is irrelevant
- * @package is not ment to be used
+ * @package should not be used
  * @subpackage does not belong here
  */
 interface ExampleHandler

diff --git a/Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.2.inc.fixed b/Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.2.inc.fixed
@@ -44,7 +44,6 @@ interface EmptyHandler
  * @api is ok here
  * @deprecated can be used in this context
  * @see is ok here
- * @author is actually ok
  */
 interface ExampleHandler
 {

diff --git a/Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.php b/Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.php
@@ -29,6 +29,7 @@ public function getWarningList($testFile = '')
             35 => 1,
             44 => 1,
             52 => 1,
+            63 => 1,
             64 => 1,
             65 => 1,
             66 => 1,

diff --git a/Magento2/Tests/Less/ClassNamingUnitTest.less b/Magento2/Tests/Less/ClassNamingUnitTest.less
@@ -30,3 +30,13 @@
 .category-title {
   background: green;
 }
+
+// @see https://github.com/magento/magento-coding-standard/issues/425
+.a {
+  text-decoration: none;
+}
+
+// @see https://github.com/magento/magento-coding-standard/issues/409
+.admin__allowed {
+  background: green;
+}
diff --git a/Magento2/Tests/PHP/ShortEchoSyntaxUnitTest.inc b/Magento2/Tests/PHP/ShortEchoSyntaxUnitTest.inc
@@ -3,3 +3,5 @@
 <?php $foo = bar; ?>
 
 <?php echo "foo" ?>
+
+<?php /* @noEscape */ echo 'baz'; ?>
diff --git a/Magento2/Tests/PHP/ShortEchoSyntaxUnitTest.inc.fixed b/Magento2/Tests/PHP/ShortEchoSyntaxUnitTest.inc.fixed
@@ -0,0 +1,7 @@
+<?= "foo" ?>
+
+<?php $foo = bar; ?>
+
+<?= "foo" ?>
+
+<?= /* @noEscape */ 'baz'; ?>
diff --git a/Magento2/Tests/PHP/ShortEchoSyntaxUnitTest.php b/Magento2/Tests/PHP/ShortEchoSyntaxUnitTest.php
@@ -24,6 +24,7 @@ public function getWarningList()
     {
         return [
             5 => 1,
+            7 => 1,
         ];
     }
 }
diff --git a/composer.json b/composer.json
@@ -6,15 +6,16 @@
         "AFL-3.0"
     ],
     "type": "phpcodesniffer-standard",
-    "version": "30",
+    "version": "31",
     "require": {
         "php": ">=7.4",
         "webonyx/graphql-php": "^15.0",
         "ext-simplexml": "*",
         "ext-dom": "*",
         "phpcompatibility/php-compatibility": "^9.3",
         "squizlabs/php_codesniffer": "^3.6.1",
-        "rector/rector": "^0.14.8"
+        "rector/rector": "^0.15.10",
+        "symfony/polyfill": "^1.16"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5.8"

diff --git a/composer.lock b/composer.lock
-Original file line number
+Diff line change
@@ Expand Up / @@ -135,6 +135,7 @@ public function process(File $phpcsFile, $stackPtr) @@
                 $statement = array_shift($this->statements);
                 $this->detectUnescapedString($statement);
             }
+            $this->hasDisallowedAnnotation = false;
         }
         /**
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,3 +3,5 @@
		<?php $foo = bar; ?>

		<?php echo "foo" ?>

		<?php /* @noEscape */ echo 'baz'; ?>