markdownlint 0.20.0 → 0.20.4

package/lib/md030.js

@@ -1,50 +1,50 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorDetailIf } = require("../helpers");
-const { flattenedLists } = require("./cache");
-
-module.exports = {
-  "names": [ "MD030", "list-marker-space" ],
-  "description": "Spaces after list markers",
-  "tags": [ "ol", "ul", "whitespace" ],
-  "function": function MD030(params, onError) {
-    const ulSingle = Number(params.config.ul_single || 1);
-    const olSingle = Number(params.config.ol_single || 1);
-    const ulMulti = Number(params.config.ul_multi || 1);
-    const olMulti = Number(params.config.ol_multi || 1);
-    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((item) => {
-        const { line, lineNumber } = item;
-        const match = /^[\s>]*\S+(\s*)/.exec(line);
-        const [ { "length": matchLength }, { "length": actualSpaces } ] = match;
-        if (matchLength < line.length) {
-          let fixInfo = null;
-          if (expectedSpaces !== actualSpaces) {
-            fixInfo = {
-              "editColumn": matchLength - actualSpaces + 1,
-              "deleteCount": actualSpaces,
-              "insertText": "".padEnd(expectedSpaces)
-            };
-          }
-          addErrorDetailIf(
-            onError,
-            lineNumber,
-            expectedSpaces,
-            actualSpaces,
-            null,
-            null,
-            [ 1, matchLength ],
-            fixInfo
-          );
-        }
-      });
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorDetailIf } = require("../helpers");
+const { flattenedLists } = require("./cache");
+
+module.exports = {
+  "names": [ "MD030", "list-marker-space" ],
+  "description": "Spaces after list markers",
+  "tags": [ "ol", "ul", "whitespace" ],
+  "function": function MD030(params, onError) {
+    const ulSingle = Number(params.config.ul_single || 1);
+    const olSingle = Number(params.config.ol_single || 1);
+    const ulMulti = Number(params.config.ul_multi || 1);
+    const olMulti = Number(params.config.ol_multi || 1);
+    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((item) => {
+        const { line, lineNumber } = item;
+        const match = /^[\s>]*\S+(\s*)/.exec(line);
+        const [ { "length": matchLength }, { "length": actualSpaces } ] = match;
+        if (matchLength < line.length) {
+          let fixInfo = null;
+          if (expectedSpaces !== actualSpaces) {
+            fixInfo = {
+              "editColumn": matchLength - actualSpaces + 1,
+              "deleteCount": actualSpaces,
+              "insertText": "".padEnd(expectedSpaces)
+            };
+          }
+          addErrorDetailIf(
+            onError,
+            lineNumber,
+            expectedSpaces,
+            actualSpaces,
+            null,
+            null,
+            [ 1, matchLength ],
+            fixInfo
+          );
+        }
+      });
+    });
+  }
+};

package/lib/md031.js

@@ -1,39 +1,39 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorContext, forEachLine, isBlankLine } = require("../helpers");
-const { lineMetadata } = require("./cache");
-
-const codeFencePrefixRe = /^(.*?)\s*[`~]/;
-
-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 listItems = params.config.list_items;
-    const includeListItems = (listItems === undefined) ? true : !!listItems;
-    const { lines } = params;
-    forEachLine(lineMetadata(), (line, i, inCode, onFence, inTable, inItem) => {
-      const onTopFence = (onFence > 0);
-      const onBottomFence = (onFence < 0);
-      if ((includeListItems || !inItem) &&
-          ((onTopFence && !isBlankLine(lines[i - 1])) ||
-           (onBottomFence && !isBlankLine(lines[i + 1])))) {
-        const [ , prefix ] = line.match(codeFencePrefixRe);
-        addErrorContext(
-          onError,
-          i + 1,
-          lines[i].trim(),
-          null,
-          null,
-          null,
-          {
-            "lineNumber": i + (onTopFence ? 1 : 2),
-            "insertText": `${prefix}\n`
-          });
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorContext, forEachLine, isBlankLine } = require("../helpers");
+const { lineMetadata } = require("./cache");
+
+const codeFencePrefixRe = /^(.*?)\s*[`~]/;
+
+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 listItems = params.config.list_items;
+    const includeListItems = (listItems === undefined) ? true : !!listItems;
+    const { lines } = params;
+    forEachLine(lineMetadata(), (line, i, inCode, onFence, inTable, inItem) => {
+      const onTopFence = (onFence > 0);
+      const onBottomFence = (onFence < 0);
+      if ((includeListItems || !inItem) &&
+          ((onTopFence && !isBlankLine(lines[i - 1])) ||
+           (onBottomFence && !isBlankLine(lines[i + 1])))) {
+        const [ , prefix ] = line.match(codeFencePrefixRe);
+        addErrorContext(
+          onError,
+          i + 1,
+          lines[i].trim(),
+          null,
+          null,
+          null,
+          {
+            "lineNumber": i + (onTopFence ? 1 : 2),
+            "insertText": `${prefix}\n`
+          });
+      }
+    });
+  }
+};

package/lib/md032.js

@@ -1,50 +1,50 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorContext, isBlankLine } = require("../helpers");
-const { flattenedLists } = require("./cache");
-
-const quotePrefixRe = /^[>\s]*/;
-
-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) {
-    const { lines } = params;
-    flattenedLists().filter((list) => !list.nesting).forEach((list) => {
-      const firstIndex = list.open.map[0];
-      if (!isBlankLine(lines[firstIndex - 1])) {
-        const line = lines[firstIndex];
-        const quotePrefix = line.match(quotePrefixRe)[0].trimRight();
-        addErrorContext(
-          onError,
-          firstIndex + 1,
-          line.trim(),
-          null,
-          null,
-          null,
-          {
-            "insertText": `${quotePrefix}\n`
-          });
-      }
-      const lastIndex = list.lastLineIndex - 1;
-      if (!isBlankLine(lines[lastIndex + 1])) {
-        const line = lines[lastIndex];
-        const quotePrefix = line.match(quotePrefixRe)[0].trimRight();
-        addErrorContext(
-          onError,
-          lastIndex + 1,
-          line.trim(),
-          null,
-          null,
-          null,
-          {
-            "lineNumber": lastIndex + 2,
-            "insertText": `${quotePrefix}\n`
-          });
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorContext, isBlankLine } = require("../helpers");
+const { flattenedLists } = require("./cache");
+
+const quotePrefixRe = /^[>\s]*/;
+
+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) {
+    const { lines } = params;
+    flattenedLists().filter((list) => !list.nesting).forEach((list) => {
+      const firstIndex = list.open.map[0];
+      if (!isBlankLine(lines[firstIndex - 1])) {
+        const line = lines[firstIndex];
+        const quotePrefix = line.match(quotePrefixRe)[0].trimRight();
+        addErrorContext(
+          onError,
+          firstIndex + 1,
+          line.trim(),
+          null,
+          null,
+          null,
+          {
+            "insertText": `${quotePrefix}\n`
+          });
+      }
+      const lastIndex = list.lastLineIndex - 1;
+      if (!isBlankLine(lines[lastIndex + 1])) {
+        const line = lines[lastIndex];
+        const quotePrefix = line.match(quotePrefixRe)[0].trimRight();
+        addErrorContext(
+          onError,
+          lastIndex + 1,
+          line.trim(),
+          null,
+          null,
+          null,
+          {
+            "lineNumber": lastIndex + 2,
+            "insertText": `${quotePrefix}\n`
+          });
+      }
+    });
+  }
+};

package/lib/md033.js

@@ -1,45 +1,45 @@
-// @ts-check
-
-"use strict";
-
-const { addError, forEachLine, unescapeMarkdown } = require("../helpers");
-const { lineMetadata } = require("./cache");
-
-const htmlElementRe = /<(([A-Za-z][A-Za-z0-9-]*)(?:\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" ],
-  "description": "Inline HTML",
-  "tags": [ "html" ],
-  "function": function MD033(params, onError) {
-    let allowedElements = params.config.allowed_elements;
-    allowedElements = Array.isArray(allowedElements) ? allowedElements : [];
-    allowedElements = allowedElements.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)) !== null)) {
-        const [ tag, content, element ] = match;
-        if (!allowedElements.includes(element.toLowerCase()) &&
-          !tag.endsWith("\\>") &&
-          !emailAddressRe.test(content)) {
-          const prefix = line.substring(0, match.index);
-          if (!linkDestinationRe.test(prefix) && !inlineCodeRe.test(prefix)) {
-            const unescaped = unescapeMarkdown(prefix + "<", "_");
-            if (!unescaped.endsWith("_") &&
-              ((unescaped + "`").match(/`/g).length % 2)) {
-              addError(onError, lineIndex + 1, "Element: " + element,
-                null, [ match.index + 1, tag.length ]);
-            }
-          }
-        }
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addError, forEachLine, unescapeMarkdown } = require("../helpers");
+const { lineMetadata } = require("./cache");
+
+const htmlElementRe = /<(([A-Za-z][A-Za-z0-9-]*)(?:\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" ],
+  "description": "Inline HTML",
+  "tags": [ "html" ],
+  "function": function MD033(params, onError) {
+    let allowedElements = params.config.allowed_elements;
+    allowedElements = Array.isArray(allowedElements) ? allowedElements : [];
+    allowedElements = allowedElements.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)) !== null)) {
+        const [ tag, content, element ] = match;
+        if (!allowedElements.includes(element.toLowerCase()) &&
+          !tag.endsWith("\\>") &&
+          !emailAddressRe.test(content)) {
+          const prefix = line.substring(0, match.index);
+          if (!linkDestinationRe.test(prefix) && !inlineCodeRe.test(prefix)) {
+            const unescaped = unescapeMarkdown(prefix + "<", "_");
+            if (!unescaped.endsWith("_") &&
+              ((unescaped + "`").match(/`/g).length % 2)) {
+              addError(onError, lineIndex + 1, "Element: " + element,
+                null, [ match.index + 1, tag.length ]);
+            }
+          }
+        }
+      }
+    });
+  }
+};

package/lib/md034.js

@@ -1,61 +1,61 @@
-// @ts-check
-
-"use strict";
-
-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) {
-    filterTokens(params, "inline", (token) => {
-      let inLink = false;
-      token.children.forEach((child) => {
-        const { content, line, lineNumber, type } = child;
-        let match = null;
-        if (type === "link_open") {
-          inLink = true;
-        } else if (type === "link_close") {
-          inLink = false;
-        } else if ((type === "text") && !inLink) {
-          while ((match = bareUrlRe.exec(content)) !== null) {
-            const [ bareUrl ] = match;
-            const matchIndex = match.index;
-            const bareUrlLength = bareUrl.length;
-            // Allow "[https://example.com]" to avoid conflicts with
-            // MD011/no-reversed-links; allow quoting as another way
-            // of deliberately including a bare URL
-            const leftChar = content[matchIndex - 1];
-            const rightChar = content[matchIndex + bareUrlLength];
-            if (
-              !((leftChar === "[") && (rightChar === "]")) &&
-              !((leftChar === "\"") && (rightChar === "\"")) &&
-              !((leftChar === "'") && (rightChar === "'"))
-            ) {
-              const index = line.indexOf(content);
-              const range = (index === -1) ? null : [
-                index + matchIndex + 1,
-                bareUrlLength
-              ];
-              const fixInfo = range ? {
-                "editColumn": range[0],
-                "deleteCount": range[1],
-                "insertText": `<${bareUrl}>`
-              } : null;
-              addErrorContext(
-                onError,
-                lineNumber,
-                bareUrl,
-                null,
-                null,
-                range,
-                fixInfo
-              );
-            }
-          }
-        }
-      });
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+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) {
+    filterTokens(params, "inline", (token) => {
+      let inLink = false;
+      token.children.forEach((child) => {
+        const { content, line, lineNumber, type } = child;
+        let match = null;
+        if (type === "link_open") {
+          inLink = true;
+        } else if (type === "link_close") {
+          inLink = false;
+        } else if ((type === "text") && !inLink) {
+          while ((match = bareUrlRe.exec(content)) !== null) {
+            const [ bareUrl ] = match;
+            const matchIndex = match.index;
+            const bareUrlLength = bareUrl.length;
+            // Allow "[https://example.com]" to avoid conflicts with
+            // MD011/no-reversed-links; allow quoting as another way
+            // of deliberately including a bare URL
+            const leftChar = content[matchIndex - 1];
+            const rightChar = content[matchIndex + bareUrlLength];
+            if (
+              !((leftChar === "[") && (rightChar === "]")) &&
+              !((leftChar === "\"") && (rightChar === "\"")) &&
+              !((leftChar === "'") && (rightChar === "'"))
+            ) {
+              const index = line.indexOf(content);
+              const range = (index === -1) ? null : [
+                index + matchIndex + 1,
+                bareUrlLength
+              ];
+              const fixInfo = range ? {
+                "editColumn": range[0],
+                "deleteCount": range[1],
+                "insertText": `<${bareUrl}>`
+              } : null;
+              addErrorContext(
+                onError,
+                lineNumber,
+                bareUrl,
+                null,
+                null,
+                range,
+                fixInfo
+              );
+            }
+          }
+        }
+      });
+    });
+  }
+};

package/lib/md035.js

@@ -1,21 +1,21 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorDetailIf, filterTokens } = require("../helpers");
-
-module.exports = {
-  "names": [ "MD035", "hr-style" ],
-  "description": "Horizontal rule style",
-  "tags": [ "hr" ],
-  "function": function MD035(params, onError) {
-    let style = String(params.config.style || "consistent");
-    filterTokens(params, "hr", function forToken(token) {
-      const lineTrim = token.line.trim();
-      if (style === "consistent") {
-        style = lineTrim;
-      }
-      addErrorDetailIf(onError, token.lineNumber, style, lineTrim);
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorDetailIf, filterTokens } = require("../helpers");
+
+module.exports = {
+  "names": [ "MD035", "hr-style" ],
+  "description": "Horizontal rule style",
+  "tags": [ "hr" ],
+  "function": function MD035(params, onError) {
+    let style = String(params.config.style || "consistent");
+    filterTokens(params, "hr", function forToken(token) {
+      const lineTrim = token.line.trim();
+      if (style === "consistent") {
+        style = lineTrim;
+      }
+      addErrorDetailIf(onError, token.lineNumber, style, lineTrim);
+    });
+  }
+};

package/lib/md036.js

@@ -1,56 +1,56 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorContext, allPunctuation } = require("../helpers");
-
-module.exports = {
-  "names": [ "MD036", "no-emphasis-as-heading", "no-emphasis-as-header" ],
-  "description": "Emphasis used instead of a heading",
-  "tags": [ "headings", "headers", "emphasis" ],
-  "function": function MD036(params, onError) {
-    let punctuation = params.config.punctuation;
-    punctuation =
-      String((punctuation === undefined) ? allPunctuation : punctuation);
-    const re = new RegExp("[" + punctuation + "]$");
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    function base(token) {
-      if (token.type === "paragraph_open") {
-        return function inParagraph(t) {
-          // Always paragraph_open/inline/paragraph_close,
-          const children = t.children.filter(function notEmptyText(child) {
-            return (child.type !== "text") || (child.content !== "");
-          });
-          if ((children.length === 3) &&
-              ((children[0].type === "strong_open") ||
-                (children[0].type === "em_open")) &&
-              (children[1].type === "text") &&
-              !re.test(children[1].content)) {
-            addErrorContext(onError, t.lineNumber,
-              children[1].content);
-          }
-          return base;
-        };
-      } else if (token.type === "blockquote_open") {
-        return function inBlockquote(t) {
-          if (t.type !== "blockquote_close") {
-            return inBlockquote;
-          }
-          return base;
-        };
-      } else if (token.type === "list_item_open") {
-        return function inListItem(t) {
-          if (t.type !== "list_item_close") {
-            return inListItem;
-          }
-          return base;
-        };
-      }
-      return base;
-    }
-    let state = base;
-    params.tokens.forEach(function forToken(token) {
-      state = state(token);
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorContext, allPunctuation } = require("../helpers");
+
+module.exports = {
+  "names": [ "MD036", "no-emphasis-as-heading", "no-emphasis-as-header" ],
+  "description": "Emphasis used instead of a heading",
+  "tags": [ "headings", "headers", "emphasis" ],
+  "function": function MD036(params, onError) {
+    let punctuation = params.config.punctuation;
+    punctuation =
+      String((punctuation === undefined) ? allPunctuation : punctuation);
+    const re = new RegExp("[" + punctuation + "]$");
+    // eslint-disable-next-line jsdoc/require-jsdoc
+    function base(token) {
+      if (token.type === "paragraph_open") {
+        return function inParagraph(t) {
+          // Always paragraph_open/inline/paragraph_close,
+          const children = t.children.filter(function notEmptyText(child) {
+            return (child.type !== "text") || (child.content !== "");
+          });
+          if ((children.length === 3) &&
+              ((children[0].type === "strong_open") ||
+                (children[0].type === "em_open")) &&
+              (children[1].type === "text") &&
+              !re.test(children[1].content)) {
+            addErrorContext(onError, t.lineNumber,
+              children[1].content);
+          }
+          return base;
+        };
+      } else if (token.type === "blockquote_open") {
+        return function inBlockquote(t) {
+          if (t.type !== "blockquote_close") {
+            return inBlockquote;
+          }
+          return base;
+        };
+      } else if (token.type === "list_item_open") {
+        return function inListItem(t) {
+          if (t.type !== "list_item_close") {
+            return inListItem;
+          }
+          return base;
+        };
+      }
+      return base;
+    }
+    let state = base;
+    params.tokens.forEach(function forToken(token) {
+      state = state(token);
+    });
+  }
+};