markdownlint 0.20.2 → 0.21.1

package/lib/md042.js

@@ -1,41 +1,42 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorContext, filterTokens, rangeFromRegExp } =
-  require("../helpers");
-
-const emptyLinkRe = /\[[^\]]*](?:\((?:#?|(?:<>))\))/;
-
-module.exports = {
-  "names": [ "MD042", "no-empty-links" ],
-  "description": "No empty links",
-  "tags": [ "links" ],
-  "function": function MD042(params, onError) {
-    filterTokens(params, "inline", function forToken(token) {
-      let inLink = false;
-      let linkText = "";
-      let emptyLink = false;
-      token.children.forEach(function forChild(child) {
-        if (child.type === "link_open") {
-          inLink = true;
-          linkText = "";
-          child.attrs.forEach(function forAttr(attr) {
-            if (attr[0] === "href" && (!attr[1] || (attr[1] === "#"))) {
-              emptyLink = true;
-            }
-          });
-        } else if (child.type === "link_close") {
-          inLink = false;
-          if (emptyLink) {
-            addErrorContext(onError, child.lineNumber,
-              "[" + linkText + "]()", null, null,
-              rangeFromRegExp(child.line, emptyLinkRe));
-          }
-        } else if (inLink) {
-          linkText += child.content;
-        }
-      });
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorContext, filterTokens, rangeFromRegExp } =
+  require("../helpers");
+
+const emptyLinkRe = /\[[^\]]*](?:\((?:#?|(?:<>))\))/;
+
+module.exports = {
+  "names": [ "MD042", "no-empty-links" ],
+  "description": "No empty links",
+  "tags": [ "links" ],
+  "function": function MD042(params, onError) {
+    filterTokens(params, "inline", function forToken(token) {
+      let inLink = false;
+      let linkText = "";
+      let emptyLink = false;
+      token.children.forEach(function forChild(child) {
+        if (child.type === "link_open") {
+          inLink = true;
+          linkText = "";
+          child.attrs.forEach(function forAttr(attr) {
+            if (attr[0] === "href" && (!attr[1] || (attr[1] === "#"))) {
+              emptyLink = true;
+            }
+          });
+        } else if (child.type === "link_close") {
+          inLink = false;
+          if (emptyLink) {
+            addErrorContext(onError, child.lineNumber,
+              "[" + linkText + "]()", null, null,
+              rangeFromRegExp(child.line, emptyLinkRe));
+            emptyLink = false;
+          }
+        } else if (inLink) {
+          linkText += child.content;
+        }
+      });
+    });
+  }
+};

package/lib/md043.js

@@ -1,45 +1,45 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorContext, addErrorDetailIf, forEachHeading } =
-  require("../helpers");
-
-module.exports = {
-  "names": [ "MD043", "required-headings", "required-headers" ],
-  "description": "Required heading structure",
-  "tags": [ "headings", "headers" ],
-  "function": function MD043(params, onError) {
-    const requiredHeadings = params.config.headings || params.config.headers;
-    if (Array.isArray(requiredHeadings)) {
-      const levels = {};
-      [ 1, 2, 3, 4, 5, 6 ].forEach(function forLevel(level) {
-        levels["h" + level] = "######".substr(-level);
-      });
-      let i = 0;
-      let optional = false;
-      let errorCount = 0;
-      forEachHeading(params, function forHeading(heading, content) {
-        if (!errorCount) {
-          const actual = levels[heading.tag] + " " + content;
-          const expected = requiredHeadings[i++] || "[None]";
-          if (expected === "*") {
-            optional = true;
-          } else if (expected.toLowerCase() === actual.toLowerCase()) {
-            optional = false;
-          } else if (optional) {
-            i--;
-          } else {
-            addErrorDetailIf(onError, heading.lineNumber,
-              expected, actual);
-            errorCount++;
-          }
-        }
-      });
-      if ((i < requiredHeadings.length) && !errorCount) {
-        addErrorContext(onError, params.lines.length,
-          requiredHeadings[i]);
-      }
-    }
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorContext, addErrorDetailIf, forEachHeading } =
+  require("../helpers");
+
+module.exports = {
+  "names": [ "MD043", "required-headings", "required-headers" ],
+  "description": "Required heading structure",
+  "tags": [ "headings", "headers" ],
+  "function": function MD043(params, onError) {
+    const requiredHeadings = params.config.headings || params.config.headers;
+    if (Array.isArray(requiredHeadings)) {
+      const levels = {};
+      [ 1, 2, 3, 4, 5, 6 ].forEach(function forLevel(level) {
+        levels["h" + level] = "######".substr(-level);
+      });
+      let i = 0;
+      let optional = false;
+      let errorCount = 0;
+      forEachHeading(params, function forHeading(heading, content) {
+        if (!errorCount) {
+          const actual = levels[heading.tag] + " " + content;
+          const expected = requiredHeadings[i++] || "[None]";
+          if (expected === "*") {
+            optional = true;
+          } else if (expected.toLowerCase() === actual.toLowerCase()) {
+            optional = false;
+          } else if (optional) {
+            i--;
+          } else {
+            addErrorDetailIf(onError, heading.lineNumber,
+              expected, actual);
+            errorCount++;
+          }
+        }
+      });
+      if ((i < requiredHeadings.length) && !errorCount) {
+        addErrorContext(onError, params.lines.length,
+          requiredHeadings[i]);
+      }
+    }
+  }
+};

package/lib/md044.js

@@ -1,71 +1,94 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorDetailIf, bareUrlRe, escapeForRegExp, filterTokens,
-  forEachInlineChild, newLineRe } = require("../helpers");
-
-module.exports = {
-  "names": [ "MD044", "proper-names" ],
-  "description": "Proper names should have the correct capitalization",
-  "tags": [ "spelling" ],
-  "function": function MD044(params, onError) {
-    let names = params.config.names;
-    names = Array.isArray(names) ? names : [];
-    const codeBlocks = params.config.code_blocks;
-    const includeCodeBlocks = (codeBlocks === undefined) ? true : !!codeBlocks;
-    names.forEach((name) => {
-      const escapedName = escapeForRegExp(name);
-      const namePattern = "\\S*\\b(" + escapedName + ")\\b\\S*";
-      const anyNameRe = new RegExp(namePattern, "gi");
-      // eslint-disable-next-line jsdoc/require-jsdoc
-      function forToken(token) {
-        const fenceOffset = (token.type === "fence") ? 1 : 0;
-        token.content.split(newLineRe)
-          .forEach((line, index) => {
-            let match = null;
-            while ((match = anyNameRe.exec(line)) !== null) {
-              const fullMatch = match[0];
-              if (fullMatch.search(bareUrlRe) === -1) {
-                const wordMatch = fullMatch
-                  .replace(/^\W*/, "").replace(/\W*$/, "");
-                if (!names.includes(wordMatch)) {
-                  const lineNumber = token.lineNumber + index + fenceOffset;
-                  const fullLine = params.lines[lineNumber - 1];
-                  let matchIndex = match.index;
-                  const matchLength = wordMatch.length;
-                  const fullLineWord =
-                    fullLine.slice(matchIndex, matchIndex + matchLength);
-                  if (fullLineWord !== wordMatch) {
-                    // Attempt to fix bad offset due to inline content
-                    matchIndex = fullLine.indexOf(wordMatch);
-                  }
-                  const range = [ matchIndex + 1, matchLength ];
-                  addErrorDetailIf(
-                    onError,
-                    lineNumber,
-                    name,
-                    match[1],
-                    null,
-                    null,
-                    range,
-                    {
-                      "editColumn": matchIndex + 1,
-                      "deleteCount": matchLength,
-                      "insertText": name
-                    }
-                  );
-                }
-              }
-            }
-          });
-      }
-      forEachInlineChild(params, "text", forToken);
-      if (includeCodeBlocks) {
-        forEachInlineChild(params, "code_inline", forToken);
-        filterTokens(params, "code_block", forToken);
-        filterTokens(params, "fence", forToken);
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorDetailIf, bareUrlRe, escapeForRegExp, filterTokens,
+  forEachInlineChild, newLineRe } = require("../helpers");
+
+const startNonWordRe = /^\W/;
+const endNonWordRe = /\W$/;
+
+module.exports = {
+  "names": [ "MD044", "proper-names" ],
+  "description": "Proper names should have the correct capitalization",
+  "tags": [ "spelling" ],
+  "function": function MD044(params, onError) {
+    let names = params.config.names;
+    names = Array.isArray(names) ? names : [];
+    const codeBlocks = params.config.code_blocks;
+    const includeCodeBlocks = (codeBlocks === undefined) ? true : !!codeBlocks;
+    // Text of automatic hyperlinks is implicitly a URL
+    const autolinkText = new Set();
+    filterTokens(params, "inline", (token) => {
+      let inAutoLink = false;
+      token.children.forEach((child) => {
+        const { info, type } = child;
+        if ((type === "link_open") && (info === "auto")) {
+          inAutoLink = true;
+        } else if (type === "link_close") {
+          inAutoLink = false;
+        } else if ((type === "text") && inAutoLink) {
+          autolinkText.add(child);
+        }
+      });
+    });
+    // For each proper name...
+    names.forEach((name) => {
+      const escapedName = escapeForRegExp(name);
+      const startNamePattern = startNonWordRe.test(name) ? "" : "\\S*\\b";
+      const endNamePattern = endNonWordRe.test(name) ? "" : "\\b\\S*";
+      const namePattern =
+        `(${startNamePattern})(${escapedName})(${endNamePattern})`;
+      const anyNameRe = new RegExp(namePattern, "gi");
+      // eslint-disable-next-line jsdoc/require-jsdoc
+      function forToken(token) {
+        if (!autolinkText.has(token)) {
+          const fenceOffset = (token.type === "fence") ? 1 : 0;
+          token.content.split(newLineRe).forEach((line, index) => {
+            let match = null;
+            while ((match = anyNameRe.exec(line)) !== null) {
+              const [ fullMatch, leftMatch, nameMatch, rightMatch ] = match;
+              if (fullMatch.search(bareUrlRe) === -1) {
+                const wordMatch = fullMatch
+                  .replace(new RegExp(`^\\W{0,${leftMatch.length}}`), "")
+                  .replace(new RegExp(`\\W{0,${rightMatch.length}}$`), "");
+                if (!names.includes(wordMatch)) {
+                  const lineNumber = token.lineNumber + index + fenceOffset;
+                  const fullLine = params.lines[lineNumber - 1];
+                  const matchLength = wordMatch.length;
+                  const matchIndex = fullLine.indexOf(wordMatch);
+                  const range = (matchIndex === -1) ?
+                    null :
+                    [ matchIndex + 1, matchLength ];
+                  const fixInfo = (matchIndex === -1) ?
+                    null :
+                    {
+                      "editColumn": matchIndex + 1,
+                      "deleteCount": matchLength,
+                      "insertText": name
+                    };
+                  addErrorDetailIf(
+                    onError,
+                    lineNumber,
+                    name,
+                    nameMatch,
+                    null,
+                    null,
+                    range,
+                    fixInfo
+                  );
+                }
+              }
+            }
+          });
+        }
+      }
+      forEachInlineChild(params, "text", forToken);
+      if (includeCodeBlocks) {
+        forEachInlineChild(params, "code_inline", forToken);
+        filterTokens(params, "code_block", forToken);
+        filterTokens(params, "fence", forToken);
+      }
+    });
+  }
+};

package/lib/md045.js

@@ -1,18 +1,18 @@
-// @ts-check
-
-"use strict";
-
-const { addError, forEachInlineChild } = require("../helpers");
-
-module.exports = {
-  "names": [ "MD045", "no-alt-text" ],
-  "description": "Images should have alternate text (alt text)",
-  "tags": [ "accessibility", "images" ],
-  "function": function MD045(params, onError) {
-    forEachInlineChild(params, "image", function forToken(token) {
-      if (token.content === "") {
-        addError(onError, token.lineNumber);
-      }
-    });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addError, forEachInlineChild } = require("../helpers");
+
+module.exports = {
+  "names": [ "MD045", "no-alt-text" ],
+  "description": "Images should have alternate text (alt text)",
+  "tags": [ "accessibility", "images" ],
+  "function": function MD045(params, onError) {
+    forEachInlineChild(params, "image", function forToken(token) {
+      if (token.content === "") {
+        addError(onError, token.lineNumber);
+      }
+    });
+  }
+};

package/lib/md046.js

@@ -1,32 +1,32 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorDetailIf } = require("../helpers");
-
-const tokenTypeToStyle = {
-  "fence": "fenced",
-  "code_block": "indented"
-};
-
-module.exports = {
-  "names": [ "MD046", "code-block-style" ],
-  "description": "Code block style",
-  "tags": [ "code" ],
-  "function": function MD046(params, onError) {
-    let expectedStyle = String(params.config.style || "consistent");
-    params.tokens
-      .filter((token) => token.type === "code_block" || token.type === "fence")
-      .forEach((token) => {
-        const { lineNumber, type } = token;
-        if (expectedStyle === "consistent") {
-          expectedStyle = tokenTypeToStyle[type];
-        }
-        addErrorDetailIf(
-          onError,
-          lineNumber,
-          expectedStyle,
-          tokenTypeToStyle[type]);
-      });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorDetailIf } = require("../helpers");
+
+const tokenTypeToStyle = {
+  "fence": "fenced",
+  "code_block": "indented"
+};
+
+module.exports = {
+  "names": [ "MD046", "code-block-style" ],
+  "description": "Code block style",
+  "tags": [ "code" ],
+  "function": function MD046(params, onError) {
+    let expectedStyle = String(params.config.style || "consistent");
+    params.tokens
+      .filter((token) => token.type === "code_block" || token.type === "fence")
+      .forEach((token) => {
+        const { lineNumber, type } = token;
+        if (expectedStyle === "consistent") {
+          expectedStyle = tokenTypeToStyle[type];
+        }
+        addErrorDetailIf(
+          onError,
+          lineNumber,
+          expectedStyle,
+          tokenTypeToStyle[type]);
+      });
+  }
+};

package/lib/md047.js

@@ -1,28 +1,28 @@
-// @ts-check
-
-"use strict";
-
-const { addError, isBlankLine } = require("../helpers");
-
-module.exports = {
-  "names": [ "MD047", "single-trailing-newline" ],
-  "description": "Files should end with a single newline character",
-  "tags": [ "blank_lines" ],
-  "function": function MD047(params, onError) {
-    const lastLineNumber = params.lines.length;
-    const lastLine = params.lines[lastLineNumber - 1];
-    if (!isBlankLine(lastLine)) {
-      addError(
-        onError,
-        lastLineNumber,
-        null,
-        null,
-        [ lastLine.length, 1 ],
-        {
-          "insertText": "\n",
-          "editColumn": lastLine.length + 1
-        }
-      );
-    }
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addError, isBlankLine } = require("../helpers");
+
+module.exports = {
+  "names": [ "MD047", "single-trailing-newline" ],
+  "description": "Files should end with a single newline character",
+  "tags": [ "blank_lines" ],
+  "function": function MD047(params, onError) {
+    const lastLineNumber = params.lines.length;
+    const lastLine = params.lines[lastLineNumber - 1];
+    if (!isBlankLine(lastLine)) {
+      addError(
+        onError,
+        lastLineNumber,
+        null,
+        null,
+        [ lastLine.length, 1 ],
+        {
+          "insertText": "\n",
+          "editColumn": lastLine.length + 1
+        }
+      );
+    }
+  }
+};

package/lib/md048.js

@@ -1,29 +1,29 @@
-// @ts-check
-
-"use strict";
-
-const { addErrorDetailIf, fencedCodeBlockStyleFor } = require("../helpers");
-
-module.exports = {
-  "names": [ "MD048", "code-fence-style" ],
-  "description": "Code fence style",
-  "tags": [ "code" ],
-  "function": function MD048(params, onError) {
-    const style = String(params.config.style || "consistent");
-    let expectedStyle = style;
-    params.tokens
-      .filter((token) => token.type === "fence")
-      .forEach((fenceToken) => {
-        const { lineNumber, markup } = fenceToken;
-        if (expectedStyle === "consistent") {
-          expectedStyle = fencedCodeBlockStyleFor(markup);
-        }
-        addErrorDetailIf(
-          onError,
-          lineNumber,
-          expectedStyle,
-          fencedCodeBlockStyleFor(markup)
-        );
-      });
-  }
-};
+// @ts-check
+
+"use strict";
+
+const { addErrorDetailIf, fencedCodeBlockStyleFor } = require("../helpers");
+
+module.exports = {
+  "names": [ "MD048", "code-fence-style" ],
+  "description": "Code fence style",
+  "tags": [ "code" ],
+  "function": function MD048(params, onError) {
+    const style = String(params.config.style || "consistent");
+    let expectedStyle = style;
+    params.tokens
+      .filter((token) => token.type === "fence")
+      .forEach((fenceToken) => {
+        const { lineNumber, markup } = fenceToken;
+        if (expectedStyle === "consistent") {
+          expectedStyle = fencedCodeBlockStyleFor(markup);
+        }
+        addErrorDetailIf(
+          onError,
+          lineNumber,
+          expectedStyle,
+          fencedCodeBlockStyleFor(markup)
+        );
+      });
+  }
+};