markdownlint 0.20.2 → 0.21.1

package/lib/md009.js

@@ -1,77 +1,77 @@
-// @ts-check
-
-"use strict";
-
-const { addError, filterTokens, forEachInlineCodeSpan, forEachLine,
-  includesSorted, newLineRe, numericSortAscending } = require("../helpers");
-const { lineMetadata } = require("./cache");
-
-module.exports = {
-  "names": [ "MD009", "no-trailing-spaces" ],
-  "description": "Trailing spaces",
-  "tags": [ "whitespace" ],
-  "function": function MD009(params, onError) {
-    let brSpaces = params.config.br_spaces;
-    brSpaces = Number((brSpaces === undefined) ? 2 : brSpaces);
-    const listItemEmptyLines = !!params.config.list_item_empty_lines;
-    const strict = !!params.config.strict;
-    const listItemLineNumbers = [];
-    if (listItemEmptyLines) {
-      filterTokens(params, "list_item_open", (token) => {
-        for (let i = token.map[0]; i < token.map[1]; i++) {
-          listItemLineNumbers.push(i + 1);
-        }
-      });
-      listItemLineNumbers.sort(numericSortAscending);
-    }
-    const paragraphLineNumbers = [];
-    const codeInlineLineNumbers = [];
-    if (strict) {
-      filterTokens(params, "paragraph_open", (token) => {
-        for (let i = token.map[0]; i < token.map[1] - 1; i++) {
-          paragraphLineNumbers.push(i + 1);
-        }
-      });
-      paragraphLineNumbers.sort(numericSortAscending);
-      filterTokens(params, "inline", (token) => {
-        if (token.children.some((child) => child.type === "code_inline")) {
-          const tokenLines = params.lines.slice(token.map[0], token.map[1]);
-          forEachInlineCodeSpan(tokenLines.join("\n"), (code, lineIndex) => {
-            const codeLineCount = code.split(newLineRe).length;
-            for (let i = 0; i < codeLineCount; i++) {
-              codeInlineLineNumbers.push(token.lineNumber + lineIndex + i);
-            }
-          });
-        }
-      });
-      codeInlineLineNumbers.sort(numericSortAscending);
-    }
-    const expected = (brSpaces < 2) ? 0 : brSpaces;
-    let inFencedCode = 0;
-    forEachLine(lineMetadata(), (line, lineIndex, inCode, onFence) => {
-      inFencedCode += onFence;
-      const lineNumber = lineIndex + 1;
-      const trailingSpaces = line.length - line.trimRight().length;
-      if ((!inCode || inFencedCode) && trailingSpaces &&
-        !includesSorted(listItemLineNumbers, lineNumber)) {
-        if ((expected !== trailingSpaces) ||
-            (strict &&
-             (!includesSorted(paragraphLineNumbers, lineNumber) ||
-              includesSorted(codeInlineLineNumbers, lineNumber)))) {
-          const column = line.length - trailingSpaces + 1;
-          addError(
-            onError,
-            lineNumber,
-            "Expected: " + (expected === 0 ? "" : "0 or ") +
-              expected + "; Actual: " + trailingSpaces,
-            null,
-            [ column, trailingSpaces ],
-            {
-              "editColumn": column,
-              "deleteCount": trailingSpaces
-            });
-        }
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addError, filterTokens, forEachInlineCodeSpan, forEachLine,
+  includesSorted, newLineRe, numericSortAscending } = require("../helpers");
+const { lineMetadata } = require("./cache");
+
+module.exports = {
+  "names": [ "MD009", "no-trailing-spaces" ],
+  "description": "Trailing spaces",
+  "tags": [ "whitespace" ],
+  "function": function MD009(params, onError) {
+    let brSpaces = params.config.br_spaces;
+    brSpaces = Number((brSpaces === undefined) ? 2 : brSpaces);
+    const listItemEmptyLines = !!params.config.list_item_empty_lines;
+    const strict = !!params.config.strict;
+    const listItemLineNumbers = [];
+    if (listItemEmptyLines) {
+      filterTokens(params, "list_item_open", (token) => {
+        for (let i = token.map[0]; i < token.map[1]; i++) {
+          listItemLineNumbers.push(i + 1);
+        }
+      });
+      listItemLineNumbers.sort(numericSortAscending);
+    }
+    const paragraphLineNumbers = [];
+    const codeInlineLineNumbers = [];
+    if (strict) {
+      filterTokens(params, "paragraph_open", (token) => {
+        for (let i = token.map[0]; i < token.map[1] - 1; i++) {
+          paragraphLineNumbers.push(i + 1);
+        }
+      });
+      paragraphLineNumbers.sort(numericSortAscending);
+      filterTokens(params, "inline", (token) => {
+        if (token.children.some((child) => child.type === "code_inline")) {
+          const tokenLines = params.lines.slice(token.map[0], token.map[1]);
+          forEachInlineCodeSpan(tokenLines.join("\n"), (code, lineIndex) => {
+            const codeLineCount = code.split(newLineRe).length;
+            for (let i = 0; i < codeLineCount; i++) {
+              codeInlineLineNumbers.push(token.lineNumber + lineIndex + i);
+            }
+          });
+        }
+      });
+      codeInlineLineNumbers.sort(numericSortAscending);
+    }
+    const expected = (brSpaces < 2) ? 0 : brSpaces;
+    let inFencedCode = 0;
+    forEachLine(lineMetadata(), (line, lineIndex, inCode, onFence) => {
+      inFencedCode += onFence;
+      const lineNumber = lineIndex + 1;
+      const trailingSpaces = line.length - line.trimRight().length;
+      if ((!inCode || inFencedCode) && trailingSpaces &&
+        !includesSorted(listItemLineNumbers, lineNumber)) {
+        if ((expected !== trailingSpaces) ||
+            (strict &&
+             (!includesSorted(paragraphLineNumbers, lineNumber) ||
+              includesSorted(codeInlineLineNumbers, lineNumber)))) {
+          const column = line.length - trailingSpaces + 1;
+          addError(
+            onError,
+            lineNumber,
+            "Expected: " + (expected === 0 ? "" : "0 or ") +
+              expected + "; Actual: " + trailingSpaces,
+            null,
+            [ column, trailingSpaces ],
+            {
+              "editColumn": column,
+              "deleteCount": trailingSpaces
+            });
+        }
+      }
+    });
+  }
+};

package/lib/md010.js

@@ -1,38 +1,38 @@
-// @ts-check
-
-"use strict";
-
-const { addError, forEachLine } = require("../helpers");
-const { lineMetadata } = require("./cache");
-
-const tabRe = /\t+/g;
-
-module.exports = {
-  "names": [ "MD010", "no-hard-tabs" ],
-  "description": "Hard tabs",
-  "tags": [ "whitespace", "hard_tab" ],
-  "function": function MD010(params, onError) {
-    const codeBlocks = params.config.code_blocks;
-    const includeCodeBlocks = (codeBlocks === undefined) ? true : !!codeBlocks;
-    forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
-      if (!inCode || includeCodeBlocks) {
-        let match = null;
-        while ((match = tabRe.exec(line)) !== null) {
-          const column = match.index + 1;
-          const length = match[0].length;
-          addError(
-            onError,
-            lineIndex + 1,
-            "Column: " + column,
-            null,
-            [ column, length ],
-            {
-              "editColumn": column,
-              "deleteCount": length,
-              "insertText": "".padEnd(length)
-            });
-        }
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addError, forEachLine } = require("../helpers");
+const { lineMetadata } = require("./cache");
+
+const tabRe = /\t+/g;
+
+module.exports = {
+  "names": [ "MD010", "no-hard-tabs" ],
+  "description": "Hard tabs",
+  "tags": [ "whitespace", "hard_tab" ],
+  "function": function MD010(params, onError) {
+    const codeBlocks = params.config.code_blocks;
+    const includeCodeBlocks = (codeBlocks === undefined) ? true : !!codeBlocks;
+    forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
+      if (!inCode || includeCodeBlocks) {
+        let match = null;
+        while ((match = tabRe.exec(line)) !== null) {
+          const column = match.index + 1;
+          const length = match[0].length;
+          addError(
+            onError,
+            lineIndex + 1,
+            "Column: " + column,
+            null,
+            [ column, length ],
+            {
+              "editColumn": column,
+              "deleteCount": length,
+              "insertText": "".padEnd(length)
+            });
+        }
+      }
+    });
+  }
+};

package/lib/md011.js

@@ -1,38 +1,42 @@
-// @ts-check
-
-"use strict";
-
-const { addError, forEachInlineChild, unescapeMarkdown } =
-  require("../helpers");
-
-const reversedLinkRe = /\(([^)]+)\)\[([^\]^][^\]]*)]/g;
-
-module.exports = {
-  "names": [ "MD011", "no-reversed-links" ],
-  "description": "Reversed link syntax",
-  "tags": [ "links" ],
-  "function": function MD011(params, onError) {
-    forEachInlineChild(params, "text", (token) => {
-      const { lineNumber, content } = token;
-      let match = null;
-      while ((match = reversedLinkRe.exec(content)) !== null) {
-        const [ reversedLink, linkText, linkDestination ] = match;
-        const line = params.lines[lineNumber - 1];
-        const column = unescapeMarkdown(line).indexOf(reversedLink) + 1;
-        const length = reversedLink.length;
-        addError(
-          onError,
-          lineNumber,
-          reversedLink,
-          null,
-          [ column, length ],
-          {
-            "editColumn": column,
-            "deleteCount": length,
-            "insertText": `[${linkText}](${linkDestination})`
-          }
-        );
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addError, forEachInlineChild, unescapeMarkdown } =
+  require("../helpers");
+
+const reversedLinkRe = /\(([^)]+)\)\[([^\]^][^\]]*)]/g;
+
+module.exports = {
+  "names": [ "MD011", "no-reversed-links" ],
+  "description": "Reversed link syntax",
+  "tags": [ "links" ],
+  "function": function MD011(params, onError) {
+    forEachInlineChild(params, "text", (token) => {
+      const { lineNumber, content } = token;
+      let match = null;
+      while ((match = reversedLinkRe.exec(content)) !== null) {
+        const [ reversedLink, linkText, linkDestination ] = match;
+        const line = params.lines[lineNumber - 1];
+        const column = unescapeMarkdown(line).indexOf(reversedLink) + 1;
+        const length = reversedLink.length;
+        const range = column ? [ column, length ] : null;
+        const fixInfo = column ?
+          {
+            "editColumn": column,
+            "deleteCount": length,
+            "insertText": `[${linkText}](${linkDestination})`
+          } :
+          null;
+        addError(
+          onError,
+          lineNumber,
+          reversedLink,
+          null,
+          range,
+          fixInfo
+        );
+      }
+    });
+  }
+};

package/lib/md012.js

@@ -1,32 +1,32 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorDetailIf, forEachLine } = require("../helpers");
-const { lineMetadata } = require("./cache");
-
-module.exports = {
-  "names": [ "MD012", "no-multiple-blanks" ],
-  "description": "Multiple consecutive blank lines",
-  "tags": [ "whitespace", "blank_lines" ],
-  "function": function MD012(params, onError) {
-    const maximum = Number(params.config.maximum || 1);
-    let count = 0;
-    forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
-      count = (inCode || line.trim().length) ? 0 : count + 1;
-      if (maximum < count) {
-        addErrorDetailIf(
-          onError,
-          lineIndex + 1,
-          maximum,
-          count,
-          null,
-          null,
-          null,
-          {
-            "deleteCount": -1
-          });
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorDetailIf, forEachLine } = require("../helpers");
+const { lineMetadata } = require("./cache");
+
+module.exports = {
+  "names": [ "MD012", "no-multiple-blanks" ],
+  "description": "Multiple consecutive blank lines",
+  "tags": [ "whitespace", "blank_lines" ],
+  "function": function MD012(params, onError) {
+    const maximum = Number(params.config.maximum || 1);
+    let count = 0;
+    forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
+      count = (inCode || (line.trim().length > 0)) ? 0 : count + 1;
+      if (maximum < count) {
+        addErrorDetailIf(
+          onError,
+          lineIndex + 1,
+          maximum,
+          count,
+          null,
+          null,
+          null,
+          {
+            "deleteCount": -1
+          });
+      }
+    });
+  }
+};

package/lib/md013.js

@@ -1,99 +1,99 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorDetailIf, filterTokens, forEachHeading, forEachLine,
-  includesSorted } = require("../helpers");
-const { lineMetadata } = require("./cache");
-
-const longLineRePrefix = "^.{";
-const longLineRePostfixRelaxed = "}.*\\s.*$";
-const longLineRePostfixStrict = "}.+$";
-const labelRe = /^\s*\[.*[^\\]]:/;
-const linkOrImageOnlyLineRe = /^[es]*(lT?L|I)[ES]*$/;
-const sternModeRe = /^([#>\s]*\s)?\S*$/;
-const tokenTypeMap = {
-  "em_open": "e",
-  "em_close": "E",
-  "image": "I",
-  "link_open": "l",
-  "link_close": "L",
-  "strong_open": "s",
-  "strong_close": "S",
-  "text": "T"
-};
-
-module.exports = {
-  "names": [ "MD013", "line-length" ],
-  "description": "Line length",
-  "tags": [ "line_length" ],
-  "function": function MD013(params, onError) {
-    const lineLength = Number(params.config.line_length || 80);
-    const headingLineLength =
-      Number(params.config.heading_line_length || lineLength);
-    const codeLineLength =
-      Number(params.config.code_block_line_length || lineLength);
-    const strict = !!params.config.strict;
-    const stern = !!params.config.stern;
-    const longLineRePostfix =
-      (strict || stern) ? longLineRePostfixStrict : longLineRePostfixRelaxed;
-    const longLineRe =
-      new RegExp(longLineRePrefix + lineLength + longLineRePostfix);
-    const longHeadingLineRe =
-      new RegExp(longLineRePrefix + headingLineLength + longLineRePostfix);
-    const longCodeLineRe =
-      new RegExp(longLineRePrefix + codeLineLength + longLineRePostfix);
-    const codeBlocks = params.config.code_blocks;
-    const includeCodeBlocks = (codeBlocks === undefined) ? true : !!codeBlocks;
-    const tables = params.config.tables;
-    const includeTables = (tables === undefined) ? true : !!tables;
-    let headings = params.config.headings;
-    if (headings === undefined) {
-      headings = params.config.headers;
-    }
-    const includeHeadings = (headings === undefined) ? true : !!headings;
-    const headingLineNumbers = [];
-    forEachHeading(params, (heading) => {
-      headingLineNumbers.push(heading.lineNumber);
-    });
-    const linkOnlyLineNumbers = [];
-    filterTokens(params, "inline", (token) => {
-      let childTokenTypes = "";
-      token.children.forEach((child) => {
-        if (child.type !== "text" || child.content !== "") {
-          childTokenTypes += tokenTypeMap[child.type] || "x";
-        }
-      });
-      if (linkOrImageOnlyLineRe.test(childTokenTypes)) {
-        linkOnlyLineNumbers.push(token.lineNumber);
-      }
-    });
-    forEachLine(lineMetadata(), (line, lineIndex, inCode, onFence, inTable) => {
-      const lineNumber = lineIndex + 1;
-      const isHeading = includesSorted(headingLineNumbers, lineNumber);
-      const length = inCode ?
-        codeLineLength :
-        (isHeading ? headingLineLength : lineLength);
-      const lengthRe = inCode ?
-        longCodeLineRe :
-        (isHeading ? longHeadingLineRe : longLineRe);
-      if ((includeCodeBlocks || !inCode) &&
-          (includeTables || !inTable) &&
-          (includeHeadings || !isHeading) &&
-          (strict ||
-           (!(stern && sternModeRe.test(line)) &&
-            !includesSorted(linkOnlyLineNumbers, lineNumber) &&
-            !labelRe.test(line))) &&
-          lengthRe.test(line)) {
-        addErrorDetailIf(
-          onError,
-          lineNumber,
-          length,
-          line.length,
-          null,
-          null,
-          [ length + 1, line.length - length ]);
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorDetailIf, filterTokens, forEachHeading, forEachLine,
+  includesSorted } = require("../helpers");
+const { lineMetadata } = require("./cache");
+
+const longLineRePrefix = "^.{";
+const longLineRePostfixRelaxed = "}.*\\s.*$";
+const longLineRePostfixStrict = "}.+$";
+const labelRe = /^\s*\[.*[^\\]]:/;
+const linkOrImageOnlyLineRe = /^[es]*(lT?L|I)[ES]*$/;
+const sternModeRe = /^([#>\s]*\s)?\S*$/;
+const tokenTypeMap = {
+  "em_open": "e",
+  "em_close": "E",
+  "image": "I",
+  "link_open": "l",
+  "link_close": "L",
+  "strong_open": "s",
+  "strong_close": "S",
+  "text": "T"
+};
+
+module.exports = {
+  "names": [ "MD013", "line-length" ],
+  "description": "Line length",
+  "tags": [ "line_length" ],
+  "function": function MD013(params, onError) {
+    const lineLength = Number(params.config.line_length || 80);
+    const headingLineLength =
+      Number(params.config.heading_line_length || lineLength);
+    const codeLineLength =
+      Number(params.config.code_block_line_length || lineLength);
+    const strict = !!params.config.strict;
+    const stern = !!params.config.stern;
+    const longLineRePostfix =
+      (strict || stern) ? longLineRePostfixStrict : longLineRePostfixRelaxed;
+    const longLineRe =
+      new RegExp(longLineRePrefix + lineLength + longLineRePostfix);
+    const longHeadingLineRe =
+      new RegExp(longLineRePrefix + headingLineLength + longLineRePostfix);
+    const longCodeLineRe =
+      new RegExp(longLineRePrefix + codeLineLength + longLineRePostfix);
+    const codeBlocks = params.config.code_blocks;
+    const includeCodeBlocks = (codeBlocks === undefined) ? true : !!codeBlocks;
+    const tables = params.config.tables;
+    const includeTables = (tables === undefined) ? true : !!tables;
+    let headings = params.config.headings;
+    if (headings === undefined) {
+      headings = params.config.headers;
+    }
+    const includeHeadings = (headings === undefined) ? true : !!headings;
+    const headingLineNumbers = [];
+    forEachHeading(params, (heading) => {
+      headingLineNumbers.push(heading.lineNumber);
+    });
+    const linkOnlyLineNumbers = [];
+    filterTokens(params, "inline", (token) => {
+      let childTokenTypes = "";
+      token.children.forEach((child) => {
+        if (child.type !== "text" || child.content !== "") {
+          childTokenTypes += tokenTypeMap[child.type] || "x";
+        }
+      });
+      if (linkOrImageOnlyLineRe.test(childTokenTypes)) {
+        linkOnlyLineNumbers.push(token.lineNumber);
+      }
+    });
+    forEachLine(lineMetadata(), (line, lineIndex, inCode, onFence, inTable) => {
+      const lineNumber = lineIndex + 1;
+      const isHeading = includesSorted(headingLineNumbers, lineNumber);
+      const length = inCode ?
+        codeLineLength :
+        (isHeading ? headingLineLength : lineLength);
+      const lengthRe = inCode ?
+        longCodeLineRe :
+        (isHeading ? longHeadingLineRe : longLineRe);
+      if ((includeCodeBlocks || !inCode) &&
+          (includeTables || !inTable) &&
+          (includeHeadings || !isHeading) &&
+          (strict ||
+           (!(stern && sternModeRe.test(line)) &&
+            !includesSorted(linkOnlyLineNumbers, lineNumber) &&
+            !labelRe.test(line))) &&
+          lengthRe.test(line)) {
+        addErrorDetailIf(
+          onError,
+          lineNumber,
+          length,
+          line.length,
+          null,
+          null,
+          [ length + 1, line.length - length ]);
+      }
+    });
+  }
+};