markdownlint 0.23.1 → 0.24.0

package/lib/md011.js

@@ -2,40 +2,44 @@
 
 "use strict";
 
-const { addError, forEachInlineChild, unescapeMarkdown } =
-  require("../helpers");
+const { addError, forEachLine, overlapsAnyRange } = require("../helpers");
+const { inlineCodeSpanRanges, lineMetadata } = require("./cache");
 
-const reversedLinkRe = /\(([^)]+)\)\[([^\]^][^\]]*)]/g;
+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
-        );
+    const exclusions = inlineCodeSpanRanges();
+    forEachLine(lineMetadata(), (line, lineIndex, inCode, onFence) => {
+      if (!inCode && !onFence) {
+        let match = null;
+        while ((match = reversedLinkRe.exec(line)) !== null) {
+          const [ reversedLink, preChar, linkText, linkDestination ] = match;
+          const index = match.index + preChar.length;
+          const length = match[0].length - preChar.length;
+          if (
+            !linkText.endsWith("\\") &&
+            !linkDestination.endsWith("\\") &&
+            !overlapsAnyRange(exclusions, lineIndex, index, length)
+          ) {
+            addError(
+              onError,
+              lineIndex + 1,
+              reversedLink.slice(preChar.length),
+              null,
+              [ index + 1, length ],
+              {
+                "editColumn": index + 1,
+                "deleteCount": length,
+                "insertText": `[${linkText}](${linkDestination})`
+              }
+            );
+          }
+        }
       }
     });
   }

package/lib/md037.js

@@ -78,11 +78,23 @@ module.exports = {
       lineMetadata(),
       (line, lineIndex, inCode, onFence, inTable, inItem, onBreak, inMath) => {
         const onItemStart = (inItem === 1);
-        if (inCode || inTable || onBreak || onItemStart || isBlankLine(line)) {
+        if (
+          inCode ||
+          onFence ||
+          inTable ||
+          onBreak ||
+          onItemStart ||
+          isBlankLine(line)
+        ) {
           // Emphasis resets when leaving a block
           resetRunTracking();
         }
-        if (inCode || onBreak || inMath) {
+        if (
+          inCode ||
+          onFence ||
+          onBreak ||
+          inMath
+        ) {
           // Emphasis has no meaning here
           return;
         }

package/lib/md043.js

@@ -28,8 +28,11 @@ module.exports = {
           const actual = levels[heading.tag] + " " + content;
           const expected = getExpected();
           if (expected === "*") {
-            matchAny = true;
-            getExpected();
+            const nextExpected = getExpected();
+            if (nextExpected.toLowerCase() !== actual.toLowerCase()) {
+              matchAny = true;
+              i--;
+            }
           } else if (expected === "+") {
             matchAny = true;
           } else if (expected.toLowerCase() === actual.toLowerCase()) {
@@ -43,9 +46,11 @@ module.exports = {
           }
         }
       });
+      const extraHeadings = requiredHeadings.length - i;
       if (
         !hasError &&
-        (i < requiredHeadings.length) &&
+        ((extraHeadings > 1) ||
+          ((extraHeadings === 1) && (requiredHeadings[i] !== "*"))) &&
         (anyHeadings || !requiredHeadings.every((heading) => heading === "*"))
       ) {
         addErrorContext(onError, params.lines.length,

package/lib/md044.js

@@ -2,11 +2,9 @@
 
 "use strict";
 
-const { addErrorDetailIf, bareUrlRe, escapeForRegExp, filterTokens,
-  forEachInlineChild, newLineRe } = require("../helpers");
-
-const startNonWordRe = /^\W/;
-const endNonWordRe = /\W$/;
+const { addErrorDetailIf, bareUrlRe, escapeForRegExp, forEachLine,
+  overlapsAnyRange, linkRe, linkReferenceRe } = require("../helpers");
+const { inlineCodeSpanRanges, lineMetadata } = require("./cache");
 
 module.exports = {
   "names": [ "MD044", "proper-names" ],
@@ -15,80 +13,65 @@ module.exports = {
   "function": function MD044(params, onError) {
     let names = params.config.names;
     names = Array.isArray(names) ? names : [];
+    names.sort((a, b) => (b.length - a.length) || a.localeCompare(b));
     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);
+    const exclusions = [];
+    forEachLine(lineMetadata(), (line, lineIndex) => {
+      if (linkReferenceRe.test(line)) {
+        exclusions.push([ lineIndex, 0, line.length ]);
+      } else {
+        let match = null;
+        while ((match = bareUrlRe.exec(line)) !== null) {
+          exclusions.push([ lineIndex, match.index, match[0].length ]);
         }
-      });
+        while ((match = linkRe.exec(line)) !== null) {
+          const [ , text, destination ] = match;
+          if (destination) {
+            exclusions.push(
+              [ lineIndex, match.index + text.length, destination.length ]
+            );
+          }
+        }
+      }
     });
-    // For each proper name...
-    names.forEach((name) => {
+    if (!includeCodeBlocks) {
+      exclusions.push(...inlineCodeSpanRanges());
+    }
+    for (const name of names) {
       const escapedName = escapeForRegExp(name);
-      const startNamePattern = startNonWordRe.test(name) ? "" : "\\S*\\b";
-      const endNamePattern = endNonWordRe.test(name) ? "" : "\\b\\S*";
+      const startNamePattern = /^\W/.test(name) ? "" : "\\b_*";
+      const endNamePattern = /\W$/.test(name) ? "" : "_*\\b";
       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
-                  );
+        `(${startNamePattern})(${escapedName})${endNamePattern}`;
+      const nameRe = new RegExp(namePattern, "gi");
+      forEachLine(lineMetadata(), (line, lineIndex, inCode, onFence) => {
+        if (includeCodeBlocks || (!inCode && !onFence)) {
+          let match = null;
+          while ((match = nameRe.exec(line)) !== null) {
+            const [ , leftMatch, nameMatch ] = match;
+            const index = match.index + leftMatch.length;
+            const length = nameMatch.length;
+            if (!overlapsAnyRange(exclusions, lineIndex, index, length)) {
+              addErrorDetailIf(
+                onError,
+                lineIndex + 1,
+                name,
+                nameMatch,
+                null,
+                null,
+                [ index + 1, length ],
+                {
+                  "editColumn": index + 1,
+                  "deleteCount": length,
+                  "insertText": name
                 }
-              }
+              );
             }
-          });
+            exclusions.push([ lineIndex, index, length ]);
+          }
         }
-      }
-      forEachInlineChild(params, "text", forToken);
-      if (includeCodeBlocks) {
-        forEachInlineChild(params, "code_inline", forToken);
-        filterTokens(params, "code_block", forToken);
-        filterTokens(params, "fence", forToken);
-      }
-    });
+      });
+    }
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint",
-  "version": "0.23.1",
+  "version": "0.24.0",
   "description": "A Node.js style checker and lint tool for Markdown/CommonMark files.",
   "main": "lib/markdownlint.js",
   "types": "lib/markdownlint.d.ts",
@@ -21,8 +21,16 @@
     "build-example": "npm install --no-save --ignore-scripts grunt grunt-cli gulp through2",
     "ci": "npm-run-all --continue-on-error --parallel test-cover lint declaration build-config build-demo && git diff --exit-code",
     "clean-test-repos": "rimraf test-repos",
-    "clone-test-repos": "mkdir test-repos && cd test-repos && git clone https://github.com/eslint/eslint eslint-eslint --depth 1 --no-tags --quiet && git clone https://github.com/mkdocs/mkdocs mkdocs-mkdocs --depth 1 --no-tags --quiet && git clone https://github.com/pi-hole/docs pi-hole-docs --depth 1 --no-tags --quiet",
-    "clone-test-repos-large": "npm run clone-test-repos && cd test-repos && git clone https://github.com/dotnet/docs dotnet-docs --depth 1 --no-tags --quiet",
+    "clone-test-repos-dotnet-docs": "cd test-repos && git clone https://github.com/dotnet/docs dotnet-docs --depth 1 --no-tags --quiet",
+    "clone-test-repos-eslint-eslint": "cd test-repos && git clone https://github.com/eslint/eslint eslint-eslint --depth 1 --no-tags --quiet",
+    "clone-test-repos-mkdocs-mkdocs": "cd test-repos && git clone https://github.com/mkdocs/mkdocs mkdocs-mkdocs --depth 1 --no-tags --quiet",
+    "clone-test-repos-mochajs-mocha": "cd test-repos && git clone https://github.com/mochajs/mocha mochajs-mocha --depth 1 --no-tags --quiet",
+    "clone-test-repos-pi-hole-docs": "cd test-repos && git clone https://github.com/pi-hole/docs pi-hole-docs --depth 1 --no-tags --quiet",
+    "clone-test-repos-v8-v8-dev": "cd test-repos && git clone https://github.com/v8/v8.dev v8-v8-dev --depth 1 --no-tags --quiet",
+    "clone-test-repos-webhintio-hint": "cd test-repos && git clone https://github.com/webhintio/hint webhintio-hint --depth 1 --no-tags --quiet",
+    "clone-test-repos-webpack-webpack-js-org": "cd test-repos && git clone https://github.com/webpack/webpack.js.org webpack-webpack-js-org --depth 1 --no-tags --quiet",
+    "clone-test-repos": "mkdir test-repos && cd test-repos && npm run clone-test-repos-eslint-eslint && npm run clone-test-repos-mkdocs-mkdocs && npm run clone-test-repos-mochajs-mocha && npm run clone-test-repos-pi-hole-docs && npm run clone-test-repos-webhintio-hint && npm run clone-test-repos-webpack-webpack-js-org",
+    "clone-test-repos-large": "npm run clone-test-repos && cd test-repos && npm run clone-test-repos-dotnet-docs && npm run clone-test-repos-v8-v8-dev",
     "declaration": "npm run build-declaration && npm run test-declaration",
     "example": "cd example && node standalone.js && grunt markdownlint --force && gulp markdownlint",
     "lint": "eslint --max-warnings 0 .",
@@ -36,32 +44,32 @@
     "node": ">=10"
   },
   "dependencies": {
-    "markdown-it": "12.0.4"
+    "markdown-it": "12.2.0"
   },
   "devDependencies": {
     "ava": "~3.15.0",
-    "c8": "~7.5.0",
+    "c8": "~7.8.0",
     "cpy-cli": "~3.1.1",
-    "eslint": "~7.19.0",
-    "eslint-plugin-jsdoc": "~31.6.0",
+    "eslint": "~7.32.0",
+    "eslint-plugin-jsdoc": "~36.0.7",
     "eslint-plugin-node": "~11.1.0",
-    "eslint-plugin-unicorn": "~27.0.0",
-    "globby": "~11.0.2",
-    "js-yaml": "~4.0.0",
+    "eslint-plugin-unicorn": "~35.0.0",
+    "globby": "~11.0.4",
+    "js-yaml": "~4.1.0",
     "markdown-it-for-inline": "~0.1.1",
     "markdown-it-sub": "~1.0.0",
     "markdown-it-sup": "~1.0.0",
-    "markdown-it-texmath": "~0.8.0",
-    "markdownlint-rule-helpers": "~0.13.0",
+    "markdown-it-texmath": "~0.9.1",
+    "markdownlint-rule-helpers": "~0.14.0",
     "npm-run-all": "~4.1.5",
     "rimraf": "~3.0.2",
     "strip-json-comments": "~3.1.1",
     "toml": "~3.0.0",
-    "ts-loader": "~8.0.15",
+    "ts-loader": "~9.2.5",
     "tv4": "~1.3.0",
-    "typescript": "~4.1.3",
-    "webpack": "~5.21.1",
-    "webpack-cli": "~4.5.0"
+    "typescript": "~4.3.5",
+    "webpack": "~5.51.1",
+    "webpack-cli": "~4.8.0"
   },
   "keywords": [
     "markdown",

package/schema/.markdownlint.jsonc

@@ -55,7 +55,9 @@
   // MD010/no-hard-tabs - Hard tabs
   "MD010": {
     // Include code blocks
-    "code_blocks": true
+    "code_blocks": true,
+    // Number of spaces for each hard tab
+    "spaces_per_tab": 1
   },
 
   // MD011/no-reversed-links - Reversed link syntax
@@ -244,7 +246,7 @@
 
   // MD048/code-fence-style - Code fence style
   "MD048": {
-    // Code fence syle
+    // Code fence style
     "style": "consistent"
   }
 }

package/schema/.markdownlint.yaml

@@ -50,6 +50,8 @@ MD009:
 MD010:
   # Include code blocks
   code_blocks: true
+  # Number of spaces for each hard tab
+  spaces_per_tab: 1
 
 # MD011/no-reversed-links - Reversed link syntax
 MD011: true
@@ -221,5 +223,5 @@ MD047: true
 
 # MD048/code-fence-style - Code fence style
 MD048:
-  # Code fence syle
+  # Code fence style
   style: "consistent"

package/schema/markdownlint-config-schema.json

@@ -327,6 +327,11 @@
           "description": "Include code blocks",
           "type": "boolean",
           "default": true
+        },
+        "spaces_per_tab": {
+          "description": "Number of spaces for each hard tab",
+          "type": "number",
+          "default": 1
         }
       },
       "additionalProperties": false
@@ -343,6 +348,11 @@
           "description": "Include code blocks",
           "type": "boolean",
           "default": true
+        },
+        "spaces_per_tab": {
+          "description": "Number of spaces for each hard tab",
+          "type": "number",
+          "default": 1
         }
       },
       "additionalProperties": false
@@ -1396,7 +1406,7 @@
       "default": true,
       "properties": {
         "style": {
-          "description": "Code fence syle",
+          "description": "Code fence style",
           "type": "string",
           "enum": [
             "consistent",
@@ -1417,7 +1427,7 @@
       "default": true,
       "properties": {
         "style": {
-          "description": "Code fence syle",
+          "description": "Code fence style",
           "type": "string",
           "enum": [
             "consistent",
@@ -1551,7 +1561,7 @@
     }
   },
   "additionalProperties": {
-    "type:": [
+    "type": [
       "boolean",
       "object"
     ]