Update MD033/no-inline-html to ignore HTML in labels for reference links/images (fixes #658).

demo/markdownlint-browser.js

@@ -894,7 +894,9 @@ function getReferenceLinkImageData(lineMetadata) {
                         referenceData.push([
                             lineIndex,
                             referenceIndex,
-                            matchString.length
+                            matchString.length,
+                            matchText.length,
+                            matchLabel.length
                         ]);
                         references.set(label, referenceData);
                     }
@@ -3688,7 +3690,7 @@ module.exports = {
 // @ts-check
 
 const { addError, forEachLine, htmlElementRe, withinAnyRange, unescapeMarkdown } = __webpack_require__(/*! ../helpers */ "../helpers/helpers.js");
-const { codeBlockAndSpanRanges, lineMetadata } = __webpack_require__(/*! ./cache */ "../lib/cache.js");
+const { codeBlockAndSpanRanges, lineMetadata, referenceLinkImageData } = __webpack_require__(/*! ./cache */ "../lib/cache.js");
 const linkDestinationRe = /]\(\s*$/;
 // See https://spec.commonmark.org/0.29/#autolinks
 const emailAddressRe = 
@@ -3703,6 +3705,15 @@ module.exports = {
         allowedElements = Array.isArray(allowedElements) ? allowedElements : [];
         allowedElements = allowedElements.map((element) => element.toLowerCase());
         const exclusions = codeBlockAndSpanRanges();
+        const { references, definitionLineIndices } = referenceLinkImageData();
+        for (const datas of references.values()) {
+            for (const data of datas) {
+                const [lineIndex, index, , textLength, labelLength] = data;
+                if (labelLength > 0) {
+                    exclusions.push([lineIndex, index + 3 + textLength, labelLength]);
+                }
+            }
+        }
         forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
             let match = null;
             // eslint-disable-next-line no-unmodified-loop-condition
@@ -3711,7 +3722,8 @@ module.exports = {
                 if (!allowedElements.includes(element.toLowerCase()) &&
                     !tag.endsWith("\\>") &&
                     !emailAddressRe.test(content) &&
-                    !withinAnyRange(exclusions, lineIndex, match.index, match[0].length)) {
+                    !withinAnyRange(exclusions, lineIndex, match.index, tag.length) &&
+                    !definitionLineIndices.includes(lineIndex)) {
                     const prefix = line.substring(0, match.index);
                     if (!linkDestinationRe.test(prefix)) {
                         const unescaped = unescapeMarkdown(prefix + "<", "_");

helpers/helpers.js

@@ -931,7 +931,9 @@ function getReferenceLinkImageData(lineMetadata) {
             referenceData.push([
               lineIndex,
               referenceIndex,
-              matchString.length
+              matchString.length,
+              matchText.length,
+              matchLabel.length
             ]);
             references.set(label, referenceData);
           }

lib/md033.js

@@ -5,7 +5,8 @@
 const {
   addError, forEachLine, htmlElementRe, withinAnyRange, unescapeMarkdown
 } = require("../helpers");
-const { codeBlockAndSpanRanges, lineMetadata } = require("./cache");
+const { codeBlockAndSpanRanges, lineMetadata, referenceLinkImageData } =
+  require("./cache");
 
 const linkDestinationRe = /]\(\s*$/;
 // See https://spec.commonmark.org/0.29/#autolinks
@@ -22,6 +23,15 @@ module.exports = {
     allowedElements = Array.isArray(allowedElements) ? allowedElements : [];
     allowedElements = allowedElements.map((element) => element.toLowerCase());
     const exclusions = codeBlockAndSpanRanges();
+    const { references, definitionLineIndices } = referenceLinkImageData();
+    for (const datas of references.values()) {
+      for (const data of datas) {
+        const [ lineIndex, index, , textLength, labelLength ] = data;
+        if (labelLength > 0) {
+          exclusions.push([ lineIndex, index + 3 + textLength, labelLength ]);
+        }
+      }
+    }
     forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
       let match = null;
       // eslint-disable-next-line no-unmodified-loop-condition
@@ -31,7 +41,8 @@ module.exports = {
           !allowedElements.includes(element.toLowerCase()) &&
           !tag.endsWith("\\>") &&
           !emailAddressRe.test(content) &&
-          !withinAnyRange(exclusions, lineIndex, match.index, match[0].length)
+          !withinAnyRange(exclusions, lineIndex, match.index, tag.length) &&
+          !definitionLineIndices.includes(lineIndex)
         ) {
           const prefix = line.substring(0, match.index);
           if (!linkDestinationRe.test(prefix)) {

test/inline_html.md

@@ -120,3 +120,14 @@ code {MD046:114}
 Text `code <element> code` text
 
 Text <element> text {MD033}
+
+A [<link-with>][a-reference] is problematic. {MD033}
+
+A [link with][a-<reference>] is okay.
+
+A link with [a-<reference>][] is problematic. {MD033}
+
+A link with [a-<reference>] is problematic. {MD033}
+
+[a-reference]: https://example.com/
+[a-<reference>]: https://example.com/

test/snapshots/markdownlint-test-scenarios.js.md

@@ -20807,6 +20807,54 @@ Generated by [AVA](https://avajs.dev).
             'no-inline-html',
           ],
         },
+        {
+          errorContext: null,
+          errorDetail: 'Element: link-with',
+          errorRange: [
+            4,
+            11,
+          ],
+          fixInfo: null,
+          lineNumber: 124,
+          ruleDescription: 'Inline HTML',
+          ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md033.md',
+          ruleNames: [
+            'MD033',
+            'no-inline-html',
+          ],
+        },
+        {
+          errorContext: null,
+          errorDetail: 'Element: reference',
+          errorRange: [
+            16,
+            11,
+          ],
+          fixInfo: null,
+          lineNumber: 128,
+          ruleDescription: 'Inline HTML',
+          ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md033.md',
+          ruleNames: [
+            'MD033',
+            'no-inline-html',
+          ],
+        },
+        {
+          errorContext: null,
+          errorDetail: 'Element: reference',
+          errorRange: [
+            16,
+            11,
+          ],
+          fixInfo: null,
+          lineNumber: 130,
+          ruleDescription: 'Inline HTML',
+          ruleInformation: 'https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/md033.md',
+          ruleNames: [
+            'MD033',
+            'no-inline-html',
+          ],
+        },
         {
           errorContext: '`code <element `',
           errorDetail: null,
@@ -20976,6 +21024,17 @@ Generated by [AVA](https://avajs.dev).
       Text \`code <element> code\` text␊
       ␊
       Text <element> text {MD033}␊
+      ␊
+      A [<link-with>][a-reference] is problematic. {MD033}␊
+      ␊
+      A [link with][a-<reference>] is okay.␊
+      ␊
+      A link with [a-<reference>][] is problematic. {MD033}␊
+      ␊
+      A link with [a-<reference>] is problematic. {MD033}␊
+      ␊
+      [a-reference]: https://example.com/␊
+      [a-<reference>]: https://example.com/␊
       `,
     }