Merge pull request #59 from magento-trigger/AC-1102

mmansoor-magento · web-flow · commit adc7d5a30b3c · 2021-09-21T07:00:48.000-07:00
AC-1102: Static test to verify self-closing tags for non-void html elements
diff --git a/Magento2/Sniffs/Html/HtmlSelfClosingTagsSniff.php b/Magento2/Sniffs/Html/HtmlSelfClosingTagsSniff.php
@@ -0,0 +1,84 @@
+<?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 self-closing tags
+ */
+class HtmlSelfClosingTagsSniff implements Sniff
+{
+    /**
+     * List of void elements
+     *
+     * https://www.w3.org/TR/html51/syntax.html#writing-html-documents-elements
+     *
+     * @var string[]
+     */
+    private $voidElements = [
+        'area',
+        'base',
+        'br',
+        'col',
+        'embed',
+        'hr',
+        'img',
+        'input',
+        'keygen',
+        'link',
+        'menuitem',
+        'meta',
+        'param',
+        'source',
+        'track',
+        'wbr',
+    ];
+
+    /**
+     * @inheritDoc
+     */
+    public function register()
+    {
+        return [T_INLINE_HTML];
+    }
+
+    /**
+     * Detect use of self-closing tag with non-void html element
+     *
+     * @param File $phpcsFile
+     * @param int $stackPtr
+     * @return int|void
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        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], $this->voidElements)) {
+                    $phpcsFile->addError(
+                        'Avoid using self-closing tag with non-void html element'
+                        . ' - "' . $match[0]  . PHP_EOL,
+                        null,
+                        'HtmlSelfClosingNonVoidTag'
+                    );
+                }
+            }
+        }
+    }
+}
diff --git a/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.1.inc b/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.1.inc
@@ -0,0 +1,45 @@
+<!--
+/**
+ * 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/>
+
+        <label for="test_input"/>
+        <style type="text/css"/>
+        <div/>
+        <span/>
+        <text/>
+        <render/>
+        <each/>
+        <translate/>
+        <scope/>
+    </body>
+</html>
diff --git a/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.php b/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.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 HtmlSelfClosingTagsUnitTest extends AbstractSniffUnitTest
+{
+    /**
+     * @inheritdoc
+     */
+    public function getErrorList()
+    {
+        return [1 => 9];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getWarningList()
+    {
+        return [];
+    }
+}
diff --git a/Magento2/ruleset.xml b/Magento2/ruleset.xml
@@ -116,6 +116,11 @@
         <type>error</type>
     </rule>
 
+    <rule ref="Magento2.Html.HtmlSelfClosingTags">
+        <severity>10</severity>
+        <type>error</type>
+        <exclude-pattern>*\.xml$</exclude-pattern>
+    </rule>
     <!-- Severity 9 warnings: Possible security and issues that may cause bugs. -->
     <rule ref="Generic.Files.ByteOrderMark">
         <severity>9</severity>
@@ -153,6 +158,7 @@
     <rule ref="Magento2.Html.HtmlBinding">
         <severity>9</severity>
         <type>warning</type>
+        <exclude-pattern>*\.xml$</exclude-pattern>
     </rule>
 
     <!-- Severity 8 warnings: Magento specific code issues and design violations. -->
@@ -246,6 +252,7 @@
     <rule ref="Magento2.Html.HtmlDirective">
         <severity>8</severity>
         <type>warning</type>
+        <exclude-pattern>*\.xml$</exclude-pattern>
     </rule>
     <rule ref="Magento2.Legacy.WidgetXML.FoundObsoleteNode">
         <include-pattern>*\/widget.xml$</include-pattern>
