markdownlint 0.20.0 → 0.20.4

package/lib/md023.js

@@ -1,38 +1,38 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorContext, filterTokens } = require("../helpers");
-
-const spaceBeforeHeadingRe = /^((?:\s+)|(?:[>\s]+\s\s))[^>\s]/;
-
-module.exports = {
-  "names": [ "MD023", "heading-start-left", "header-start-left" ],
-  "description": "Headings must start at the beginning of the line",
-  "tags": [ "headings", "headers", "spaces" ],
-  "function": function MD023(params, onError) {
-    filterTokens(params, "heading_open", function forToken(token) {
-      const { lineNumber, line } = token;
-      const match = line.match(spaceBeforeHeadingRe);
-      if (match) {
-        const [ prefixAndFirstChar, prefix ] = match;
-        let deleteCount = prefix.length;
-        const prefixLengthNoSpace = prefix.trimRight().length;
-        if (prefixLengthNoSpace) {
-          deleteCount -= prefixLengthNoSpace - 1;
-        }
-        addErrorContext(
-          onError,
-          lineNumber,
-          line,
-          null,
-          null,
-          [ 1, prefixAndFirstChar.length ],
-          {
-            "editColumn": prefixLengthNoSpace + 1,
-            "deleteCount": deleteCount
-          });
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorContext, filterTokens } = require("../helpers");
+
+const spaceBeforeHeadingRe = /^((?:\s+)|(?:[>\s]+\s\s))[^>\s]/;
+
+module.exports = {
+  "names": [ "MD023", "heading-start-left", "header-start-left" ],
+  "description": "Headings must start at the beginning of the line",
+  "tags": [ "headings", "headers", "spaces" ],
+  "function": function MD023(params, onError) {
+    filterTokens(params, "heading_open", function forToken(token) {
+      const { lineNumber, line } = token;
+      const match = line.match(spaceBeforeHeadingRe);
+      if (match) {
+        const [ prefixAndFirstChar, prefix ] = match;
+        let deleteCount = prefix.length;
+        const prefixLengthNoSpace = prefix.trimRight().length;
+        if (prefixLengthNoSpace) {
+          deleteCount -= prefixLengthNoSpace - 1;
+        }
+        addErrorContext(
+          onError,
+          lineNumber,
+          line,
+          null,
+          null,
+          [ 1, prefixAndFirstChar.length ],
+          {
+            "editColumn": prefixLengthNoSpace + 1,
+            "deleteCount": deleteCount
+          });
+      }
+    });
+  }
+};

package/lib/md024.js

@@ -1,38 +1,38 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorContext, forEachHeading } = require("../helpers");
-
-module.exports = {
-  "names": [ "MD024", "no-duplicate-heading", "no-duplicate-header" ],
-  "description": "Multiple headings with the same content",
-  "tags": [ "headings", "headers" ],
-  "function": function MD024(params, onError) {
-    const siblingsOnly = !!params.config.siblings_only ||
-      !!params.config.allow_different_nesting || false;
-    const knownContents = [ null, [] ];
-    let lastLevel = 1;
-    let knownContent = knownContents[lastLevel];
-    forEachHeading(params, (heading, content) => {
-      if (siblingsOnly) {
-        const newLevel = heading.tag.slice(1);
-        while (lastLevel < newLevel) {
-          lastLevel++;
-          knownContents[lastLevel] = [];
-        }
-        while (lastLevel > newLevel) {
-          knownContents[lastLevel] = [];
-          lastLevel--;
-        }
-        knownContent = knownContents[newLevel];
-      }
-      if (knownContent.includes(content)) {
-        addErrorContext(onError, heading.lineNumber,
-          heading.line.trim());
-      } else {
-        knownContent.push(content);
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorContext, forEachHeading } = require("../helpers");
+
+module.exports = {
+  "names": [ "MD024", "no-duplicate-heading", "no-duplicate-header" ],
+  "description": "Multiple headings with the same content",
+  "tags": [ "headings", "headers" ],
+  "function": function MD024(params, onError) {
+    const siblingsOnly = !!params.config.siblings_only ||
+      !!params.config.allow_different_nesting || false;
+    const knownContents = [ null, [] ];
+    let lastLevel = 1;
+    let knownContent = knownContents[lastLevel];
+    forEachHeading(params, (heading, content) => {
+      if (siblingsOnly) {
+        const newLevel = heading.tag.slice(1);
+        while (lastLevel < newLevel) {
+          lastLevel++;
+          knownContents[lastLevel] = [];
+        }
+        while (lastLevel > newLevel) {
+          knownContents[lastLevel] = [];
+          lastLevel--;
+        }
+        knownContent = knownContents[newLevel];
+      }
+      if (knownContent.includes(content)) {
+        addErrorContext(onError, heading.lineNumber,
+          heading.line.trim());
+      } else {
+        knownContent.push(content);
+      }
+    });
+  }
+};

package/lib/md025.js

@@ -1,32 +1,32 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorContext, filterTokens, frontMatterHasTitle } =
-  require("../helpers");
-
-module.exports = {
-  "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 = Number(params.config.level || 1);
-    const tag = "h" + level;
-    const foundFrontMatterTitle =
-      frontMatterHasTitle(
-        params.frontMatterLines,
-        params.config.front_matter_title
-      );
-    let hasTopLevelHeading = false;
-    filterTokens(params, "heading_open", function forToken(token) {
-      if (token.tag === tag) {
-        if (hasTopLevelHeading || foundFrontMatterTitle) {
-          addErrorContext(onError, token.lineNumber,
-            token.line.trim());
-        } else if (token.lineNumber === 1) {
-          hasTopLevelHeading = true;
-        }
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorContext, filterTokens, frontMatterHasTitle } =
+  require("../helpers");
+
+module.exports = {
+  "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 = Number(params.config.level || 1);
+    const tag = "h" + level;
+    const foundFrontMatterTitle =
+      frontMatterHasTitle(
+        params.frontMatterLines,
+        params.config.front_matter_title
+      );
+    let hasTopLevelHeading = false;
+    filterTokens(params, "heading_open", function forToken(token) {
+      if (token.tag === tag) {
+        if (hasTopLevelHeading || foundFrontMatterTitle) {
+          addErrorContext(onError, token.lineNumber,
+            token.line.trim());
+        } else if (token.lineNumber === 1) {
+          hasTopLevelHeading = true;
+        }
+      }
+    });
+  }
+};

package/lib/md026.js

@@ -1,40 +1,40 @@
-// @ts-check
-
-"use strict";
-
-const { addError, allPunctuation, escapeForRegExp, forEachHeading } =
-  require("../helpers");
-
-module.exports = {
-  "names": [ "MD026", "no-trailing-punctuation" ],
-  "description": "Trailing punctuation in heading",
-  "tags": [ "headings", "headers" ],
-  "function": function MD026(params, onError) {
-    let punctuation = params.config.punctuation;
-    punctuation =
-      String((punctuation === undefined) ? allPunctuation : punctuation);
-    const trailingPunctuationRe =
-      new RegExp("\\s*[" + escapeForRegExp(punctuation) + "]+$");
-    forEachHeading(params, (heading) => {
-      const { line, lineNumber } = heading;
-      const trimmedLine = line.replace(/[\s#]*$/, "");
-      const match = trailingPunctuationRe.exec(trimmedLine);
-      if (match) {
-        const fullMatch = match[0];
-        const column = match.index + 1;
-        const length = fullMatch.length;
-        addError(
-          onError,
-          lineNumber,
-          `Punctuation: '${fullMatch}'`,
-          null,
-          [ column, length ],
-          {
-            "editColumn": column,
-            "deleteCount": length
-          }
-        );
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addError, allPunctuation, escapeForRegExp, forEachHeading } =
+  require("../helpers");
+
+module.exports = {
+  "names": [ "MD026", "no-trailing-punctuation" ],
+  "description": "Trailing punctuation in heading",
+  "tags": [ "headings", "headers" ],
+  "function": function MD026(params, onError) {
+    let punctuation = params.config.punctuation;
+    punctuation =
+      String((punctuation === undefined) ? allPunctuation : punctuation);
+    const trailingPunctuationRe =
+      new RegExp("\\s*[" + escapeForRegExp(punctuation) + "]+$");
+    forEachHeading(params, (heading) => {
+      const { line, lineNumber } = heading;
+      const trimmedLine = line.replace(/[\s#]*$/, "");
+      const match = trailingPunctuationRe.exec(trimmedLine);
+      if (match) {
+        const fullMatch = match[0];
+        const column = match.index + 1;
+        const length = fullMatch.length;
+        addError(
+          onError,
+          lineNumber,
+          `Punctuation: '${fullMatch}'`,
+          null,
+          [ column, length ],
+          {
+            "editColumn": column,
+            "deleteCount": length
+          }
+        );
+      }
+    });
+  }
+};

package/lib/md027.js

@@ -1,56 +1,56 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorContext, newLineRe } = require("../helpers");
-
-const spaceAfterBlockQuoteRe = /^((?:\s*>)+)(\s{2,})\S/;
-
-module.exports = {
-  "names": [ "MD027", "no-multiple-space-blockquote" ],
-  "description": "Multiple spaces after blockquote symbol",
-  "tags": [ "blockquote", "whitespace", "indentation" ],
-  "function": function MD027(params, onError) {
-    let blockquoteNesting = 0;
-    let listItemNesting = 0;
-    params.tokens.forEach((token) => {
-      const { content, lineNumber, type } = token;
-      if (type === "blockquote_open") {
-        blockquoteNesting++;
-      } else if (type === "blockquote_close") {
-        blockquoteNesting--;
-      } else if (type === "list_item_open") {
-        listItemNesting++;
-      } else if (type === "list_item_close") {
-        listItemNesting--;
-      } else if ((type === "inline") && blockquoteNesting) {
-        const lineCount = content.split(newLineRe).length;
-        for (let i = 0; i < lineCount; i++) {
-          const line = params.lines[lineNumber + i - 1];
-          const match = line.match(spaceAfterBlockQuoteRe);
-          if (match) {
-            const [
-              fullMatch,
-              { "length": blockquoteLength },
-              { "length": spaceLength }
-            ] = match;
-            if (!listItemNesting || (fullMatch[fullMatch.length - 1] === ">")) {
-              addErrorContext(
-                onError,
-                lineNumber + i,
-                line,
-                null,
-                null,
-                [ 1, fullMatch.length ],
-                {
-                  "editColumn": blockquoteLength + 1,
-                  "deleteCount": spaceLength - 1
-                }
-              );
-            }
-          }
-        }
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorContext, newLineRe } = require("../helpers");
+
+const spaceAfterBlockQuoteRe = /^((?:\s*>)+)(\s{2,})\S/;
+
+module.exports = {
+  "names": [ "MD027", "no-multiple-space-blockquote" ],
+  "description": "Multiple spaces after blockquote symbol",
+  "tags": [ "blockquote", "whitespace", "indentation" ],
+  "function": function MD027(params, onError) {
+    let blockquoteNesting = 0;
+    let listItemNesting = 0;
+    params.tokens.forEach((token) => {
+      const { content, lineNumber, type } = token;
+      if (type === "blockquote_open") {
+        blockquoteNesting++;
+      } else if (type === "blockquote_close") {
+        blockquoteNesting--;
+      } else if (type === "list_item_open") {
+        listItemNesting++;
+      } else if (type === "list_item_close") {
+        listItemNesting--;
+      } else if ((type === "inline") && blockquoteNesting) {
+        const lineCount = content.split(newLineRe).length;
+        for (let i = 0; i < lineCount; i++) {
+          const line = params.lines[lineNumber + i - 1];
+          const match = line.match(spaceAfterBlockQuoteRe);
+          if (match) {
+            const [
+              fullMatch,
+              { "length": blockquoteLength },
+              { "length": spaceLength }
+            ] = match;
+            if (!listItemNesting || (fullMatch[fullMatch.length - 1] === ">")) {
+              addErrorContext(
+                onError,
+                lineNumber + i,
+                line,
+                null,
+                null,
+                [ 1, fullMatch.length ],
+                {
+                  "editColumn": blockquoteLength + 1,
+                  "deleteCount": spaceLength - 1
+                }
+              );
+            }
+          }
+        }
+      }
+    });
+  }
+};

package/lib/md028.js

@@ -1,38 +1,38 @@
-// @ts-check
-
-"use strict";
-
-const { addError } = require("../helpers");
-
-module.exports = {
-  "names": [ "MD028", "no-blanks-blockquote" ],
-  "description": "Blank line inside blockquote",
-  "tags": [ "blockquote", "whitespace" ],
-  "function": function MD028(params, onError) {
-    let prevToken = {};
-    let prevLineNumber = null;
-    params.tokens.forEach(function forToken(token) {
-      if ((token.type === "blockquote_open") &&
-          (prevToken.type === "blockquote_close")) {
-        for (
-          let lineNumber = prevLineNumber;
-          lineNumber < token.lineNumber;
-          lineNumber++) {
-          addError(
-            onError,
-            lineNumber,
-            null,
-            null,
-            null,
-            {
-              "deleteCount": -1
-            });
-        }
-      }
-      prevToken = token;
-      if (token.type === "blockquote_open") {
-        prevLineNumber = token.map[1] + 1;
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addError } = require("../helpers");
+
+module.exports = {
+  "names": [ "MD028", "no-blanks-blockquote" ],
+  "description": "Blank line inside blockquote",
+  "tags": [ "blockquote", "whitespace" ],
+  "function": function MD028(params, onError) {
+    let prevToken = {};
+    let prevLineNumber = null;
+    params.tokens.forEach(function forToken(token) {
+      if ((token.type === "blockquote_open") &&
+          (prevToken.type === "blockquote_close")) {
+        for (
+          let lineNumber = prevLineNumber;
+          lineNumber < token.lineNumber;
+          lineNumber++) {
+          addError(
+            onError,
+            lineNumber,
+            null,
+            null,
+            null,
+            {
+              "deleteCount": -1
+            });
+        }
+      }
+      prevToken = token;
+      if (token.type === "blockquote_open") {
+        prevLineNumber = token.map[1] + 1;
+      }
+    });
+  }
+};

package/lib/md029.js

@@ -1,66 +1,66 @@
-// @ts-check
-
-"use strict";
-
-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" ],
-  "description": "Ordered list item prefix",
-  "tags": [ "ol" ],
-  "function": function MD029(params, onError) {
-    const style = String(params.config.style || "one_or_ordered");
-    flattenedLists().filter((list) => !list.unordered).forEach((list) => {
-      const { items } = list;
-      let current = 1;
-      let incrementing = false;
-      // Check for incrementing number pattern 1/2/3 or 0/1/2
-      if (items.length >= 2) {
-        const first = orderedListItemMarkerRe.exec(items[0].line);
-        const second = orderedListItemMarkerRe.exec(items[1].line);
-        if (first && second) {
-          const [ , firstNumber ] = first;
-          const [ , secondNumber ] = second;
-          if ((secondNumber !== "1") || (firstNumber === "0")) {
-            incrementing = true;
-            if (firstNumber === "0") {
-              current = 0;
-            }
-          }
-        }
-      }
-      // Determine effective style
-      let listStyle = style;
-      if (listStyle === "one_or_ordered") {
-        listStyle = incrementing ? "ordered" : "one";
-      }
-      // Force expected value for 0/0/0 and 1/1/1 patterns
-      if (listStyle === "zero") {
-        current = 0;
-      } else if (listStyle === "one") {
-        current = 1;
-      }
-      // Validate each list item marker
-      items.forEach((item) => {
-        const match = orderedListItemMarkerRe.exec(item.line);
-        if (match) {
-          addErrorDetailIf(onError, item.lineNumber,
-            String(current), match[1],
-            "Style: " + listStyleExamples[listStyle], null,
-            rangeFromRegExp(item.line, listItemMarkerRe));
-          if (listStyle === "ordered") {
-            current++;
-          }
-        }
-      });
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+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" ],
+  "description": "Ordered list item prefix",
+  "tags": [ "ol" ],
+  "function": function MD029(params, onError) {
+    const style = String(params.config.style || "one_or_ordered");
+    flattenedLists().filter((list) => !list.unordered).forEach((list) => {
+      const { items } = list;
+      let current = 1;
+      let incrementing = false;
+      // Check for incrementing number pattern 1/2/3 or 0/1/2
+      if (items.length >= 2) {
+        const first = orderedListItemMarkerRe.exec(items[0].line);
+        const second = orderedListItemMarkerRe.exec(items[1].line);
+        if (first && second) {
+          const [ , firstNumber ] = first;
+          const [ , secondNumber ] = second;
+          if ((secondNumber !== "1") || (firstNumber === "0")) {
+            incrementing = true;
+            if (firstNumber === "0") {
+              current = 0;
+            }
+          }
+        }
+      }
+      // Determine effective style
+      let listStyle = style;
+      if (listStyle === "one_or_ordered") {
+        listStyle = incrementing ? "ordered" : "one";
+      }
+      // Force expected value for 0/0/0 and 1/1/1 patterns
+      if (listStyle === "zero") {
+        current = 0;
+      } else if (listStyle === "one") {
+        current = 1;
+      }
+      // Validate each list item marker
+      items.forEach((item) => {
+        const match = orderedListItemMarkerRe.exec(item.line);
+        if (match) {
+          addErrorDetailIf(onError, item.lineNumber,
+            String(current), match[1],
+            "Style: " + listStyleExamples[listStyle], null,
+            rangeFromRegExp(item.line, listItemMarkerRe));
+          if (listStyle === "ordered") {
+            current++;
+          }
+        }
+      });
+    });
+  }
+};