markdownlint 0.39.0 → 0.40.0

package/lib/constants.mjs

@@ -11,4 +11,4 @@ export const fixableRuleNames = [
   "MD054", "MD058"
 ];
 export const homepage = "https://github.com/DavidAnson/markdownlint";
-export const version = "0.39.0";
+export const version = "0.40.0";

package/lib/md011.mjs

@@ -4,6 +4,8 @@ import { addError, hasOverlap } from "../helpers/helpers.cjs";
 import { addRangeToSet } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
 
+/** @typedef {import("micromark-extension-math")} */
+
 const reversedLinkRe = /(^|[^\\])\(([^()]+)\)\[([^\]^][^\]]*)\](?!\()/g;
 
 /** @type {import("markdownlint").Rule} */
@@ -13,14 +15,14 @@ export default {
   "tags": [ "links" ],
   "parser": "micromark",
   "function": function MD011(params, onError) {
-    const codeBlockLineNumbers = new Set();
-    for (const codeBlock of filterByTypesCached([ "codeFenced", "codeIndented" ])) {
-      addRangeToSet(codeBlockLineNumbers, codeBlock.startLine, codeBlock.endLine);
+    const ignoreBlockLineNumbers = new Set();
+    for (const ignoreBlock of filterByTypesCached([ "codeFenced", "codeIndented", "mathFlow" ])) {
+      addRangeToSet(ignoreBlockLineNumbers, ignoreBlock.startLine, ignoreBlock.endLine);
     }
-    const codeTexts = filterByTypesCached([ "codeText" ]);
+    const ignoreTexts = filterByTypesCached([ "codeText", "mathText" ]);
     for (const [ lineIndex, line ] of params.lines.entries()) {
       const lineNumber = lineIndex + 1;
-      if (!codeBlockLineNumbers.has(lineNumber)) {
+      if (!ignoreBlockLineNumbers.has(lineNumber)) {
         let match = null;
         while ((match = reversedLinkRe.exec(line)) !== null) {
           const [ reversedLink, preChar, linkText, linkDestination ] = match;
@@ -32,7 +34,7 @@ export default {
             const length = match[0].length - preChar.length;
             /** @type {import("../helpers/helpers.cjs").FileRange} */
             const range = { "startLine": lineNumber, "startColumn": column, "endLine": lineNumber, "endColumn": column + length - 1 };
-            if (!codeTexts.some((codeText) => hasOverlap(codeText, range))) {
+            if (!ignoreTexts.some((ignoreText) => hasOverlap(ignoreText, range))) {
               addError(
                 onError,
                 lineNumber,

package/lib/md013.mjs

@@ -4,10 +4,8 @@ import { addErrorDetailIf } from "../helpers/helpers.cjs";
 import { filterByTypesCached, getReferenceLinkImageData } from "./cache.mjs";
 import { addRangeToSet, getDescendantsByType } from "../helpers/micromark-helpers.cjs";
 
-const longLineRePrefix = "^.{";
-const longLineRePostfixRelaxed = "}.*\\s.*$";
-const longLineRePostfixStrict = "}.+$";
-const sternModeRe = /^(?:[#>\s]*\s)?\S*$/;
+// Regular expression for a line that is not wrappable
+const notWrappableRe = /^(?:[#>\s]*\s)?\S*$/;
 
 /** @typedef {import("micromark-extension-gfm-autolink-literal")} */
 /** @typedef {import("micromark-extension-gfm-table")} */
@@ -20,20 +18,10 @@ export default {
   "parser": "micromark",
   "function": function MD013(params, onError) {
     const lineLength = Number(params.config.line_length || 80);
-    const headingLineLength =
-      Number(params.config.heading_line_length || lineLength);
-    const codeLineLength =
-      Number(params.config.code_block_line_length || lineLength);
+    const headingLineLength = Number(params.config.heading_line_length || lineLength);
+    const codeLineLength = Number(params.config.code_block_line_length || lineLength);
     const strict = !!params.config.strict;
     const stern = !!params.config.stern;
-    const longLineRePostfix =
-      (strict || stern) ? longLineRePostfixStrict : longLineRePostfixRelaxed;
-    const longLineRe =
-      new RegExp(longLineRePrefix + lineLength + longLineRePostfix);
-    const longHeadingLineRe =
-      new RegExp(longLineRePrefix + headingLineLength + longLineRePostfix);
-    const longCodeLineRe =
-      new RegExp(longLineRePrefix + codeLineLength + longLineRePostfix);
     const codeBlocks = params.config.code_blocks;
     const includeCodeBlocks = (codeBlocks === undefined) ? true : !!codeBlocks;
     const tables = params.config.tables;
@@ -75,28 +63,27 @@ export default {
       const isHeading = headingLineNumbers.has(lineNumber);
       const inCode = codeBlockLineNumbers.has(lineNumber);
       const inTable = tableLineNumbers.has(lineNumber);
-      const length = inCode ?
-        codeLineLength :
-        (isHeading ? headingLineLength : lineLength);
-      const lengthRe = inCode ?
-        longCodeLineRe :
-        (isHeading ? longHeadingLineRe : longLineRe);
-      if ((includeCodeBlocks || !inCode) &&
+      const maxLength = inCode ? codeLineLength : (isHeading ? headingLineLength : lineLength);
+      // If not strict/stern, the last run of non-whitespace is allowed to go
+      // beyond the limit as long as it begins within the limit
+      const text = (strict || stern) ? line : line.replace(/\S*$/u, "#");
+      if ((maxLength > 0) &&
+          (includeCodeBlocks || !inCode) &&
           (includeTables || !inTable) &&
           (includeHeadings || !isHeading) &&
           !definitionLineIndices.has(lineIndex) &&
           (strict ||
-           (!(stern && sternModeRe.test(line)) &&
+           (!(stern && notWrappableRe.test(line)) &&
             !linkOnlyLineNumbers.has(lineNumber))) &&
-          lengthRe.test(line)) {
+          (text.length > maxLength)) {
         addErrorDetailIf(
           onError,
           lineNumber,
-          length,
+          maxLength,
           line.length,
           undefined,
           undefined,
-          [ length + 1, line.length - length ]
+          [ maxLength + 1, line.length - maxLength ]
         );
       }
     }

package/lib/md060.mjs

@@ -2,8 +2,10 @@
 
 import { filterByTypes } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
+import stringWidth from "string-width";
 
 /** @typedef {import("micromark-extension-gfm-table")} */
+/** @typedef {import("markdownlint").MicromarkToken} MicromarkToken */
 /** @typedef {import("markdownlint").RuleOnErrorInfo} RuleOnErrorInfo */
 
 /**
@@ -22,6 +24,56 @@ function addError(errors, lineNumber, column, detail) {
   });
 }
 
+/**
+ * @typedef Column
+ * @property {number} actual Actual column (1-based).
+ * @property {number} effective Effective column (1-based).
+ */
+
+/**
+ * Gets a list of table cell divider columns.
+ *
+ * @param {readonly string[]} lines File/string lines.
+ * @param {MicromarkToken} row Micromark row token.
+ * @returns {Column[]} Divider columns.
+ */
+function getTableDividerColumns(lines, row) {
+  return filterByTypes(
+    row.children,
+    [ "tableCellDivider" ]
+  ).map(
+    (divider) => ({
+      "actual": divider.startColumn,
+      "effective": stringWidth(lines[row.startLine - 1].slice(0, divider.startColumn - 1))
+    })
+  );
+}
+
+/**
+ * Checks the specified table rows for consistency with the "aligned" style.
+ *
+ * @param {readonly string[]} lines File/string lines.
+ * @param {MicromarkToken[]} rows Micromark row tokens.
+ * @param {string} detail Detail message.
+ * @returns {RuleOnErrorInfo[]} List of errors.
+ */
+function checkStyleAligned(lines, rows, detail) {
+  /** @type {RuleOnErrorInfo[]} */
+  const errorInfos = [];
+  const headerRow = rows[0];
+  const headerDividerColumns = getTableDividerColumns(lines, headerRow);
+  for (const row of rows.slice(1)) {
+    const remainingHeaderDividerColumns = new Set(headerDividerColumns.map((column) => column.effective));
+    const rowDividerColumns = getTableDividerColumns(lines, row);
+    for (const dividerColumn of rowDividerColumns) {
+      if ((remainingHeaderDividerColumns.size > 0) && !remainingHeaderDividerColumns.delete(dividerColumn.effective)) {
+        addError(errorInfos, row.startLine, dividerColumn.actual, detail);
+      }
+    }
+  }
+  return errorInfos;
+}
+
 /** @type {import("markdownlint").Rule} */
 export default {
   "names": [ "MD060", "table-column-style" ],
@@ -33,27 +85,19 @@ export default {
     const styleAlignedAllowed = (style === "any") || (style === "aligned");
     const styleCompactAllowed = (style === "any") || (style === "compact");
     const styleTightAllowed = (style === "any") || (style === "tight");
+    const alignedDelimiter = !!params.config.aligned_delimiter;
+    const lines = params.lines;
 
     // Scan all tables/rows
     const tables = filterByTypesCached([ "table" ]);
     for (const table of tables) {
       const rows = filterByTypes(table.children, [ "tableDelimiterRow", "tableRow" ]);
-      const headingRow = rows[0];
 
       // Determine errors for style "aligned"
       /** @type {RuleOnErrorInfo[]} */
       const errorsIfAligned = [];
       if (styleAlignedAllowed) {
-        const headingDividerColumns = filterByTypes(headingRow.children, [ "tableCellDivider" ]).map((divider) => divider.startColumn);
-        for (const row of rows.slice(1)) {
-          const remainingHeadingDividerColumns = new Set(headingDividerColumns);
-          const rowDividerColumns = filterByTypes(row.children, [ "tableCellDivider" ]).map((divider) => divider.startColumn);
-          for (const dividerColumn of rowDividerColumns) {
-            if ((remainingHeadingDividerColumns.size > 0) && !remainingHeadingDividerColumns.delete(dividerColumn)) {
-              addError(errorsIfAligned, row.startLine, dividerColumn, "Table pipe does not align with heading for style \"aligned\"");
-            }
-          }
-        }
+        errorsIfAligned.push(...checkStyleAligned(lines, rows, "Table pipe does not align with header for style \"aligned\""));
       }
 
       // Determine errors for styles "compact" and "tight"
@@ -65,6 +109,11 @@ export default {
         (styleCompactAllowed || styleTightAllowed) &&
         !(styleAlignedAllowed && (errorsIfAligned.length === 0))
       ) {
+        if (alignedDelimiter) {
+          const errorInfos = checkStyleAligned(lines, rows.slice(0, 2), "Table pipe does not align with header for option \"aligned_delimiter\"");
+          errorsIfCompact.push(...errorInfos);
+          errorsIfTight.push(...errorInfos);
+        }
         for (const row of rows) {
           const tokensOfInterest = filterByTypes(row.children, [ "tableCellDivider", "tableContent", "whitespace" ]);
           for (let i = 0; i < tokensOfInterest.length; i++) {

package/lib/micromark-parse.mjs

@@ -142,11 +142,10 @@ export function getEvents(
           .trim();
         if ((text.length > 0) && !text.includes("]")) {
           /** @type {Event[]} */
-          const artificialEvents = [];
-          artificialEvents.push(
+          const artificialEvents = [
             [ "enter", undefinedReferenceType, tokenizeContext ],
             [ "enter", undefinedReference, tokenizeContext ]
-          );
+          ];
           for (const event of eventsToReplicate) {
             const [ kind, token ] = event;
             // Copy token because the current object will get modified by the parser

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint",
-  "version": "0.39.0",
+  "version": "0.40.0",
   "description": "A Node.js style checker and lint tool for Markdown/CommonMark files.",
   "type": "module",
   "exports": {
@@ -80,23 +80,24 @@
     "micromark-extension-gfm-footnote": "2.1.0",
     "micromark-extension-gfm-table": "2.1.1",
     "micromark-extension-math": "3.1.0",
-    "micromark-util-types": "2.0.2"
+    "micromark-util-types": "2.0.2",
+    "string-width": "8.1.0"
   },
   "devDependencies": {
-    "@eslint/js": "9.37.0",
-    "@stylistic/eslint-plugin": "5.4.0",
+    "@eslint/js": "9.39.1",
+    "@stylistic/eslint-plugin": "5.6.1",
     "ajv": "8.17.1",
     "ava": "6.4.1",
     "c8": "10.1.3",
     "character-entities": "2.0.2",
-    "eslint": "9.37.0",
-    "eslint-plugin-jsdoc": "61.1.1",
+    "eslint": "9.39.1",
+    "eslint-plugin-jsdoc": "61.4.1",
     "eslint-plugin-n": "17.23.1",
     "eslint-plugin-regexp": "2.10.0",
-    "eslint-plugin-unicorn": "61.0.2",
+    "eslint-plugin-unicorn": "62.0.0",
     "gemoji": "8.1.0",
-    "globby": "15.0.0",
-    "js-yaml": "4.1.0",
+    "globby": "16.0.0",
+    "js-yaml": "4.1.1",
     "json-schema-to-typescript": "15.0.4",
     "jsonc-parser": "3.3.1",
     "markdown-it": "14.1.0",
@@ -109,7 +110,7 @@
     "terser-webpack-plugin": "5.3.14",
     "toml": "3.0.0",
     "typescript": "5.9.3",
-    "webpack": "5.102.1",
+    "webpack": "5.103.0",
     "webpack-cli": "6.0.1"
   },
   "keywords": [