markdownlint 0.20.0 → 0.20.4

package/lib/md001.js

@@ -1,22 +1,22 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorDetailIf, filterTokens } = require("../helpers");
-
-module.exports = {
-  "names": [ "MD001", "heading-increment", "header-increment" ],
-  "description": "Heading levels should only increment by one level at a time",
-  "tags": [ "headings", "headers" ],
-  "function": function MD001(params, onError) {
-    let prevLevel = 0;
-    filterTokens(params, "heading_open", function forToken(token) {
-      const level = parseInt(token.tag.slice(1), 10);
-      if (prevLevel && (level > prevLevel)) {
-        addErrorDetailIf(onError, token.lineNumber,
-          "h" + (prevLevel + 1), "h" + level);
-      }
-      prevLevel = level;
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorDetailIf, filterTokens } = require("../helpers");
+
+module.exports = {
+  "names": [ "MD001", "heading-increment", "header-increment" ],
+  "description": "Heading levels should only increment by one level at a time",
+  "tags": [ "headings", "headers" ],
+  "function": function MD001(params, onError) {
+    let prevLevel = 0;
+    filterTokens(params, "heading_open", function forToken(token) {
+      const level = parseInt(token.tag.slice(1), 10);
+      if (prevLevel && (level > prevLevel)) {
+        addErrorDetailIf(onError, token.lineNumber,
+          "h" + (prevLevel + 1), "h" + level);
+      }
+      prevLevel = level;
+    });
+  }
+};

package/lib/md002.js

@@ -1,22 +1,22 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorDetailIf } = require("../helpers");
-
-module.exports = {
-  "names": [ "MD002", "first-heading-h1", "first-header-h1" ],
-  "description": "First heading should be a top level heading",
-  "tags": [ "headings", "headers" ],
-  "function": function MD002(params, onError) {
-    const level = Number(params.config.level || 1);
-    const tag = "h" + level;
-    params.tokens.every(function forToken(token) {
-      if (token.type === "heading_open") {
-        addErrorDetailIf(onError, token.lineNumber, tag, token.tag);
-        return false;
-      }
-      return true;
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorDetailIf } = require("../helpers");
+
+module.exports = {
+  "names": [ "MD002", "first-heading-h1", "first-header-h1" ],
+  "description": "First heading should be a top level heading",
+  "tags": [ "headings", "headers" ],
+  "function": function MD002(params, onError) {
+    const level = Number(params.config.level || 1);
+    const tag = "h" + level;
+    params.tokens.every(function forToken(token) {
+      if (token.type === "heading_open") {
+        addErrorDetailIf(onError, token.lineNumber, tag, token.tag);
+        return false;
+      }
+      return true;
+    });
+  }
+};

package/lib/md003.js

@@ -1,42 +1,42 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorDetailIf, filterTokens, headingStyleFor } =
-  require("../helpers");
-
-module.exports = {
-  "names": [ "MD003", "heading-style", "header-style" ],
-  "description": "Heading style",
-  "tags": [ "headings", "headers" ],
-  "function": function MD003(params, onError) {
-    let style = String(params.config.style || "consistent");
-    filterTokens(params, "heading_open", function forToken(token) {
-      const styleForToken = headingStyleFor(token);
-      if (style === "consistent") {
-        style = styleForToken;
-      }
-      if (styleForToken !== style) {
-        const h12 = /h[12]/.test(token.tag);
-        const setextWithAtx =
-          (style === "setext_with_atx") &&
-            ((h12 && (styleForToken === "setext")) ||
-            (!h12 && (styleForToken === "atx")));
-        const setextWithAtxClosed =
-          (style === "setext_with_atx_closed") &&
-            ((h12 && (styleForToken === "setext")) ||
-            (!h12 && (styleForToken === "atx_closed")));
-        if (!setextWithAtx && !setextWithAtxClosed) {
-          let expected = style;
-          if (style === "setext_with_atx") {
-            expected = h12 ? "setext" : "atx";
-          } else if (style === "setext_with_atx_closed") {
-            expected = h12 ? "setext" : "atx_closed";
-          }
-          addErrorDetailIf(onError, token.lineNumber,
-            expected, styleForToken);
-        }
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorDetailIf, filterTokens, headingStyleFor } =
+  require("../helpers");
+
+module.exports = {
+  "names": [ "MD003", "heading-style", "header-style" ],
+  "description": "Heading style",
+  "tags": [ "headings", "headers" ],
+  "function": function MD003(params, onError) {
+    let style = String(params.config.style || "consistent");
+    filterTokens(params, "heading_open", function forToken(token) {
+      const styleForToken = headingStyleFor(token);
+      if (style === "consistent") {
+        style = styleForToken;
+      }
+      if (styleForToken !== style) {
+        const h12 = /h[12]/.test(token.tag);
+        const setextWithAtx =
+          (style === "setext_with_atx") &&
+            ((h12 && (styleForToken === "setext")) ||
+            (!h12 && (styleForToken === "atx")));
+        const setextWithAtxClosed =
+          (style === "setext_with_atx_closed") &&
+            ((h12 && (styleForToken === "setext")) ||
+            (!h12 && (styleForToken === "atx_closed")));
+        if (!setextWithAtx && !setextWithAtxClosed) {
+          let expected = style;
+          if (style === "setext_with_atx") {
+            expected = h12 ? "setext" : "atx";
+          } else if (style === "setext_with_atx_closed") {
+            expected = h12 ? "setext" : "atx_closed";
+          }
+          addErrorDetailIf(onError, token.lineNumber,
+            expected, styleForToken);
+        }
+      }
+    });
+  }
+};

package/lib/md004.js

@@ -1,43 +1,43 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorDetailIf, listItemMarkerRe,
-  rangeFromRegExp, unorderedListStyleFor } = require("../helpers");
-const { flattenedLists } = require("./cache");
-
-module.exports = {
-  "names": [ "MD004", "ul-style" ],
-  "description": "Unordered list style",
-  "tags": [ "bullet", "ul" ],
-  "function": function MD004(params, onError) {
-    const style = String(params.config.style || "consistent");
-    let expectedStyle = style;
-    const nestingStyles = [];
-    flattenedLists().forEach((list) => {
-      if (list.unordered) {
-        if (expectedStyle === "consistent") {
-          expectedStyle = unorderedListStyleFor(list.items[0]);
-        }
-        list.items.forEach((item) => {
-          const itemStyle = unorderedListStyleFor(item);
-          if (style === "sublist") {
-            const nesting = list.nesting;
-            if (!nestingStyles[nesting] &&
-              (itemStyle !== nestingStyles[nesting - 1])) {
-              nestingStyles[nesting] = itemStyle;
-            } else {
-              addErrorDetailIf(onError, item.lineNumber,
-                nestingStyles[nesting], itemStyle, null, null,
-                rangeFromRegExp(item.line, listItemMarkerRe));
-            }
-          } else {
-            addErrorDetailIf(onError, item.lineNumber,
-              expectedStyle, itemStyle, null, null,
-              rangeFromRegExp(item.line, listItemMarkerRe));
-          }
-        });
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorDetailIf, listItemMarkerRe,
+  rangeFromRegExp, unorderedListStyleFor } = require("../helpers");
+const { flattenedLists } = require("./cache");
+
+module.exports = {
+  "names": [ "MD004", "ul-style" ],
+  "description": "Unordered list style",
+  "tags": [ "bullet", "ul" ],
+  "function": function MD004(params, onError) {
+    const style = String(params.config.style || "consistent");
+    let expectedStyle = style;
+    const nestingStyles = [];
+    flattenedLists().forEach((list) => {
+      if (list.unordered) {
+        if (expectedStyle === "consistent") {
+          expectedStyle = unorderedListStyleFor(list.items[0]);
+        }
+        list.items.forEach((item) => {
+          const itemStyle = unorderedListStyleFor(item);
+          if (style === "sublist") {
+            const nesting = list.nesting;
+            if (!nestingStyles[nesting] &&
+              (itemStyle !== nestingStyles[nesting - 1])) {
+              nestingStyles[nesting] = itemStyle;
+            } else {
+              addErrorDetailIf(onError, item.lineNumber,
+                nestingStyles[nesting], itemStyle, null, null,
+                rangeFromRegExp(item.line, listItemMarkerRe));
+            }
+          } else {
+            addErrorDetailIf(onError, item.lineNumber,
+              expectedStyle, itemStyle, null, null,
+              rangeFromRegExp(item.line, listItemMarkerRe));
+          }
+        });
+      }
+    });
+  }
+};

package/lib/md005.js

@@ -1,69 +1,69 @@
-// @ts-check
-
-"use strict";
-
-const { addError, addErrorDetailIf, indentFor, listItemMarkerRe,
-  orderedListItemMarkerRe, rangeFromRegExp } = require("../helpers");
-const { flattenedLists } = require("./cache");
-
-module.exports = {
-  "names": [ "MD005", "list-indent" ],
-  "description": "Inconsistent indentation for list items at the same level",
-  "tags": [ "bullet", "ul", "indentation" ],
-  "function": function MD005(params, onError) {
-    flattenedLists().forEach((list) => {
-      const expectedIndent = list.indent;
-      let expectedEnd = 0;
-      let actualEnd = -1;
-      let endMatching = false;
-      list.items.forEach((item) => {
-        const { line, lineNumber } = item;
-        const actualIndent = indentFor(item);
-        let match = null;
-        if (list.unordered) {
-          addErrorDetailIf(
-            onError,
-            lineNumber,
-            expectedIndent,
-            actualIndent,
-            null,
-            null,
-            rangeFromRegExp(line, listItemMarkerRe)
-            // No fixInfo; MD007 handles this scenario better
-          );
-        } else if ((match = orderedListItemMarkerRe.exec(line))) {
-          actualEnd = match[0].length;
-          expectedEnd = expectedEnd || actualEnd;
-          const markerLength = match[1].length + 1;
-          if ((expectedIndent !== actualIndent) || endMatching) {
-            if (expectedEnd === actualEnd) {
-              endMatching = true;
-            } else {
-              const detail = endMatching ?
-                `Expected: (${expectedEnd}); Actual: (${actualEnd})` :
-                `Expected: ${expectedIndent}; Actual: ${actualIndent}`;
-              const expected = endMatching ?
-                expectedEnd - markerLength :
-                expectedIndent;
-              const actual = endMatching ?
-                actualEnd - markerLength :
-                actualIndent;
-              addError(
-                onError,
-                lineNumber,
-                detail,
-                null,
-                rangeFromRegExp(line, listItemMarkerRe),
-                {
-                  "editColumn": Math.min(actual, expected) + 1,
-                  "deleteCount": Math.max(actual - expected, 0),
-                  "insertText": "".padEnd(Math.max(expected - actual, 0))
-                }
-              );
-            }
-          }
-        }
-      });
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addError, addErrorDetailIf, indentFor, listItemMarkerRe,
+  orderedListItemMarkerRe, rangeFromRegExp } = require("../helpers");
+const { flattenedLists } = require("./cache");
+
+module.exports = {
+  "names": [ "MD005", "list-indent" ],
+  "description": "Inconsistent indentation for list items at the same level",
+  "tags": [ "bullet", "ul", "indentation" ],
+  "function": function MD005(params, onError) {
+    flattenedLists().forEach((list) => {
+      const expectedIndent = list.indent;
+      let expectedEnd = 0;
+      let actualEnd = -1;
+      let endMatching = false;
+      list.items.forEach((item) => {
+        const { line, lineNumber } = item;
+        const actualIndent = indentFor(item);
+        let match = null;
+        if (list.unordered) {
+          addErrorDetailIf(
+            onError,
+            lineNumber,
+            expectedIndent,
+            actualIndent,
+            null,
+            null,
+            rangeFromRegExp(line, listItemMarkerRe)
+            // No fixInfo; MD007 handles this scenario better
+          );
+        } else if ((match = orderedListItemMarkerRe.exec(line))) {
+          actualEnd = match[0].length;
+          expectedEnd = expectedEnd || actualEnd;
+          const markerLength = match[1].length + 1;
+          if ((expectedIndent !== actualIndent) || endMatching) {
+            if (expectedEnd === actualEnd) {
+              endMatching = true;
+            } else {
+              const detail = endMatching ?
+                `Expected: (${expectedEnd}); Actual: (${actualEnd})` :
+                `Expected: ${expectedIndent}; Actual: ${actualIndent}`;
+              const expected = endMatching ?
+                expectedEnd - markerLength :
+                expectedIndent;
+              const actual = endMatching ?
+                actualEnd - markerLength :
+                actualIndent;
+              addError(
+                onError,
+                lineNumber,
+                detail,
+                null,
+                rangeFromRegExp(line, listItemMarkerRe),
+                {
+                  "editColumn": Math.min(actual, expected) + 1,
+                  "deleteCount": Math.max(actual - expected, 0),
+                  "insertText": "".padEnd(Math.max(expected - actual, 0))
+                }
+              );
+            }
+          }
+        }
+      });
+    });
+  }
+};

package/lib/md006.js

@@ -1,34 +1,34 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorDetailIf, listItemMarkerRe, rangeFromRegExp } =
-  require("../helpers");
-const { flattenedLists } = require("./cache");
-
-module.exports = {
-  "names": [ "MD006", "ul-start-left" ],
-  "description":
-    "Consider starting bulleted lists at the beginning of the line",
-  "tags": [ "bullet", "ul", "indentation" ],
-  "function": function MD006(params, onError) {
-    flattenedLists().forEach((list) => {
-      if (list.unordered && !list.nesting && (list.indent !== 0)) {
-        list.items.forEach((item) => {
-          const { lineNumber, line } = item;
-          addErrorDetailIf(
-            onError,
-            lineNumber,
-            0,
-            list.indent,
-            null,
-            null,
-            rangeFromRegExp(line, listItemMarkerRe),
-            {
-              "deleteCount": line.length - line.trimLeft().length
-            });
-        });
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorDetailIf, listItemMarkerRe, rangeFromRegExp } =
+  require("../helpers");
+const { flattenedLists } = require("./cache");
+
+module.exports = {
+  "names": [ "MD006", "ul-start-left" ],
+  "description":
+    "Consider starting bulleted lists at the beginning of the line",
+  "tags": [ "bullet", "ul", "indentation" ],
+  "function": function MD006(params, onError) {
+    flattenedLists().forEach((list) => {
+      if (list.unordered && !list.nesting && (list.indent !== 0)) {
+        list.items.forEach((item) => {
+          const { lineNumber, line } = item;
+          addErrorDetailIf(
+            onError,
+            lineNumber,
+            0,
+            list.indent,
+            null,
+            null,
+            rangeFromRegExp(line, listItemMarkerRe),
+            {
+              "deleteCount": line.length - line.trimLeft().length
+            });
+        });
+      }
+    });
+  }
+};

package/lib/md007.js

@@ -1,47 +1,47 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorDetailIf, indentFor, listItemMarkerRe } =
-  require("../helpers");
-const { flattenedLists } = require("./cache");
-
-module.exports = {
-  "names": [ "MD007", "ul-indent" ],
-  "description": "Unordered list indentation",
-  "tags": [ "bullet", "ul", "indentation" ],
-  "function": function MD007(params, onError) {
-    const indent = Number(params.config.indent || 2);
-    const startIndented = !!params.config.start_indented;
-    flattenedLists().forEach((list) => {
-      if (list.unordered && list.parentsUnordered) {
-        list.items.forEach((item) => {
-          const { lineNumber, line } = item;
-          const expectedNesting = list.nesting + (startIndented ? 1 : 0);
-          const expectedIndent = expectedNesting * indent;
-          const actualIndent = indentFor(item);
-          let range = null;
-          let editColumn = 1;
-          const match = line.match(listItemMarkerRe);
-          if (match) {
-            range = [ 1, match[0].length ];
-            editColumn += match[1].length - actualIndent;
-          }
-          addErrorDetailIf(
-            onError,
-            lineNumber,
-            expectedIndent,
-            actualIndent,
-            null,
-            null,
-            range,
-            {
-              editColumn,
-              "deleteCount": actualIndent,
-              "insertText": "".padEnd(expectedIndent)
-            });
-        });
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorDetailIf, indentFor, listItemMarkerRe } =
+  require("../helpers");
+const { flattenedLists } = require("./cache");
+
+module.exports = {
+  "names": [ "MD007", "ul-indent" ],
+  "description": "Unordered list indentation",
+  "tags": [ "bullet", "ul", "indentation" ],
+  "function": function MD007(params, onError) {
+    const indent = Number(params.config.indent || 2);
+    const startIndented = !!params.config.start_indented;
+    flattenedLists().forEach((list) => {
+      if (list.unordered && list.parentsUnordered) {
+        list.items.forEach((item) => {
+          const { lineNumber, line } = item;
+          const expectedNesting = list.nesting + (startIndented ? 1 : 0);
+          const expectedIndent = expectedNesting * indent;
+          const actualIndent = indentFor(item);
+          let range = null;
+          let editColumn = 1;
+          const match = line.match(listItemMarkerRe);
+          if (match) {
+            range = [ 1, match[0].length ];
+            editColumn += match[1].length - actualIndent;
+          }
+          addErrorDetailIf(
+            onError,
+            lineNumber,
+            expectedIndent,
+            actualIndent,
+            null,
+            null,
+            range,
+            {
+              editColumn,
+              "deleteCount": actualIndent,
+              "insertText": "".padEnd(expectedIndent)
+            });
+        });
+      }
+    });
+  }
+};