markdownlint 0.12.0 → 0.14.2

package/lib/md023.js

@@ -2,7 +2,8 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addErrorContext, filterTokens, rangeFromRegExp } =
+  require("../helpers");
 
 const spaceBeforeHeadingRe = /^((?:\s+)|(?:[>\s]+\s\s))[^>\s]/;
 
@@ -11,10 +12,10 @@ module.exports = {
   "description": "Headings must start at the beginning of the line",
   "tags": [ "headings", "headers", "spaces" ],
   "function": function MD023(params, onError) {
-    shared.filterTokens(params, "heading_open", function forToken(token) {
+    filterTokens(params, "heading_open", function forToken(token) {
       if (spaceBeforeHeadingRe.test(token.line)) {
-        shared.addErrorContext(onError, token.lineNumber, token.line, null,
-          null, shared.rangeFromRegExp(token.line, spaceBeforeHeadingRe));
+        addErrorContext(onError, token.lineNumber, token.line, null,
+          null, rangeFromRegExp(token.line, spaceBeforeHeadingRe));
       }
     });
   }

package/lib/md024.js

@@ -2,7 +2,7 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addErrorContext, forEachHeading } = require("../helpers");
 
 module.exports = {
   "names": [ "MD024", "no-duplicate-heading", "no-duplicate-header" ],
@@ -14,7 +14,7 @@ module.exports = {
     const knownContents = [ null, [] ];
     let lastLevel = 1;
     let knownContent = knownContents[lastLevel];
-    shared.forEachHeading(params, function forHeading(heading, content) {
+    forEachHeading(params, (heading, content) => {
       if (siblingsOnly) {
         const newLevel = heading.tag.slice(1);
         while (lastLevel < newLevel) {
@@ -27,11 +27,11 @@ module.exports = {
         }
         knownContent = knownContents[newLevel];
       }
-      if (knownContent.indexOf(content) === -1) {
-        knownContent.push(content);
-      } else {
-        shared.addErrorContext(onError, heading.lineNumber,
+      if (knownContent.includes(content)) {
+        addErrorContext(onError, heading.lineNumber,
           heading.line.trim());
+      } else {
+        knownContent.push(content);
       }
     });
   }

package/lib/md025.js

@@ -2,20 +2,26 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addErrorContext, filterTokens, frontMatterHasTitle } =
+  require("../helpers");
 
 module.exports = {
-  "names": [ "MD025", "single-h1" ],
+  "names": [ "MD025", "single-title", "single-h1" ],
   "description": "Multiple top level headings in the same document",
   "tags": [ "headings", "headers" ],
   "function": function MD025(params, onError) {
     const level = params.config.level || 1;
     const tag = "h" + level;
+    const foundFrontMatterTitle =
+      frontMatterHasTitle(
+        params.frontMatterLines,
+        params.config.front_matter_title
+      );
     let hasTopLevelHeading = false;
-    shared.filterTokens(params, "heading_open", function forToken(token) {
+    filterTokens(params, "heading_open", function forToken(token) {
       if (token.tag === tag) {
-        if (hasTopLevelHeading) {
-          shared.addErrorContext(onError, token.lineNumber,
+        if (hasTopLevelHeading || foundFrontMatterTitle) {
+          addErrorContext(onError, token.lineNumber,
             token.line.trim());
         } else if (token.lineNumber === 1) {
           hasTopLevelHeading = true;

package/lib/md026.js

@@ -2,7 +2,7 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addError, forEachHeading, rangeFromRegExp } = require("../helpers");
 
 module.exports = {
   "names": [ "MD026", "no-trailing-punctuation" ],
@@ -11,12 +11,12 @@ module.exports = {
   "function": function MD026(params, onError) {
     const punctuation = params.config.punctuation || ".,;:!?";
     const trailingPunctuationRe = new RegExp("[" + punctuation + "]$");
-    shared.forEachHeading(params, function forHeading(heading, content) {
+    forEachHeading(params, function forHeading(heading, content) {
       const match = trailingPunctuationRe.exec(content);
       if (match) {
-        shared.addError(onError, heading.lineNumber,
+        addError(onError, heading.lineNumber,
           "Punctuation: '" + match[0] + "'", null,
-          shared.rangeFromRegExp(heading.line, trailingPunctuationRe));
+          rangeFromRegExp(heading.line, trailingPunctuationRe));
       }
     });
   }

package/lib/md027.js

@@ -2,7 +2,7 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addErrorContext, newLineRe, rangeFromRegExp } = require("../helpers");
 
 const spaceAfterBlockQuote = /^\s*(?:>\s+)+\S/;
 
@@ -27,15 +27,15 @@ module.exports = {
           /^(\s*>)+\s\s+>/.test(token.line) :
           /^(\s*>)+\s\s/.test(token.line);
         if (multipleSpaces) {
-          shared.addErrorContext(onError, token.lineNumber, token.line, null,
-            null, shared.rangeFromRegExp(token.line, spaceAfterBlockQuote));
+          addErrorContext(onError, token.lineNumber, token.line, null,
+            null, rangeFromRegExp(token.line, spaceAfterBlockQuote));
         }
-        token.content.split(shared.newLineRe)
+        token.content.split(newLineRe)
           .forEach(function forLine(line, offset) {
             if (/^\s/.test(line)) {
-              shared.addErrorContext(onError, token.lineNumber + offset,
+              addErrorContext(onError, token.lineNumber + offset,
                 "> " + line, null, null,
-                shared.rangeFromRegExp(line, spaceAfterBlockQuote));
+                rangeFromRegExp(line, spaceAfterBlockQuote));
             }
           });
       }

package/lib/md028.js

@@ -2,7 +2,7 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addError } = require("../helpers");
 
 module.exports = {
   "names": [ "MD028", "no-blanks-blockquote" ],
@@ -13,7 +13,7 @@ module.exports = {
     params.tokens.forEach(function forToken(token) {
       if ((token.type === "blockquote_open") &&
           (prevToken.type === "blockquote_close")) {
-        shared.addError(onError, token.lineNumber - 1);
+        addError(onError, token.lineNumber - 1);
       }
       prevToken = token;
     });

package/lib/md029.js

@@ -2,7 +2,15 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addErrorDetailIf, listItemMarkerRe, orderedListItemMarkerRe,
+  rangeFromRegExp } = require("../helpers");
+const { flattenedLists } = require("./cache");
+
+const listStyleExamples = {
+  "one": "1/1/1",
+  "ordered": "1/2/3",
+  "zero": "0/0/0"
+};
 
 module.exports = {
   "names": [ "MD029", "ol-prefix" ],
@@ -10,21 +18,21 @@ module.exports = {
   "tags": [ "ol" ],
   "function": function MD029(params, onError) {
     const style = params.config.style || "one_or_ordered";
-    shared.flattenLists().forEach(function forList(list) {
+    flattenedLists().forEach((list) => {
       if (!list.unordered) {
         let listStyle = style;
         if (listStyle === "one_or_ordered") {
           const second = (list.items.length > 1) &&
-            shared.orderedListItemMarkerRe.exec(list.items[1].line);
+            orderedListItemMarkerRe.exec(list.items[1].line);
           listStyle = (second && (second[1] !== "1")) ? "ordered" : "one";
         }
-        let number = 1;
-        list.items.forEach(function forItem(item) {
-          const match = shared.orderedListItemMarkerRe.exec(item.line);
-          shared.addErrorDetailIf(onError, item.lineNumber,
+        let number = (listStyle === "zero") ? 0 : 1;
+        list.items.forEach((item) => {
+          const match = orderedListItemMarkerRe.exec(item.line);
+          addErrorDetailIf(onError, item.lineNumber,
             String(number), !match || match[1],
-            "Style: " + (listStyle === "one" ? "1/1/1" : "1/2/3"),
-            shared.rangeFromRegExp(item.line, shared.listItemMarkerRe));
+            "Style: " + listStyleExamples[listStyle], null,
+            rangeFromRegExp(item.line, listItemMarkerRe));
           if (listStyle === "ordered") {
             number++;
           }

package/lib/md030.js

@@ -2,7 +2,9 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addErrorDetailIf, listItemMarkerRe, rangeFromRegExp } =
+  require("../helpers");
+const { flattenedLists } = require("./cache");
 
 module.exports = {
   "names": [ "MD030", "list-marker-space" ],
@@ -13,17 +15,17 @@ module.exports = {
     const olSingle = params.config.ol_single || 1;
     const ulMulti = params.config.ul_multi || 1;
     const olMulti = params.config.ol_multi || 1;
-    shared.flattenLists().forEach(function forList(list) {
+    flattenedLists().forEach((list) => {
       const lineCount = list.lastLineIndex - list.open.map[0];
       const allSingle = lineCount === list.items.length;
       const expectedSpaces = list.unordered ?
         (allSingle ? ulSingle : ulMulti) :
         (allSingle ? olSingle : olMulti);
-      list.items.forEach(function forItem(item) {
+      list.items.forEach((item) => {
         const match = /^[\s>]*\S+(\s+)/.exec(item.line);
-        shared.addErrorDetailIf(onError, item.lineNumber,
-          expectedSpaces, (match ? match[1].length : 0), null,
-          shared.rangeFromRegExp(item.line, shared.listItemMarkerRe));
+        addErrorDetailIf(onError, item.lineNumber,
+          expectedSpaces, (match ? match[1].length : 0), null, null,
+          rangeFromRegExp(item.line, listItemMarkerRe));
       });
     });
   }

package/lib/md031.js

@@ -2,18 +2,19 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addErrorContext, forEachLine, isBlankLine } = require("../helpers");
+const { lineMetadata } = require("./cache");
 
 module.exports = {
   "names": [ "MD031", "blanks-around-fences" ],
   "description": "Fenced code blocks should be surrounded by blank lines",
   "tags": [ "code", "blank_lines" ],
   "function": function MD031(params, onError) {
-    const lines = params.lines;
-    shared.forEachLine(function forLine(line, i, inCode, onFence) {
-      if (((onFence > 0) && (i - 1 >= 0) && lines[i - 1].length) ||
-          ((onFence < 0) && (i + 1 < lines.length) && lines[i + 1].length)) {
-        shared.addErrorContext(onError, i + 1, lines[i].trim());
+    const { lines } = params;
+    forEachLine(lineMetadata(), (line, i, inCode, onFence) => {
+      if (((onFence > 0) && !isBlankLine(lines[i - 1])) ||
+          ((onFence < 0) && !isBlankLine(lines[i + 1]))) {
+        addErrorContext(onError, i + 1, lines[i].trim());
       }
     });
   }

package/lib/md032.js

@@ -2,25 +2,23 @@
 
 "use strict";
 
-const shared = require("./shared");
-
-const blankLineRe = /^[\s>]*$/;
+const { addErrorContext, isBlankLine } = require("../helpers");
+const { flattenedLists } = require("./cache");
 
 module.exports = {
   "names": [ "MD032", "blanks-around-lists" ],
   "description": "Lists should be surrounded by blank lines",
   "tags": [ "bullet", "ul", "ol", "blank_lines" ],
   "function": function MD032(params, onError) {
-    shared.flattenLists().filter((list) => !list.nesting).forEach((list) => {
-      const firstLineIndex = list.open.map[0];
-      if (!blankLineRe.test(params.lines[firstLineIndex - 1] || "")) {
-        shared.addErrorContext(
-          onError, firstLineIndex + 1, params.lines[firstLineIndex].trim());
+    const { lines } = params;
+    flattenedLists().filter((list) => !list.nesting).forEach((list) => {
+      const firstIndex = list.open.map[0];
+      if (!isBlankLine(lines[firstIndex - 1])) {
+        addErrorContext(onError, firstIndex + 1, lines[firstIndex].trim());
       }
-      const bottomLineIndex = list.lastLineIndex - 1;
-      if (!blankLineRe.test(params.lines[bottomLineIndex + 1] || "")) {
-        shared.addErrorContext(
-          onError, bottomLineIndex + 1, params.lines[bottomLineIndex].trim());
+      const lastIndex = list.lastLineIndex - 1;
+      if (!isBlankLine(lines[lastIndex + 1])) {
+        addErrorContext(onError, lastIndex + 1, lines[lastIndex].trim());
       }
     });
   }

package/lib/md033.js

@@ -2,9 +2,17 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addError, bareUrlRe, forEachLine, unescapeMarkdown } =
+  require("../helpers");
+const { lineMetadata } = require("./cache");
 
-const htmlRe = /<[^>]*>/;
+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
+  /^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/;
 
 module.exports = {
   "names": [ "MD033", "no-inline-html" ],
@@ -12,30 +20,23 @@ module.exports = {
   "tags": [ "html" ],
   "function": function MD033(params, onError) {
     const allowedElements = (params.config.allowed_elements || [])
-      .map(function forElement(element) {
-        return element.toLowerCase();
-      });
-    function forToken(token) {
-      token.content.split(shared.newLineRe)
-        .forEach(function forLine(line, offset) {
-          const allowed = (line.match(/<[^/\s>!]*/g) || [])
-            .filter(function forElement(element) {
-              return element.length > 1;
-            })
-            .map(function forElement(element) {
-              return element.slice(1).toLowerCase();
-            })
-            .filter(function forElement(element) {
-              return allowedElements.indexOf(element) === -1;
-            });
-          if (allowed.length) {
-            shared.addError(onError, token.lineNumber + offset,
-              "Element: " + allowed[0], null,
-              shared.rangeFromRegExp(token.line, htmlRe));
+      .map((element) => element.toLowerCase());
+    forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
+      let match = null;
+      // eslint-disable-next-line no-unmodified-loop-condition
+      while (!inCode && (match = htmlElementRe.exec(line))) {
+        const [ tag, content, element ] = match;
+        if (!allowedElements.includes(element.toLowerCase()) &&
+          !tag.endsWith("\\>") && !bareUrlRe.test(content) &&
+          !emailAddressRe.test(content)) {
+          const prefix = line.substring(0, match.index);
+          if (!linkDestinationRe.test(prefix) && !inlineCodeRe.test(prefix) &&
+            !unescapeMarkdown(prefix + "<", "_").endsWith("_")) {
+            addError(onError, lineIndex + 1, "Element: " + element,
+              null, [ match.index + 1, tag.length ]);
           }
-        });
-    }
-    shared.filterTokens(params, "html_block", forToken);
-    shared.forEachInlineChild(params, "html_inline", forToken);
+        }
+      }
+    });
   }
 };

package/lib/md034.js

@@ -2,26 +2,31 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addErrorContext, bareUrlRe, filterTokens } = require("../helpers");
 
 module.exports = {
   "names": [ "MD034", "no-bare-urls" ],
   "description": "Bare URL used",
   "tags": [ "links", "url" ],
   "function": function MD034(params, onError) {
-    shared.filterTokens(params, "inline", function forToken(token) {
+    filterTokens(params, "inline", (token) => {
       let inLink = false;
-      token.children.forEach(function forChild(child) {
+      token.children.forEach((child) => {
+        const { content, line, lineNumber, type } = child;
         let match = null;
-        if (child.type === "link_open") {
+        if (type === "link_open") {
           inLink = true;
-        } else if (child.type === "link_close") {
+        } else if (type === "link_close") {
           inLink = false;
-        } else if ((child.type === "text") &&
-                    !inLink &&
-                    (match = shared.bareUrlRe.exec(child.content))) {
-          shared.addErrorContext(onError, child.lineNumber, match[0], null,
-            null, shared.rangeFromRegExp(child.line, shared.bareUrlRe));
+        } else if ((type === "text") && !inLink &&
+            (match = bareUrlRe.exec(content))) {
+          const [ bareUrl ] = match;
+          const index = line.indexOf(content);
+          const range = (index === -1) ? null : [
+            line.indexOf(content) + match.index + 1,
+            bareUrl.length
+          ];
+          addErrorContext(onError, lineNumber, bareUrl, null, null, range);
         }
       });
     });

package/lib/md035.js

@@ -2,7 +2,7 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addErrorDetailIf, filterTokens } = require("../helpers");
 
 module.exports = {
   "names": [ "MD035", "hr-style" ],
@@ -10,12 +10,12 @@ module.exports = {
   "tags": [ "hr" ],
   "function": function MD035(params, onError) {
     let style = params.config.style || "consistent";
-    shared.filterTokens(params, "hr", function forToken(token) {
+    filterTokens(params, "hr", function forToken(token) {
       const lineTrim = token.line.trim();
       if (style === "consistent") {
         style = lineTrim;
       }
-      shared.addErrorDetailIf(onError, token.lineNumber, style, lineTrim);
+      addErrorDetailIf(onError, token.lineNumber, style, lineTrim);
     });
   }
 };

package/lib/md036.js

@@ -2,7 +2,7 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addErrorContext } = require("../helpers");
 
 module.exports = {
   "names": [ "MD036", "no-emphasis-as-heading", "no-emphasis-as-header" ],
@@ -24,7 +24,7 @@ module.exports = {
                 (children[0].type === "em_open")) &&
               (children[1].type === "text") &&
               !re.test(children[1].content)) {
-            shared.addErrorContext(onError, t.lineNumber,
+            addErrorContext(onError, t.lineNumber,
               children[1].content);
           }
           return base;

package/lib/md037.js

@@ -2,27 +2,30 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addErrorContext, forEachInlineChild } = require("../helpers");
 
 module.exports = {
   "names": [ "MD037", "no-space-in-emphasis" ],
   "description": "Spaces inside emphasis markers",
   "tags": [ "whitespace", "emphasis" ],
   "function": function MD037(params, onError) {
-    shared.forEachInlineChild(params, "text", function forToken(token) {
+    forEachInlineChild(params, "text", (token) => {
       let left = true;
-      let match = /\s(\*\*?|__?)\s.+\1/.exec(token.content);
+      let match = /(?:^|\s)(\*\*?|__?)\s.*[^\\]\1/.exec(token.content);
       if (!match) {
         left = false;
-        match = /(\*\*?|__?).+\s\1\s/.exec(token.content);
+        match = /(?:^|[^\\])(\*\*?|__?).+\s\1(?:\s|$)/.exec(token.content);
       }
       if (match) {
-        const text = match[0].trim();
+        const fullText = match[0];
         const line = params.lines[token.lineNumber - 1];
-        const column = line.indexOf(text) + 1;
-        const length = text.length;
-        shared.addErrorContext(onError, token.lineNumber,
-          text, left, !left, [ column, length ]);
+        if (line.includes(fullText)) {
+          const text = fullText.trim();
+          const column = line.indexOf(text) + 1;
+          const length = text.length;
+          addErrorContext(onError, token.lineNumber,
+            text, left, !left, [ column, length ]);
+        }
       }
     });
   }

package/lib/md038.js

@@ -2,7 +2,8 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addErrorContext, filterTokens, forEachInlineCodeSpan, newLineRe } =
+  require("../helpers");
 
 const startRe = /^\s([^`]|$)/;
 const endRe = /[^`]\s$/;
@@ -12,16 +13,16 @@ module.exports = {
   "description": "Spaces inside code span elements",
   "tags": [ "whitespace", "code" ],
   "function": function MD038(params, onError) {
-    shared.filterTokens(params, "inline", (token) => {
+    filterTokens(params, "inline", (token) => {
       if (token.children.some((child) => child.type === "code_inline")) {
         const tokenLines = params.lines.slice(token.map[0], token.map[1]);
-        shared.forEachInlineCodeSpan(
+        forEachInlineCodeSpan(
           tokenLines.join("\n"),
           (code, lineIndex, columnIndex, tickCount) => {
             let rangeIndex = columnIndex - tickCount;
             let rangeLength = code.length + (2 * tickCount);
             let rangeLineOffset = 0;
-            const codeLines = code.split(shared.newLineRe);
+            const codeLines = code.split(newLineRe);
             const left = startRe.test(code);
             const right = !left && endRe.test(code);
             if (right && (codeLines.length > 1)) {
@@ -34,7 +35,7 @@ module.exports = {
               }
               const context = tokenLines[lineIndex + rangeLineOffset]
                 .substring(rangeIndex, rangeIndex + rangeLength);
-              shared.addErrorContext(
+              addErrorContext(
                 onError, token.lineNumber + lineIndex + rangeLineOffset,
                 context, left, right, [ rangeIndex + 1, rangeLength ]);
             }

package/lib/md039.js

@@ -2,7 +2,8 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addErrorContext, filterTokens, rangeFromRegExp } =
+  require("../helpers");
 
 const spaceInLinkRe = /\[(?:\s+(?:[^\]]*?)\s*|(?:[^\]]*?)\s+)](?=\(\S*\))/;
 
@@ -11,7 +12,7 @@ module.exports = {
   "description": "Spaces inside link text",
   "tags": [ "whitespace", "links" ],
   "function": function MD039(params, onError) {
-    shared.filterTokens(params, "inline", function forToken(token) {
+    filterTokens(params, "inline", function forToken(token) {
       let inLink = false;
       let linkText = "";
       token.children.forEach(function forChild(child) {
@@ -20,12 +21,12 @@ module.exports = {
           linkText = "";
         } else if (child.type === "link_close") {
           inLink = false;
-          const left = shared.trimLeft(linkText).length !== linkText.length;
-          const right = shared.trimRight(linkText).length !== linkText.length;
+          const left = linkText.trimLeft().length !== linkText.length;
+          const right = linkText.trimRight().length !== linkText.length;
           if (left || right) {
-            shared.addErrorContext(onError, token.lineNumber,
+            addErrorContext(onError, token.lineNumber,
               "[" + linkText + "]", left, right,
-              shared.rangeFromRegExp(token.line, spaceInLinkRe));
+              rangeFromRegExp(token.line, spaceInLinkRe));
           }
         } else if (inLink) {
           linkText += child.content;

package/lib/md040.js

@@ -2,16 +2,16 @@
 
 "use strict";
 
-const shared = require("./shared");
+const { addErrorContext, filterTokens } = require("../helpers");
 
 module.exports = {
   "names": [ "MD040", "fenced-code-language" ],
   "description": "Fenced code blocks should have a language specified",
   "tags": [ "code", "language" ],
   "function": function MD040(params, onError) {
-    shared.filterTokens(params, "fence", function forToken(token) {
+    filterTokens(params, "fence", function forToken(token) {
       if (!token.info.trim()) {
-        shared.addErrorContext(onError, token.lineNumber, token.line);
+        addErrorContext(onError, token.lineNumber, token.line);
       }
     });
   }