markdownlint 0.32.0 → 0.33.0

package/lib/constants.js

@@ -11,4 +11,4 @@ module.exports.fixableRuleNames = [
   "MD047", "MD049", "MD050", "MD051", "MD053", "MD054"
 ];
 module.exports.homepage = "https://github.com/DavidAnson/markdownlint";
-module.exports.version = "0.32.0";
+module.exports.version = "0.33.0";

package/lib/markdownlint.js

@@ -1177,7 +1177,6 @@ function readConfig(file, parsers, fs, callback) {
   }
   // Read file
   file = helpers.expandTildePath(file, require("node:os"));
-  // eslint-disable-next-line n/prefer-promises/fs
   fs.readFile(file, "utf8", (err, content) => {
     if (err) {
       // @ts-ignore

package/lib/md005.js

@@ -23,8 +23,7 @@ module.exports = {
       for (const listItemPrefix of listItemPrefixes) {
         const lineNumber = listItemPrefix.startLine;
         const actualIndent = listItemPrefix.startColumn - 1;
-        const markerLength = listItemPrefix.text.trim().length;
-        const range = [ 1, listItemPrefix.startColumn + markerLength ];
+        const range = [ 1, listItemPrefix.endColumn - 1 ];
         if (list.type === "listUnordered") {
           addErrorDetailIf(
             onError,
@@ -37,7 +36,8 @@ module.exports = {
             // No fixInfo; MD007 handles this scenario better
           );
         } else {
-          const actualEnd = range[1] - 1;
+          const markerLength = listItemPrefix.text.trim().length;
+          const actualEnd = listItemPrefix.startColumn + markerLength - 1;
           expectedEnd = expectedEnd || actualEnd;
           if ((expectedIndent !== actualIndent) || endMatching) {
             if (expectedEnd === actualEnd) {

package/lib/md007.js

@@ -30,7 +30,7 @@ module.exports = {
       unorderedListTypes
     );
     for (const token of tokens) {
-      const { parent, startColumn, startLine, type } = token;
+      const { endColumn, parent, startColumn, startLine, type } = token;
       if (type === "blockQuotePrefix") {
         lastBlockQuotePrefix = token;
       } else if (type === "listUnordered") {
@@ -42,6 +42,7 @@ module.exports = {
         ) {
           if (current.type === "listUnordered") {
             nesting++;
+            // eslint-disable-next-line no-continue
             continue;
           } else if (current.type === "listOrdered") {
             nesting = -1;
@@ -63,7 +64,7 @@ module.exports = {
               (lastBlockQuotePrefix.endColumn - 1) :
               0;
           const actualIndent = startColumn - 1 - blockQuoteAdjustment;
-          const range = [ 1, startColumn + 1 ];
+          const range = [ 1, endColumn - 1 ];
           const fixInfo = {
             "editColumn": startColumn - actualIndent,
             "deleteCount": Math.max(actualIndent - expectedIndent, 0),

package/lib/md024.js

@@ -9,8 +9,7 @@ module.exports = {
   "description": "Multiple headings with the same content",
   "tags": [ "headings" ],
   "function": function MD024(params, onError) {
-    const siblingsOnly = !!params.config.siblings_only ||
-      !!params.config.allow_different_nesting || false;
+    const siblingsOnly = !!params.config.siblings_only || false;
     const knownContents = [ null, [] ];
     let lastLevel = 1;
     let knownContent = knownContents[lastLevel];
@@ -27,10 +26,15 @@ module.exports = {
         }
         knownContent = knownContents[newLevel];
       }
+      // @ts-ignore
       if (knownContent.includes(content)) {
-        addErrorContext(onError, heading.lineNumber,
-          heading.line.trim());
+        addErrorContext(
+          onError,
+          heading.lineNumber,
+          heading.line.trim()
+        );
       } else {
+        // @ts-ignore
         knownContent.push(content);
       }
     });

package/lib/md026.js

@@ -23,7 +23,7 @@ module.exports = {
       [ "atxHeadingText", "setextHeadingText" ]
     );
     for (const heading of headings) {
-      const { endLine, startColumn, text } = heading;
+      const { endColumn, endLine, text } = heading;
       const match = trailingPunctuationRe.exec(text);
       if (
         match &&
@@ -31,8 +31,8 @@ module.exports = {
         !endOfLineGemojiCodeRe.test(text)
       ) {
         const fullMatch = match[0];
-        const column = startColumn + match.index;
         const length = fullMatch.length;
+        const column = endColumn - length;
         addError(
           onError,
           endLine,

package/lib/md038.js

@@ -41,7 +41,7 @@ module.exports = {
         tokenIfType(children[last - 2], "codeTextData");
       if (startSequence && endSequence && startData && endData) {
         const spaceLeft = leftSpaceRe.test(startData.text);
-        const spaceRight = !spaceLeft && rightSpaceRe.test(endData.text);
+        const spaceRight = rightSpaceRe.test(endData.text);
         if (spaceLeft || spaceRight) {
           let lineNumber = startSequence.startLine;
           let range = null;
@@ -56,7 +56,7 @@ module.exports = {
               "deleteCount": endSequence.startColumn - startSequence.endColumn,
               "insertText": trimCodeText(startData.text, true, true)
             };
-          } else if (spaceLeft) {
+          } else if (spaceLeft && (startSequence.endLine === startData.startLine)) {
             range = [
               startSequence.startColumn,
               startData.endColumn - startSequence.startColumn
@@ -66,7 +66,7 @@ module.exports = {
               "deleteCount": startData.endColumn - startData.startColumn,
               "insertText": trimCodeText(startData.text, true, false)
             };
-          } else {
+          } else if (spaceRight && (endData.text.trim().length > 0)) {
             lineNumber = endSequence.endLine;
             range = [
               endData.startColumn,
@@ -78,18 +78,20 @@ module.exports = {
               "insertText": trimCodeText(endData.text, false, true)
             };
           }
-          const context = params
-            .lines[lineNumber - 1]
-            .substring(range[0] - 1, range[0] - 1 + range[1]);
-          addErrorContext(
-            onError,
-            lineNumber,
-            context,
-            spaceLeft,
-            spaceRight,
-            range,
-            fixInfo
-          );
+          if (range) {
+            const context = params
+              .lines[lineNumber - 1]
+              .substring(range[0] - 1, range[0] - 1 + range[1]);
+            addErrorContext(
+              onError,
+              lineNumber,
+              context,
+              spaceLeft,
+              spaceRight,
+              range,
+              fixInfo
+            );
+          }
         }
       }
     }

package/lib/md054.js

@@ -64,7 +64,14 @@ module.exports = {
         if (destination) {
           // link kind is an inline link
           const title = getTokenTextByType(descendents, "resourceTitleString");
-          isError = !inline || (!urlInline && autolink && !title && !image);
+          isError = !inline || (
+            !urlInline &&
+            autolink &&
+            !image &&
+            !title &&
+            (label === destination) &&
+            autolinkAble(destination)
+          );
         } else {
           // link kind is a full/collapsed/shortcut reference link
           const isShortcut = !children.some((t) => t.type === "reference");

package/lib/md055.js

@@ -0,0 +1,72 @@
+// @ts-check
+
+"use strict";
+
+const { addErrorDetailIf } = require("../helpers");
+const { filterByTypes } = require("../helpers/micromark.cjs");
+
+const whitespaceTypes = new Set([ "linePrefix", "whitespace" ]);
+const ignoreWhitespace = (tokens) => tokens.filter(
+  (token) => !whitespaceTypes.has(token.type)
+);
+const firstOrNothing = (items) => items[0];
+const lastOrNothing = (items) => items[items.length - 1];
+const makeRange = (start, end) => [ start, end - start + 1 ];
+
+module.exports = {
+  "names": [ "MD055", "table-pipe-style" ],
+  "description": "Table pipe style",
+  "tags": [ "table" ],
+  "function": function MD055(params, onError) {
+    const style = String(params.config.style || "consistent");
+    let expectedStyle = style;
+    let expectedLeadingPipe =
+      ((expectedStyle !== "no_leading_or_trailing") && (expectedStyle !== "trailing_only"));
+    let expectedTrailingPipe =
+      ((expectedStyle !== "no_leading_or_trailing") && (expectedStyle !== "leading_only"));
+    const tables = filterByTypes(params.parsers.micromark.tokens, [ "table" ]);
+    for (const table of tables) {
+      const rows = filterByTypes(table.children, [ "tableDelimiterRow", "tableRow" ]);
+      for (const row of rows) {
+        // The following uses of first/lastOrNothing lack fallback handling
+        // because it seems not to be possible (i.e., 0% coverage)
+        const firstCell = firstOrNothing(row.children);
+        const leadingToken = firstOrNothing(ignoreWhitespace(firstCell.children));
+        const actualLeadingPipe = (leadingToken.type === "tableCellDivider");
+        const lastCell = lastOrNothing(row.children);
+        const trailingToken = lastOrNothing(ignoreWhitespace(lastCell.children));
+        const actualTrailingPipe = (trailingToken.type === "tableCellDivider");
+        const actualStyle = actualLeadingPipe ?
+          (actualTrailingPipe ? "leading_and_trailing" : "leading_only") :
+          (actualTrailingPipe ? "trailing_only" : "no_leading_or_trailing");
+        if (expectedStyle === "consistent") {
+          expectedStyle = actualStyle;
+          expectedLeadingPipe = actualLeadingPipe;
+          expectedTrailingPipe = actualTrailingPipe;
+        }
+        if (actualLeadingPipe !== expectedLeadingPipe) {
+          addErrorDetailIf(
+            onError,
+            firstCell.startLine,
+            expectedStyle,
+            actualStyle,
+            `${expectedLeadingPipe ? "Missing" : "Unexpected"} leading pipe`,
+            undefined,
+            makeRange(row.startColumn, firstCell.startColumn)
+          );
+        }
+        if (actualTrailingPipe !== expectedTrailingPipe) {
+          addErrorDetailIf(
+            onError,
+            lastCell.endLine,
+            expectedStyle,
+            actualStyle,
+            `${expectedTrailingPipe ? "Missing" : "Unexpected"} trailing pipe`,
+            undefined,
+            makeRange(lastCell.endColumn - 1, row.endColumn - 1)
+          );
+        }
+      }
+    }
+  }
+}

package/lib/md056.js

@@ -0,0 +1,44 @@
+// @ts-check
+
+"use strict";
+
+const { addErrorDetailIf } = require("../helpers");
+const { filterByTypes } = require("../helpers/micromark.cjs");
+
+const makeRange = (start, end) => [ start, end - start + 1 ];
+
+module.exports = {
+  "names": [ "MD056", "table-column-count" ],
+  "description": "Table column count",
+  "tags": [ "table" ],
+  "function": function MD056(params, onError) {
+    const tables = filterByTypes(params.parsers.micromark.tokens, [ "table" ]);
+    for (const table of tables) {
+      const rows = filterByTypes(table.children, [ "tableDelimiterRow", "tableRow" ]);
+      let expectedCount = 0;
+      for (const row of rows) {
+        const cells = filterByTypes(row.children, [ "tableData", "tableDelimiter", "tableHeader" ]);
+        const actualCount = cells.length;
+        expectedCount ||= actualCount;
+        let detail = null;
+        let range = null;
+        if (actualCount < expectedCount) {
+          detail = "Too few cells, row will be missing data";
+          range = [ row.endColumn - 1, 1 ];
+        } else if (expectedCount < actualCount) {
+          detail = "Too many cells, extra data will be missing";
+          range = makeRange(cells[expectedCount].startColumn, row.endColumn - 1);
+        }
+        addErrorDetailIf(
+          onError,
+          row.endLine,
+          expectedCount,
+          actualCount,
+          detail,
+          null,
+          range
+        );
+      }
+    }
+  }
+}

package/lib/rules.js

@@ -6,9 +6,11 @@ const { homepage, version } = require("./constants");
 
 const rules = [
   require("./md001"),
+  // md002: Deprecated and removed
   require("./md003"),
   require("./md004"),
   require("./md005"),
+  // md006: Deprecated and removed
   require("./md007"),
   require("./md009"),
   require("./md010"),
@@ -51,9 +53,9 @@ const rules = [
   require("./md051"),
   require("./md052"),
   require("./md053"),
-  require("./md054")
-  // md055: See https://github.com/markdownlint/markdownlint
-  // md056: See https://github.com/markdownlint/markdownlint
+  require("./md054"),
+  require("./md055"),
+  require("./md056")
   // md057: See https://github.com/markdownlint/markdownlint
 ];
 for (const rule of rules) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint",
-  "version": "0.32.0",
+  "version": "0.33.0",
   "description": "A Node.js style checker and lint tool for Markdown/CommonMark files.",
   "type": "commonjs",
   "main": "./lib/markdownlint.js",
@@ -48,53 +48,52 @@
     "example": "cd example && node standalone.js && grunt markdownlint --force && gulp markdownlint",
     "docker-npm-install": "docker run --rm --tty --name npm-install --volume $PWD:/home/workdir --workdir /home/workdir --user node node:latest npm install",
     "docker-npm-run-upgrade": "docker run --rm --tty --name npm-run-upgrade --volume $PWD:/home/workdir --workdir /home/workdir --user node node:latest npm run upgrade",
-    "install-micromark": "cd micromark && npm install --no-package-lock",
+    "install-micromark": "cd micromark && npm install",
     "lint": "eslint --ext .js,.cjs,.mjs --max-warnings 0 .",
-    "lint-test-repos": "ava --timeout=10m test/markdownlint-test-repos.js",
+    "lint-test-repos": "ava --timeout=10m test/markdownlint-test-repos-*.js",
     "serial-config-docs": "npm run build-config && npm run build-docs",
     "serial-declaration-demo": "npm run build-declaration && npm-run-all --continue-on-error --parallel build-demo test-declaration",
     "test": "ava --timeout=30s test/markdownlint-test.js test/markdownlint-test-config.js test/markdownlint-test-custom-rules.js test/markdownlint-test-helpers.js test/markdownlint-test-micromark.mjs test/markdownlint-test-result-object.js test/markdownlint-test-scenarios.js",
     "test-cover": "c8 --100 npm test",
     "test-declaration": "cd example/typescript && tsc && node type-check.js",
-    "test-extra": "ava --timeout=5m test/markdownlint-test-extra-parse.js test/markdownlint-test-extra-type.js",
+    "test-extra": "ava --timeout=10m test/markdownlint-test-extra-parse.js test/markdownlint-test-extra-type.js",
     "update-snapshots": "ava --update-snapshots test/markdownlint-test-micromark.mjs test/markdownlint-test-scenarios.js",
-    "update-snapshots-test-repos": "ava --timeout=10m --update-snapshots test/markdownlint-test-repos.js",
+    "update-snapshots-test-repos": "ava --timeout=10m --update-snapshots test/markdownlint-test-repos-*.js",
     "upgrade": "npx --yes npm-check-updates --upgrade"
   },
   "engines": {
     "node": ">=18"
   },
   "dependencies": {
-    "markdown-it": "13.0.2",
-    "markdownlint-micromark": "0.1.7"
+    "markdown-it": "14.0.0",
+    "markdownlint-micromark": "0.1.8"
   },
   "devDependencies": {
-    "@babel/core": "7.23.3",
-    "@babel/preset-env": "7.23.3",
-    "@hyperjump/json-schema": "1.6.5",
-    "ava": "5.3.1",
+    "@babel/core": "7.23.7",
+    "@babel/preset-env": "7.23.7",
+    "ajv": "8.12.0",
+    "ava": "6.0.1",
     "babel-loader": "9.1.3",
-    "c8": "8.0.1",
+    "c8": "9.0.0",
     "character-entities": "2.0.2",
-    "eslint": "8.53.0",
-    "eslint-plugin-es": "4.1.0",
-    "eslint-plugin-jsdoc": "46.9.0",
-    "eslint-plugin-n": "16.3.1",
-    "eslint-plugin-regexp": "2.1.1",
-    "eslint-plugin-unicorn": "49.0.0",
+    "eslint": "8.56.0",
+    "eslint-plugin-jsdoc": "48.0.2",
+    "eslint-plugin-n": "16.6.1",
+    "eslint-plugin-regexp": "2.1.2",
+    "eslint-plugin-unicorn": "50.0.1",
     "gemoji": "8.1.0",
     "globby": "14.0.0",
     "js-yaml": "4.1.0",
     "json-schema-to-typescript": "13.1.1",
-    "markdown-it-for-inline": "0.1.1",
-    "markdown-it-sub": "1.0.0",
-    "markdown-it-sup": "1.0.0",
-    "markdownlint-rule-helpers": "0.22.0",
+    "markdown-it-for-inline": "2.0.1",
+    "markdown-it-sub": "2.0.0",
+    "markdown-it-sup": "2.0.0",
+    "markdownlint-rule-helpers": "0.23.0",
     "npm-run-all": "4.1.5",
     "strip-json-comments": "5.0.1",
-    "terser-webpack-plugin": "5.3.9",
+    "terser-webpack-plugin": "5.3.10",
     "toml": "3.0.0",
-    "typescript": "5.2.2",
+    "typescript": "5.3.3",
     "webpack": "5.89.0",
     "webpack-cli": "5.1.4",
     "yaml": "2.3.4"