From 6f35ad804d63bb1371b9f95dd86fa5510032646c Mon Sep 17 00:00:00 2001
From: Dan Wallis <dan@wallis.nz>
Date: Tue, 25 Apr 2023 17:57:47 +0100
Subject: [PATCH 1/2] Also lint HTML when not at start of file

---
 .../Sniffs/Html/HtmlClosingVoidTagsSniff.php  |  7 ++-
 .../Html/HtmlCollapsibleAttributeSniff.php    |  7 ++-
 Magento2/Sniffs/Html/HtmlDirectiveSniff.php   |  7 ++-
 .../Sniffs/Html/HtmlSelfClosingTagsSniff.php  |  7 ++-
 ....inc => HtmlClosingVoidTagsUnitTest.1.inc} |  0
 .../Html/HtmlClosingVoidTagsUnitTest.2.inc    | 35 +++++++++++++++
 .../HtmlCollapsibleAttributeUnitTest.2.inc    | 35 +++++++++++++++
 .../Html/HtmlSelfClosingTagsUnitTest.2.inc    | 45 +++++++++++++++++++
 8 files changed, 135 insertions(+), 8 deletions(-)
 rename Magento2/Tests/Html/{HtmlClosingVoidTagsUnitTest.inc => HtmlClosingVoidTagsUnitTest.1.inc} (100%)
 create mode 100644 Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.2.inc
 create mode 100644 Magento2/Tests/Html/HtmlCollapsibleAttributeUnitTest.2.inc
 create mode 100644 Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.2.inc

diff --git a/Magento2/Sniffs/Html/HtmlClosingVoidTagsSniff.php b/Magento2/Sniffs/Html/HtmlClosingVoidTagsSniff.php
index 5ce7c20d..e2005fd3 100644
--- a/Magento2/Sniffs/Html/HtmlClosingVoidTagsSniff.php
+++ b/Magento2/Sniffs/Html/HtmlClosingVoidTagsSniff.php
@@ -72,10 +72,13 @@ public function register(): array
      */
     public function process(File $phpcsFile, $stackPtr): void
     {
-        if ($stackPtr !== 0) {
+        static $lastFile;
+        if ($lastFile === $phpcsFile->getFilename()) {
             return;
         }
-        $html = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()));
+        $lastFile = $phpcsFile->getFilename();
+
+        $html = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()) - $stackPtr);
 
         if (empty($html)) {
             return;
diff --git a/Magento2/Sniffs/Html/HtmlCollapsibleAttributeSniff.php b/Magento2/Sniffs/Html/HtmlCollapsibleAttributeSniff.php
index 8798c416..79fdd93b 100644
--- a/Magento2/Sniffs/Html/HtmlCollapsibleAttributeSniff.php
+++ b/Magento2/Sniffs/Html/HtmlCollapsibleAttributeSniff.php
@@ -33,10 +33,13 @@ public function register()
      */
     public function process(File $phpcsFile, $stackPtr)
     {
-        if ($stackPtr !== 0) {
+        static $lastFile;
+        if ($lastFile === $phpcsFile->getFilename()) {
             return;
         }
-        $html = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()));
+        $lastFile = $phpcsFile->getFilename();
+
+        $html = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()) - $stackPtr);
 
         if (empty($html)) {
             return;
diff --git a/Magento2/Sniffs/Html/HtmlDirectiveSniff.php b/Magento2/Sniffs/Html/HtmlDirectiveSniff.php
index 2fdc0518..82ddae5d 100644
--- a/Magento2/Sniffs/Html/HtmlDirectiveSniff.php
+++ b/Magento2/Sniffs/Html/HtmlDirectiveSniff.php
@@ -50,11 +50,14 @@ public function process(File $phpcsFile, $stackPtr)
     {
         $this->usedVariables = [];
         $this->unfilteredVariables = [];
-        if ($stackPtr !== 0) {
+
+        static $lastFile;
+        if ($lastFile === $phpcsFile->getFilename()) {
             return;
         }
+        $lastFile = $phpcsFile->getFilename();
 
-        $html = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()));
+        $html = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()) - $stackPtr);
 
         if (empty($html)) {
             return;
diff --git a/Magento2/Sniffs/Html/HtmlSelfClosingTagsSniff.php b/Magento2/Sniffs/Html/HtmlSelfClosingTagsSniff.php
index ecbdca44..574b2b20 100644
--- a/Magento2/Sniffs/Html/HtmlSelfClosingTagsSniff.php
+++ b/Magento2/Sniffs/Html/HtmlSelfClosingTagsSniff.php
@@ -59,10 +59,13 @@ public function register()
      */
     public function process(File $phpcsFile, $stackPtr)
     {
-        if ($stackPtr !== 0) {
+        static $lastFile;
+        if ($lastFile === $phpcsFile->getFilename()) {
             return;
         }
-        $html = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()));
+        $lastFile = $phpcsFile->getFilename();
+
+        $html = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()) - $stackPtr);
 
         if (empty($html)) {
             return;
diff --git a/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.inc b/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.1.inc
similarity index 100%
rename from Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.inc
rename to Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.1.inc
diff --git a/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.2.inc b/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.2.inc
new file mode 100644
index 00000000..336c75a1
--- /dev/null
+++ b/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.2.inc
@@ -0,0 +1,35 @@
+<?php
+/**
+ * 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/HtmlCollapsibleAttributeUnitTest.2.inc b/Magento2/Tests/Html/HtmlCollapsibleAttributeUnitTest.2.inc
new file mode 100644
index 00000000..6551f9ff
--- /dev/null
+++ b/Magento2/Tests/Html/HtmlCollapsibleAttributeUnitTest.2.inc
@@ -0,0 +1,35 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+?>
+
+<html>
+    <head>
+        <base/>
+        <link/>
+    </head>
+    <body>
+        <div class="action-dropdown">
+            <button type="button" class="action-toggle" data-mage-init='{"dropdown":{}}' data-toggle="dropdown">
+                <span>Test</span>
+            </button>
+        </div>
+        <div class="fieldset-wrapper-title">
+            <strong class="admin__collapsible-title" data-toggle="collapse" data-bind="attr:{'data-target': '#'+id}">
+                <span data-bind="text: title"></span>
+            </strong>
+        </div>
+        <div class="admin__collapsible-title"
+            data-toggle="collapse"
+            data-target="#id-content">
+            <span>Test</span>
+        </div>
+        <strong <?= /* @noEscape */ $isCollapsable ?
+            'class="admin__collapsible-title" data-toggle="collapse" data-target="#' . $id . '-content"' :
+            'class="title"'; ?>>
+            <span><?= $block->escapeHtml($element->getLegend()) ?></span>
+        </strong>
+    </body>
+</html>
diff --git a/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.2.inc b/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.2.inc
new file mode 100644
index 00000000..70d92444
--- /dev/null
+++ b/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.2.inc
@@ -0,0 +1,45 @@
+<?php
+/**
+ * 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>

From 2b33847ce1301e2718b4a9162a0369a1915d0126 Mon Sep 17 00:00:00 2001
From: Dan Wallis <dan@wallis.nz>
Date: Tue, 2 Jan 2024 12:06:16 +0000
Subject: [PATCH 2/2] Use built-in feature to skip remaining tokens

---
 .../Sniffs/Html/HtmlClosingVoidTagsSniff.php   | 18 ++++++++----------
 .../Html/HtmlCollapsibleAttributeSniff.php     | 18 ++++++++----------
 Magento2/Sniffs/Html/HtmlDirectiveSniff.php    | 18 ++++++++----------
 .../Sniffs/Html/HtmlSelfClosingTagsSniff.php   | 18 ++++++++----------
 4 files changed, 32 insertions(+), 40 deletions(-)

diff --git a/Magento2/Sniffs/Html/HtmlClosingVoidTagsSniff.php b/Magento2/Sniffs/Html/HtmlClosingVoidTagsSniff.php
index e2005fd3..c0e6ce46 100644
--- a/Magento2/Sniffs/Html/HtmlClosingVoidTagsSniff.php
+++ b/Magento2/Sniffs/Html/HtmlClosingVoidTagsSniff.php
@@ -68,20 +68,16 @@ public function register(): array
      *
      * @param File $phpcsFile
      * @param int $stackPtr
-     * @return void
+     *
+     * @return int
      */
-    public function process(File $phpcsFile, $stackPtr): void
+    public function process(File $phpcsFile, $stackPtr): int
     {
-        static $lastFile;
-        if ($lastFile === $phpcsFile->getFilename()) {
-            return;
-        }
-        $lastFile = $phpcsFile->getFilename();
-
-        $html = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()) - $stackPtr);
+        $tokenCount = count($phpcsFile->getTokens());
+        $html = $phpcsFile->getTokensAsString($stackPtr, $tokenCount - $stackPtr);
 
         if (empty($html)) {
-            return;
+            return $tokenCount + 1;
         }
 
         if (preg_match_all('$<(\w{2,})\s?[^<]*\/>$', $html, $matches, PREG_SET_ORDER)) {
@@ -95,5 +91,7 @@ public function process(File $phpcsFile, $stackPtr): void
                 }
             }
         }
+
+        return $tokenCount + 1;
     }
 }
diff --git a/Magento2/Sniffs/Html/HtmlCollapsibleAttributeSniff.php b/Magento2/Sniffs/Html/HtmlCollapsibleAttributeSniff.php
index 79fdd93b..c5a5672a 100644
--- a/Magento2/Sniffs/Html/HtmlCollapsibleAttributeSniff.php
+++ b/Magento2/Sniffs/Html/HtmlCollapsibleAttributeSniff.php
@@ -29,20 +29,16 @@ public function register()
      *
      * @param File $phpcsFile
      * @param int $stackPtr
-     * @return int|void
+     *
+     * @return int
      */
-    public function process(File $phpcsFile, $stackPtr)
+    public function process(File $phpcsFile, $stackPtr): int
     {
-        static $lastFile;
-        if ($lastFile === $phpcsFile->getFilename()) {
-            return;
-        }
-        $lastFile = $phpcsFile->getFilename();
-
-        $html = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()) - $stackPtr);
+        $tokenCount = count($phpcsFile->getTokens());
+        $html = $phpcsFile->getTokensAsString($stackPtr, $tokenCount - $stackPtr);
 
         if (empty($html)) {
-            return;
+            return $tokenCount + 1;
         }
 
         $pattern = '$<\w+.*?\s*(?=.*?\s*data-toggle="collapse")[^>]*?>.*?$';
@@ -57,5 +53,7 @@ public function process(File $phpcsFile, $stackPtr)
                 );
             }
         }
+
+        return $tokenCount + 1;
     }
 }
diff --git a/Magento2/Sniffs/Html/HtmlDirectiveSniff.php b/Magento2/Sniffs/Html/HtmlDirectiveSniff.php
index 82ddae5d..e8589440 100644
--- a/Magento2/Sniffs/Html/HtmlDirectiveSniff.php
+++ b/Magento2/Sniffs/Html/HtmlDirectiveSniff.php
@@ -44,23 +44,19 @@ public function register()
      *
      * @param File $phpcsFile
      * @param int $stackPtr
-     * @return int|void
+     *
+     * @return int
      */
-    public function process(File $phpcsFile, $stackPtr)
+    public function process(File $phpcsFile, $stackPtr): int
     {
         $this->usedVariables = [];
         $this->unfilteredVariables = [];
 
-        static $lastFile;
-        if ($lastFile === $phpcsFile->getFilename()) {
-            return;
-        }
-        $lastFile = $phpcsFile->getFilename();
-
-        $html = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()) - $stackPtr);
+        $tokenCount = count($phpcsFile->getTokens());
+        $html = $phpcsFile->getTokensAsString($stackPtr, $tokenCount - $stackPtr);
 
         if (empty($html)) {
-            return;
+            return $tokenCount + 1;
         }
 
         $html = $this->processIfDirectives($html, $phpcsFile);
@@ -69,6 +65,8 @@ public function process(File $phpcsFile, $stackPtr)
         $html = $this->processVarDirectivesAndParams($html, $phpcsFile);
 
         $this->validateDefinedVariables($phpcsFile, $html);
+
+        return $tokenCount + 1;
     }
 
     /**
diff --git a/Magento2/Sniffs/Html/HtmlSelfClosingTagsSniff.php b/Magento2/Sniffs/Html/HtmlSelfClosingTagsSniff.php
index 574b2b20..c647f48c 100644
--- a/Magento2/Sniffs/Html/HtmlSelfClosingTagsSniff.php
+++ b/Magento2/Sniffs/Html/HtmlSelfClosingTagsSniff.php
@@ -55,20 +55,16 @@ public function register()
      *
      * @param File $phpcsFile
      * @param int $stackPtr
-     * @return int|void
+     *
+     * @return int
      */
-    public function process(File $phpcsFile, $stackPtr)
+    public function process(File $phpcsFile, $stackPtr): int
     {
-        static $lastFile;
-        if ($lastFile === $phpcsFile->getFilename()) {
-            return;
-        }
-        $lastFile = $phpcsFile->getFilename();
-
-        $html = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()) - $stackPtr);
+        $tokenCount = count($phpcsFile->getTokens());
+        $html = $phpcsFile->getTokensAsString($stackPtr, $tokenCount - $stackPtr);
 
         if (empty($html)) {
-            return;
+            return $tokenCount + 1;
         }
 
         if (preg_match_all('$<(\w{2,})\s?[^<]*\/>$', $html, $matches, PREG_SET_ORDER)) {
@@ -83,5 +79,7 @@ public function process(File $phpcsFile, $stackPtr)
                 }
             }
         }
+
+        return $tokenCount + 1;
     }
 }