AC-1999: Static test to check void closing tags

anzin · anzin · commit e34145508a53 · 2022-01-25T12:11:18.000+02:00
diff --git a/Magento2/Sniffs/Html/HtmlClosingVoidTagsSniff.php b/Magento2/Sniffs/Html/HtmlClosingVoidTagsSniff.php
@@ -0,0 +1,96 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento2\Sniffs\Html;
+
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Files\File;
+
+/**
+ * Sniff for void closing tags.
+ */
+class HtmlClosingVoidTagsSniff implements Sniff
+{
+    /**
+     * String representation of warning.
+     *
+     * @var string
+     */
+    private const WARNING_MESSAGE =
+        'Avoid using closing slash with void tags, this can lead to unexpected behavior - "%s"';
+
+    /**
+     * Warning violation code.
+     *
+     * @var string
+     */
+    private const WARNING_CODE = 'HtmlClosingVoidElements';
+
+    /**
+     * List of void elements.
+     *
+     * https://html.spec.whatwg.org/multipage/syntax.html#void-elements
+     *
+     * @var string[]
+     */
+    private const HTML_VOID_ELEMENTS = [
+        'area',
+        'base',
+        'br',
+        'col',
+        'embed',
+        'hr',
+        'input',
+        'keygen',
+        'link',
+        'menuitem',
+        'meta',
+        'param',
+        'source',
+        'track',
+        'wbr'
+    ];
+
+    /**
+     * @inheritdoc
+     */
+    public function register(): array
+    {
+        return [T_INLINE_HTML];
+    }
+
+    /**
+     * Detect use of self-closing tag with void html element.
+     *
+     * @param File $phpcsFile
+     * @param int $stackPtr
+     * @return void
+     */
+    public function process(File $phpcsFile, $stackPtr): void
+    {
+        if ($stackPtr !== 0) {
+            return;
+        }
+        $html = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()));
+
+        if (empty($html)) {
+            return;
+        }
+
+        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(
+                        sprintf(self::WARNING_MESSAGE, $match[0]),
+                        null,
+                        self::WARNING_CODE
+                    );
+                }
+            }
+        }
+    }
+}
diff --git a/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.inc b/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.inc
@@ -0,0 +1,35 @@
+<!--
+/**
+ * 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"/>
+    <keygen/>
+    <link/>
+    <meta/>
+    <param name="" value=""/>
+    <video>
+        <source/>
+        <track src=""/>
+    </video>
+    <wbr/>
+</body>
+</html>
diff --git a/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.php b/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.php
@@ -0,0 +1,27 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento2\Tests\Html;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+class HtmlClosingVoidTagsUnitTest extends AbstractSniffUnitTest
+{
+    /**
+     * @inheritdoc
+     */
+    public function getErrorList()
+    {
+        return [];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getWarningList()
+    {
+        return [1 => 15];
+    }
+}
diff --git a/Magento2/ruleset.xml b/Magento2/ruleset.xml
@@ -138,6 +138,11 @@
         <type>error</type>
         <exclude-pattern>*\.xml$</exclude-pattern>
     </rule>
+    <rule ref="Magento2.Html.HtmlClosingVoidTags">
+        <severity>10</severity>
+        <type>warning</type>
+        <exclude-pattern>*\.xml$</exclude-pattern>
+    </rule>
     <rule ref="Magento2.Html.HtmlCollapsibleAttribute">
         <include-pattern>*\.html$</include-pattern>
         <include-pattern>*\.phtml$</include-pattern>
