diff --git a/Magento2/Sniffs/Html/HtmlClosingVoidTagsSniff.php b/Magento2/Sniffs/Html/HtmlClosingVoidTagsSniff.php
index 5ce7c20d..b70c5a35 100644
--- a/Magento2/Sniffs/Html/HtmlClosingVoidTagsSniff.php
+++ b/Magento2/Sniffs/Html/HtmlClosingVoidTagsSniff.php
@@ -13,7 +13,7 @@
/**
* Sniff for void closing tags.
*/
-class HtmlClosingVoidTagsSniff implements Sniff
+class HtmlClosingVoidTagsSniff extends HtmlSelfClosingTagsSniff implements Sniff
{
/**
* String representation of warning.
@@ -30,39 +30,6 @@ class HtmlClosingVoidTagsSniff implements Sniff
*/
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.
*
@@ -84,11 +51,25 @@ 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(
+ $ptr = $this->findPointer($phpcsFile, $match[0]);
+ $fix = $phpcsFile->addFixableWarning(
sprintf(self::WARNING_MESSAGE, $match[0]),
- null,
+ $ptr,
self::WARNING_CODE
);
+
+ if ($fix) {
+ $token = $phpcsFile->getTokens()[$ptr];
+ $original = $token['content'];
+ $replacement = str_replace(' />', '>', $original);
+ $replacement = str_replace('/>', '>', $replacement);
+
+ if (preg_match('{^\s* />}', $original)) {
+ $replacement = ' ' . $replacement;
+ }
+
+ $phpcsFile->fixer->replaceToken($ptr, $replacement);
+ }
}
}
}
diff --git a/Magento2/Sniffs/Html/HtmlSelfClosingTagsSniff.php b/Magento2/Sniffs/Html/HtmlSelfClosingTagsSniff.php
index ecbdca44..627b7152 100644
--- a/Magento2/Sniffs/Html/HtmlSelfClosingTagsSniff.php
+++ b/Magento2/Sniffs/Html/HtmlSelfClosingTagsSniff.php
@@ -17,13 +17,13 @@
class HtmlSelfClosingTagsSniff implements Sniff
{
/**
- * List of void elements
+ * List of void elements.
*
- * https://www.w3.org/TR/html51/syntax.html#writing-html-documents-elements
+ * https://html.spec.whatwg.org/multipage/syntax.html#void-elements
*
* @var string[]
*/
- private $voidElements = [
+ protected const HTML_VOID_ELEMENTS = [
'area',
'base',
'br',
@@ -32,16 +32,16 @@ class HtmlSelfClosingTagsSniff implements Sniff
'hr',
'img',
'input',
- 'keygen',
'link',
- 'menuitem',
'meta',
- 'param',
'source',
'track',
'wbr',
];
+ /** @var int */
+ private int $lastPointer = 0;
+
/**
* @inheritDoc
*/
@@ -55,7 +55,7 @@ public function register()
*
* @param File $phpcsFile
* @param int $stackPtr
- * @return int|void
+ * @return void
*/
public function process(File $phpcsFile, $stackPtr)
{
@@ -70,15 +70,63 @@ 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], $this->voidElements)) {
- $phpcsFile->addError(
+ if (!in_array($match[1], self::HTML_VOID_ELEMENTS)) {
+ $ptr = $this->findPointer($phpcsFile, $match[0]);
+ $fix = $phpcsFile->addFixableError(
'Avoid using self-closing tag with non-void html element'
- . ' - "' . $match[0] . PHP_EOL,
- null,
+ . ' - "' . $match[0] . PHP_EOL,
+ $ptr,
'HtmlSelfClosingNonVoidTag'
);
+
+ if ($fix) {
+ $token = $phpcsFile->getTokens()[$ptr];
+ $original = $token['content'];
+ $replacement = str_replace(' />', '></' . $match[1] . '>', $original);
+ $replacement = str_replace('/>', '></' . $match[1] . '>', $replacement);
+
+ if (preg_match('{^\s* />}', $original)) {
+ $replacement = ' ' . $replacement;
+ }
+
+ $phpcsFile->fixer->replaceToken($ptr, $replacement);
+ }
}
}
}
}
+
+ /**
+ * Apply a fix for the detected issue
+ *
+ * @param File $phpcsFile
+ * @param string $needle
+ * @return int|null
+ */
+ protected function findPointer(File $phpcsFile, string $needle): ?int
+ {
+ if (str_contains($needle, "\n")) {
+ foreach (explode("\n", $needle) as $line) {
+ $result = $this->findPointer($phpcsFile, $line);
+ }
+ return $result;
+ }
+
+ foreach ($phpcsFile->getTokens() as $ptr => $token) {
+ if ($ptr < $this->lastPointer) {
+ continue;
+ }
+
+ if ($token['code'] !== T_INLINE_HTML) {
+ continue;
+ }
+
+ if (str_contains($token['content'], $needle)) {
+ $this->lastPointer = $ptr;
+ return $ptr;
+ }
+ }
+
+ return null;
+ }
}
diff --git a/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.inc b/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.inc
index dd701d03..68f40388 100644
--- a/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.inc
+++ b/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.inc
@@ -22,14 +22,21 @@
<hr/>
<img src="" alt=""/>
<input type="text" id="test_input"/>
- <keygen/>
+ <input type="text"
+ id="multi-line-input"
+ placeholder="Alert should be on last line"
+ />
+ <input type="text"
+ id="multi-line-input2"
+ placeholder="Alert should be on last line" />
<link/>
<meta/>
- <param name="" value=""/>
<video>
<source/>
<track src=""/>
</video>
<wbr/>
+ <hr/>
+ <hr style="color: red" />
</body>
</html>
diff --git a/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.inc.fixed b/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.inc.fixed
new file mode 100644
index 00000000..42b503a0
--- /dev/null
+++ b/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.inc.fixed
@@ -0,0 +1,42 @@
+<!--
+/**
+ * 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">
+ <input type="text"
+ id="multi-line-input"
+ placeholder="Alert should be on last line"
+ >
+ <input type="text"
+ id="multi-line-input2"
+ placeholder="Alert should be on last line">
+ <link>
+ <meta>
+ <video>
+ <source>
+ <track src="">
+ </video>
+ <wbr>
+ <hr>
+ <hr style="color: red">
+</body>
+</html>
diff --git a/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.php b/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.php
index db95dd69..1e72c4b9 100644
--- a/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.php
+++ b/Magento2/Tests/Html/HtmlClosingVoidTagsUnitTest.php
@@ -22,6 +22,25 @@ public function getErrorList()
*/
public function getWarningList()
{
- return [1 => 15];
+ return [
+ 10 => 1,
+ 11 => 1,
+ 14 => 1,
+ 15 => 1,
+ 18 => 1,
+ 21 => 1,
+ 22 => 1,
+ 23 => 1,
+ 24 => 1,
+ 28 => 1,
+ 31 => 1,
+ 32 => 1,
+ 33 => 1,
+ 35 => 1,
+ 36 => 1,
+ 38 => 1,
+ 39 => 1,
+ 40 => 1,
+ ];
}
}
diff --git a/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.1.inc b/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.1.inc
index 3fadb203..1e207375 100644
--- a/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.1.inc
+++ b/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.1.inc
@@ -22,10 +22,15 @@
<hr/>
<img src="" alt=""/>
<input type="text" id="test_input"/>
- <keygen/>
+ <input type="text"
+ id="multi-line-input"
+ placeholder="Alert should be on last line"
+ />
+ <input type="text"
+ id="multi-line-input2"
+ placeholder="Alert should be on last line" />
<link/>
<meta/>
- <param name="" value=""/>
<video>
<source/>
<track src=""/>
@@ -33,6 +38,11 @@
<wbr/>
<label for="test_input"/>
+ <label
+ for="multi-line-input"
+ />
+ <label
+ for="multi-line-input2" />
<style type="text/css"/>
<div/>
<span/>
@@ -41,5 +51,7 @@
<each/>
<translate/>
<scope/>
+ <span/>
+ <span style="color: red" />
</body>
</html>
diff --git a/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.1.inc.fixed b/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.1.inc.fixed
new file mode 100644
index 00000000..38f04704
--- /dev/null
+++ b/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.1.inc.fixed
@@ -0,0 +1,57 @@
+<!--
+/**
+ * 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"/>
+ <input type="text"
+ id="multi-line-input"
+ placeholder="Alert should be on last line"
+ />
+ <input type="text"
+ id="multi-line-input2"
+ placeholder="Alert should be on last line" />
+ <link/>
+ <meta/>
+ <video>
+ <source/>
+ <track src=""/>
+ </video>
+ <wbr/>
+
+ <label for="test_input"></label>
+ <label
+ for="multi-line-input"
+ ></label>
+ <label
+ for="multi-line-input2"></label>
+ <style type="text/css"></style>
+ <div></div>
+ <span></span>
+ <text></text>
+ <render></render>
+ <each></each>
+ <translate></translate>
+ <scope></scope>
+ <span></span>
+ <span style="color: red"></span>
+ </body>
+</html>
diff --git a/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.php b/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.php
index dd6b0cef..869498d9 100644
--- a/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.php
+++ b/Magento2/Tests/Html/HtmlSelfClosingTagsUnitTest.php
@@ -14,7 +14,21 @@ class HtmlSelfClosingTagsUnitTest extends AbstractSniffUnitTest
*/
public function getErrorList()
{
- return [1 => 9];
+ return [
+ 40 => 1,
+ 43 => 1,
+ 45 => 1,
+ 46 => 1,
+ 47 => 1,
+ 48 => 1,
+ 49 => 1,
+ 50 => 1,
+ 51 => 1,
+ 52 => 1,
+ 53 => 1,
+ 54 => 1,
+ 55 => 1,
+ ];
}
/**