Skip to content

Commit

Permalink
Update MD033/no-inline-html to better handle inline code spans (fixes #…
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidAnson committed May 9, 2019
1 parent f003926 commit 608f875
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 10 deletions.
5 changes: 3 additions & 2 deletions lib/md033.js
Expand Up @@ -6,8 +6,9 @@ const { addError, bareUrlRe, forEachLine, unescapeMarkdown } =
require("../helpers");
const { lineMetadata } = require("./cache");

const htmlElementRe = /<(([\w+.-]+)(?:[^>]*)?)>/g;
const htmlElementRe = /<(([\w-]+)(?:[\s/][^>]*)?)>/g;
const linkDestinationRe = /]\(\s*$/;
const inlineCodeRe = /^[^`]*(`+[^`]+`+[^`]+)*`+[^`]*$/;
// See https://spec.commonmark.org/0.29/#autolinks
const emailAddressRe =
// eslint-disable-next-line max-len
Expand All @@ -29,7 +30,7 @@ module.exports = {
!tag.endsWith("\\>") && !bareUrlRe.test(content) &&
!emailAddressRe.test(content)) {
const prefix = line.substring(0, match.index);
if (!linkDestinationRe.test(prefix) &&
if (!linkDestinationRe.test(prefix) && !inlineCodeRe.test(prefix) &&
!unescapeMarkdown(prefix + "<", "_").endsWith("_")) {
addError(onError, lineIndex + 1, "Element: " + element,
null, [ match.index + 1, tag.length ]);
Expand Down
20 changes: 17 additions & 3 deletions test/detailed-results-html-tags.md
Expand Up @@ -75,17 +75,31 @@ text <strong>inline inline</strong> text

Text

`<em>`

Text ``<em>`` text

Text `<em>` text ``<em>`` text ```<em>``` text

Text `<em>` text <em>inline</em> text

Text ``text <em> text`` text

Text

Text <a href="#anchor">inline</a> text
text <img src="src.png"/> text

Text

<name@example.com> is an email autolink.

Text

Another email autolink: <first+last@ex.exa-mple.com>.

Text

But <foo.bar.baz> is not an email autolink.
<foo-bar-baz> is an HTML element.

But <foo.bar.baz> is not an autolink or HTML element.

Text
19 changes: 14 additions & 5 deletions test/detailed-results-html-tags.results.json
Expand Up @@ -135,7 +135,16 @@
"errorRange": [ 8, 4 ]
},
{
"lineNumber": 78,
"lineNumber": 84,
"ruleNames": [ "MD033", "no-inline-html" ],
"ruleDescription": "Inline HTML",
"ruleInformation": "https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/Rules.md#md033",
"errorDetail": "Element: em",
"errorContext": null,
"errorRange": [ 18, 4 ]
},
{
"lineNumber": 90,
"ruleNames": [ "MD033", "no-inline-html" ],
"ruleDescription": "Inline HTML",
"ruleInformation": "https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/Rules.md#md033",
Expand All @@ -144,7 +153,7 @@
"errorRange": [ 6, 18 ]
},
{
"lineNumber": 79,
"lineNumber": 91,
"ruleNames": [ "MD033", "no-inline-html" ],
"ruleDescription": "Inline HTML",
"ruleInformation": "https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/Rules.md#md033",
Expand All @@ -153,12 +162,12 @@
"errorRange": [ 6, 20 ]
},
{
"lineNumber": 91,
"lineNumber": 101,
"ruleNames": [ "MD033", "no-inline-html" ],
"ruleDescription": "Inline HTML",
"ruleInformation": "https://github.com/DavidAnson/markdownlint/blob/v0.0.0/doc/Rules.md#md033",
"errorDetail": "Element: foo.bar.baz",
"errorDetail": "Element: foo-bar-baz",
"errorContext": null,
"errorRange": [ 5, 13 ]
"errorRange": [ 1, 13 ]
}
]
12 changes: 12 additions & 0 deletions test/inline_html-allowed_elements.md
Expand Up @@ -14,8 +14,20 @@

<br> {MD033}

<br > {MD033}

<br/> {MD033}

<br /> {MD033}

<br attribute/> {MD033}

<br attribute /> {MD033}

<br attribute="value"/> {MD033}

<br attribute="value" /> {MD033}

<p>
This is allowed.
</p>
Expand Down

0 comments on commit 608f875

Please sign in to comment.