Ignore HTML blocks in MD018

fyc09 · Jul 17, 2024 · 1059aa6 · 1059aa6
1 parent a5ea9be
commit 1059aa6
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 11 deletions.
diff --git a/demo/markdownlint-browser.js b/demo/markdownlint-browser.js
@@ -365,7 +365,7 @@ module.exports.filterTokens = filterTokens;
  */
 function getLineMetadata(params) {
   const lineMetadata = params.lines.map(
-    (line, index) => [ line, index, false, 0, false, false, false ]
+    (line, index) => [ line, index, false, 0, false, false, false, false ]
   );
   filterTokens(params, "fence", (token) => {
     lineMetadata[token.map[0]][3] = 1;
@@ -394,6 +394,11 @@ function getLineMetadata(params) {
   filterTokens(params, "hr", (token) => {
     lineMetadata[token.map[0]][6] = true;
   });
+  filterTokens(params, "html_block", (token) => {
+    for (let i = token.map[0]; i < token.map[1]; i++) {
+      lineMetadata[i][7] = true;
+    }
+  });
   return lineMetadata;
 }
 module.exports.getLineMetadata = getLineMetadata;
@@ -407,6 +412,7 @@ module.exports.getLineMetadata = getLineMetadata;
  * @param {boolean} inTable Iff in a table.
  * @param {boolean} inItem Iff in a list item.
  * @param {boolean} inBreak Iff in semantic break.
+ * @param {boolean} inHTML Iff in HTML.
  * @returns {void}
  */
 
@@ -4210,8 +4216,8 @@ module.exports = {
   "tags": [ "headings", "atx", "spaces" ],
   "parser": "none",
   "function": function MD018(params, onError) {
-    forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
-      if (!inCode &&
+    forEachLine(lineMetadata(), (line, lineIndex, inCode, inFence, inTable, inItem, inBreak, inHTML) => {
+      if (!inCode && !inHTML &&
         /^#+[^# \t]/.test(line) &&
         !/#\s*$/.test(line) &&
         !line.startsWith("#️⃣")) {

diff --git a/helpers/helpers.js b/helpers/helpers.js
@@ -353,7 +353,7 @@ module.exports.filterTokens = filterTokens;
  */
 function getLineMetadata(params) {
   const lineMetadata = params.lines.map(
-    (line, index) => [ line, index, false, 0, false, false, false ]
+    (line, index) => [ line, index, false, 0, false, false, false, false ]
   );
   filterTokens(params, "fence", (token) => {
     lineMetadata[token.map[0]][3] = 1;
@@ -367,11 +367,6 @@ function getLineMetadata(params) {
       lineMetadata[i][2] = true;
     }
   });
-  filterTokens(params, "html_block", (token) => {
-    for (let i = token.map[0]; i < token.map[1]; i++) {
-      lineMetadata[i][2] = true;
-    }
-  });
   filterTokens(params, "table_open", (token) => {
     for (let i = token.map[0]; i < token.map[1]; i++) {
       lineMetadata[i][4] = true;
@@ -387,6 +382,11 @@ function getLineMetadata(params) {
   filterTokens(params, "hr", (token) => {
     lineMetadata[token.map[0]][6] = true;
   });
+  filterTokens(params, "html_block", (token) => {
+    for (let i = token.map[0]; i < token.map[1]; i++) {
+      lineMetadata[i][7] = true;
+    }
+  });
   return lineMetadata;
 }
 module.exports.getLineMetadata = getLineMetadata;
@@ -400,6 +400,7 @@ module.exports.getLineMetadata = getLineMetadata;
  * @param {boolean} inTable Iff in a table.
  * @param {boolean} inItem Iff in a list item.
  * @param {boolean} inBreak Iff in semantic break.
+ * @param {boolean} inHTML Iff in HTML.
  * @returns {void}
  */
 

diff --git a/lib/md018.js b/lib/md018.js
@@ -13,8 +13,8 @@ module.exports = {
   "tags": [ "headings", "atx", "spaces" ],
   "parser": "none",
   "function": function MD018(params, onError) {
-    forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
-      if (!inCode &&
+    forEachLine(lineMetadata(), (line, lineIndex, inCode, inFence, inTable, inItem, inBreak, inHTML) => {
+      if (!inCode && !inHTML &&
         /^#+[^# \t]/.test(line) &&
         !/#\s*$/.test(line) &&
         !line.startsWith("#️⃣")) {

diff --git a/test/ignore-html-block.md b/test/ignore-html-block.md
@@ -0,0 +1,9 @@
+# ignore-html-block.md
+
+## Title
+
+##Title2 {MD018}
+
+<style> {MD033}
+#foo {}
+</style>
diff --git a/test/snapshots/markdownlint-test-scenarios.js.snap b/test/snapshots/markdownlint-test-scenarios.js.snap