Automatically fix closing tags when possible

fredden · fredden · commit 436084e65512 · 2023-01-31T18:54:43.000Z
diff --git a/Magento2/Sniffs/Html/HtmlClosingVoidTagsSniff.php b/Magento2/Sniffs/Html/HtmlClosingVoidTagsSniff.php
@@ -82,13 +82,41 @@ public function process(File $phpcsFile, $stackPtr): void
         if (preg_match_all('$<(\w{2,})\s?[^<]*\/>$', $html, $matches, PREG_SET_ORDER)) {
             foreach ($matches as $match) {
                 if (in_array($match[1], self::HTML_VOID_ELEMENTS)) {
-                    $phpcsFile->addWarning(
+                    $fix = $phpcsFile->addFixableWarning(
                         sprintf(self::WARNING_MESSAGE, $match[0]),
                         null,
                         self::WARNING_CODE
                     );
+
+                    if ($fix) {
+                        $this->fixClosingTag($phpcsFile, $match[0]);
+                    }
                 }
             }
         }
     }
+
+    /**
+     * Apply a fix for the detected issue
+     *
+     * @param File $phpcsFile
+     * @param string $needle
+     */
+    public function fixClosingTag(File $phpcsFile, string $needle): void
+    {
+        foreach ($phpcsFile->getTokens() as $ptr => $token) {
+            if ($token['code'] !== T_INLINE_HTML) {
+                continue;
+            }
+
+            if (str_contains($token['content'], $needle)) {
+                $original = $needle;
+                $replacement = str_replace('/>', '>', $original);
+
+                $phpcsFile->fixer->replaceToken($ptr, str_replace($original, $replacement, $token['content']));
+
+                break;
+            }
+        }
+    }
 }
diff --git a/Magento2/Sniffs/Html/HtmlSelfClosingTagsSniff.php b/Magento2/Sniffs/Html/HtmlSelfClosingTagsSniff.php
@@ -68,14 +68,42 @@ public function process(File $phpcsFile, $stackPtr)
         if (preg_match_all('$<(\w{2,})\s?[^<]*\/>$', $html, $matches, PREG_SET_ORDER)) {
             foreach ($matches as $match) {
                 if (!in_array($match[1], self::HTML_VOID_ELEMENTS)) {
-                    $phpcsFile->addError(
+                    $fix = $phpcsFile->addFixableError(
                         'Avoid using self-closing tag with non-void html element'
                         . ' - "' . $match[0]  . PHP_EOL,
                         null,
                         'HtmlSelfClosingNonVoidTag'
                     );
+
+                    if ($fix) {
+                        $this->fixClosingTag($phpcsFile, $match);
+                    }
                 }
             }
         }
     }
+
+    /**
+     * Apply a fix for the detected issue
+     *
+     * @param File  $phpcsFile
+     * @param array $match
+     */
+    private function fixClosingTag(File $phpcsFile, array $match): void
+    {
+        foreach ($phpcsFile->getTokens() as $ptr => $token) {
+            if ($token['code'] !== T_INLINE_HTML) {
+                continue;
+            }
+
+            if (str_contains($token['content'], $match[0])) {
+                $original = $match[0];
+                $replacement = str_replace('/>', '></' . $match[1] . '>', $original);
+
+                $phpcsFile->fixer->replaceToken($ptr, str_replace($original, $replacement, $token['content']));
+
+                return;
+            }
+        }
+    }
 }
diff --git a/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.inc.fixed b/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.inc.fixed
@@ -0,0 +1,33 @@
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+
+<html>
+<head>
+    <base>
+    <link>
+</head>
+<body>
+    <area alt="">
+    <br>
+    <table>
+        <colgroup>
+            <col>
+        </colgroup>
+    </table>
+    <embed>
+    <hr>
+    <img src="" alt="">
+    <input type="text" id="test_input">
+    <link>
+    <meta>
+    <video>
+        <source>
+        <track src="">
+    </video>
+    <wbr>
+</body>
+</html>
diff --git a/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.1.inc.fixed b/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.1.inc.fixed
@@ -0,0 +1,43 @@
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+
+<html>
+    <head>
+        <base/>
+        <link/>
+    </head>
+    <body>
+        <area alt=""/>
+        <br/>
+        <table>
+            <colgroup>
+                <col/>
+            </colgroup>
+        </table>
+        <embed/>
+        <hr/>
+        <img src="" alt=""/>
+        <input type="text" id="test_input"/>
+        <link/>
+        <meta/>
+        <video>
+            <source/>
+            <track src=""/>
+        </video>
+        <wbr/>
+
+        <label for="test_input"></label>
+        <style type="text/css"></style>
+        <div></div>
+        <span></span>
+        <text></text>
+        <render></render>
+        <each></each>
+        <translate></translate>
+        <scope></scope>
+    </body>
+</html>
diff --git a/composer.json b/composer.json
@@ -14,7 +14,8 @@
         "ext-dom": "*",
         "phpcompatibility/php-compatibility": "^9.3",
         "squizlabs/php_codesniffer": "^3.6.1",
-        "rector/rector": "^0.14.8"
+        "rector/rector": "^0.14.8",
+        "symfony/polyfill": "^1.15"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5.8"
diff --git a/composer.lock b/composer.lock
