markdownlint 0.38.0 → 0.40.0

package/lib/md055.mjs

@@ -3,15 +3,16 @@
 import { addErrorDetailIf } from "../helpers/helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
 
+/** @typedef {import("markdownlint").MicromarkToken} MicromarkToken */
+/** @typedef {import("micromark-extension-gfm-table")} */
+
 const whitespaceTypes = new Set([ "linePrefix", "whitespace" ]);
-const ignoreWhitespace = (tokens) => tokens.filter(
+const ignoreWhitespace = (/** @type {MicromarkToken[]} */ 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 ];
-
-/** @typedef {import("micromark-extension-gfm-table")} */
+const firstOrNothing = (/** @type {MicromarkToken[]} */ items) => items[0];
+const lastOrNothing = (/** @type {MicromarkToken[]} */ items) => items[items.length - 1];
+const makeRange = (/** @type {number} */ start, /** @type {number} */ end) => [ start, end - start + 1 ];
 
 /** @type {import("markdownlint").Rule} */
 export default {

package/lib/md056.mjs

@@ -4,7 +4,7 @@ import { addErrorDetailIf } from "../helpers/helpers.cjs";
 import { getParentOfType } from "../helpers/micromark-helpers.cjs";
 import { filterByTypesCached } from "./cache.mjs";
 
-const makeRange = (start, end) => [ start, end - start + 1 ];
+const makeRange = (/** @type {number} */ start, /** @type {number} */ end) => [ start, end - start + 1 ];
 
 /** @typedef {import("micromark-extension-gfm-table")} */
 

package/lib/md060.mjs

@@ -0,0 +1,170 @@
+// @ts-check
+
+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 */
+
+/**
+ * Adds a RuleOnErrorInfo object to a list of RuleOnErrorInfo objects.
+ *
+ * @param {RuleOnErrorInfo[]} errors List of errors.
+ * @param {number} lineNumber Line number.
+ * @param {number} column Column number.
+ * @param {string} detail Detail message.
+ */
+function addError(errors, lineNumber, column, detail) {
+  errors.push({
+    lineNumber,
+    detail,
+    "range": [ column, 1 ]
+  });
+}
+
+/**
+ * @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" ],
+  "description": "Table column style",
+  "tags": [ "table" ],
+  "parser": "micromark",
+  "function": function MD060(params, onError) {
+    const style = String(params.config.style || "any");
+    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" ]);
+
+      // Determine errors for style "aligned"
+      /** @type {RuleOnErrorInfo[]} */
+      const errorsIfAligned = [];
+      if (styleAlignedAllowed) {
+        errorsIfAligned.push(...checkStyleAligned(lines, rows, "Table pipe does not align with header for style \"aligned\""));
+      }
+
+      // Determine errors for styles "compact" and "tight"
+      /** @type {RuleOnErrorInfo[]} */
+      const errorsIfCompact = [];
+      /** @type {RuleOnErrorInfo[]} */
+      const errorsIfTight = [];
+      if (
+        (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++) {
+            const { startColumn, startLine, type } = tokensOfInterest[i];
+            if (type === "tableCellDivider") {
+              const previous = tokensOfInterest[i - 1];
+              if (previous) {
+                if (previous.type === "whitespace") {
+                  if (previous.text.length !== 1) {
+                    addError(errorsIfCompact, startLine, startColumn, "Table pipe has extra space to the left for style \"compact\"");
+                  }
+                  addError(errorsIfTight, startLine, startColumn, "Table pipe has space to the left for style \"tight\"");
+                } else {
+                  addError(errorsIfCompact, startLine, startColumn, "Table pipe is missing space to the left for style \"compact\"");
+                }
+              }
+              const next = tokensOfInterest[i + 1];
+              if (next) {
+                if (next.type === "whitespace") {
+                  if (next.endColumn !== row.endColumn) {
+                    if (next.text.length !== 1) {
+                      addError(errorsIfCompact, startLine, startColumn, "Table pipe has extra space to the right for style \"compact\"");
+                    }
+                    addError(errorsIfTight, startLine, startColumn, "Table pipe has space to the right for style \"tight\"");
+                  }
+                } else {
+                  addError(errorsIfCompact, startLine, startColumn, "Table pipe is missing space to the right for style \"compact\"");
+                }
+              }
+            }
+          }
+        }
+      }
+
+      // Report errors for whatever (allowed) style has the fewest
+      let errorInfos = errorsIfAligned;
+      if (
+        styleCompactAllowed &&
+        ((errorsIfCompact.length < errorInfos.length) || !styleAlignedAllowed)
+      ) {
+        errorInfos = errorsIfCompact;
+      }
+      if (
+        styleTightAllowed &&
+        ((errorsIfTight.length < errorInfos.length) || (!styleAlignedAllowed && !styleCompactAllowed))
+      ) {
+        errorInfos = errorsIfTight;
+      }
+      for (const errorInfo of errorInfos) {
+        onError(errorInfo);
+      }
+    }
+  }
+};

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
@@ -212,7 +211,9 @@ function parseInternal(
   const events = getEvents(markdown, micromarkParseOptions);
 
   // Create Token objects
+  /** @type {MicromarkToken[]} */
   const document = [];
+  /** @type {MicromarkToken[]} */
   let flatTokens = [];
   /** @type {MicromarkToken} */
   const root = {
@@ -282,6 +283,7 @@ function parseInternal(
         );
         current.children = tokens;
         // Avoid stack overflow of Array.push(...spread)
+        // @ts-ignore
         // eslint-disable-next-line unicorn/prefer-spread
         flatTokens = flatTokens.concat(tokens[flatTokensSymbol]);
       }

package/lib/node-imports-browser.mjs

@@ -6,8 +6,10 @@ const throwForSync = () => {
 };
 
 export const fs = {
+  // @ts-ignore
   "access": (path, callback) => callback(getError()),
   "accessSync": throwForSync,
+  // @ts-ignore
   "readFile": (path, options, callback) => callback(getError()),
   "readFileSync": throwForSync
 };

package/lib/parse-configuration.mjs

@@ -4,7 +4,7 @@
  * Result of a call to parseConfiguration.
  *
  * @typedef {Object} ParseConfigurationResult
- * @property {Object | null} config Configuration object if successful.
+ * @property {import("markdownlint").Configuration | null} config Configuration object if successful.
  * @property {string | null} message Error message if an error occurred.
  */
 
@@ -13,7 +13,7 @@
  *
  * @param {string} name Name of the configuration file.
  * @param {string} content Configuration content.
- * @param {import("./markdownlint.mjs").ConfigurationParser[]} [parsers] Parsing function(s).
+ * @param {import("markdownlint").ConfigurationParser[]} [parsers] Parsing function(s).
  * @returns {ParseConfigurationResult} Parse configuration result.
  */
 export default function parseConfiguration(name, content, parsers) {
@@ -28,8 +28,9 @@ export default function parseConfiguration(name, content, parsers) {
       config = (result && (typeof result === "object") && !Array.isArray(result)) ? result : {};
       // Succeeded
       return false;
-    } catch (error) {
-      errors.push(`Parser ${index++}: ${error.message}`);
+      // eslint-disable-next-line jsdoc/reject-any-type
+    } catch(/** @type {any} */ error) {
+      errors.push(`Parser ${index++}: ${error?.message}`);
     }
     // Failed, try the next parser
     return true;

package/lib/rules.mjs

@@ -54,6 +54,7 @@ import md055 from "./md055.mjs";
 import md056 from "./md056.mjs";
 import md058 from "./md058.mjs";
 import md059 from "./md059.mjs";
+import md060 from "./md060.mjs";
 
 const rules = [
   md001,
@@ -110,7 +111,8 @@ const rules = [
   md056,
   // md057: See https://github.com/markdownlint/markdownlint
   md058,
-  md059
+  md059,
+  md060
 ];
 for (const rule of rules) {
   const name = rule.names[0].toLowerCase();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint",
-  "version": "0.38.0",
+  "version": "0.40.0",
   "description": "A Node.js style checker and lint tool for Markdown/CommonMark files.",
   "type": "module",
   "exports": {
@@ -39,11 +39,10 @@
     "build-declaration": "tsc --allowJs --checkJs --declaration --emitDeclarationOnly --module nodenext --outDir dts --rootDir . --target es2015 lib/exports.mjs lib/exports-async.mjs lib/exports-promise.mjs lib/exports-sync.mjs lib/markdownlint.mjs lib/resolve-module.cjs && node scripts/index.mjs copy dts/lib/exports.d.mts lib/exports.d.mts && node scripts/index.mjs copy dts/lib/exports-async.d.mts lib/exports-async.d.mts && node scripts/index.mjs copy dts/lib/exports-promise.d.mts lib/exports-promise.d.mts && node scripts/index.mjs copy dts/lib/exports-sync.d.mts lib/exports-sync.d.mts && node scripts/index.mjs copy dts/lib/markdownlint.d.mts lib/markdownlint.d.mts && node scripts/index.mjs copy dts/lib/resolve-module.d.cts lib/resolve-module.d.cts && node scripts/index.mjs remove dts",
     "build-demo": "node scripts/index.mjs copy node_modules/markdown-it/dist/markdown-it.min.js demo/markdown-it.min.js && cd demo && webpack --no-stats",
     "build-docs": "node doc-build/build-rules.mjs",
-    "build-example": "npm install --no-save --ignore-scripts grunt grunt-cli gulp through2",
     "ci": "npm-run-all --continue-on-error --parallel build-demo lint serial-config-docs serial-declaration test-cover && git diff --exit-code",
     "clone-test-repos-apache-airflow": "cd test-repos && git clone https://github.com/apache/airflow apache-airflow --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-electron-electron": "cd test-repos && git clone https://github.com/electron/electron electron-electron --depth 1 --no-tags --quiet && cd electron-electron && npm install --ignore-scripts @electron/lint-roller typescript@4",
+    "clone-test-repos-electron-electron": "cd test-repos && git clone https://github.com/electron/electron electron-electron --depth 1 --no-tags --quiet && cd electron-electron && node ../../scripts/index.mjs delete package.json && npm install --no-save --ignore-scripts @electron/lint-roller",
     "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-mdn-content": "cd test-repos && git clone https://github.com/mdn/content mdn-content --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",
@@ -54,7 +53,7 @@
     "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-apache-airflow && npm run clone-test-repos-dotnet-docs && npm run clone-test-repos-electron-electron && npm run clone-test-repos-eslint-eslint && npm run clone-test-repos-mdn-content && 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-v8-v8-dev && npm run clone-test-repos-webhintio-hint && npm run clone-test-repos-webpack-webpack-js-org",
     "declaration": "npm run build-declaration && npm run test-declaration",
-    "example": "cd example && node standalone.mjs && grunt markdownlint --force && gulp markdownlint",
+    "example": "cd example && node standalone.mjs",
     "lint": "eslint --max-warnings 0",
     "lint-test-repos": "ava --timeout=10m test/markdownlint-test-repos-*.mjs",
     "serial-config-docs": "npm run build-config && npm run build-docs",
@@ -81,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.26.0",
-    "@stylistic/eslint-plugin": "4.2.0",
+    "@eslint/js": "9.39.1",
+    "@stylistic/eslint-plugin": "5.6.1",
     "ajv": "8.17.1",
-    "ava": "6.3.0",
+    "ava": "6.4.1",
     "c8": "10.1.3",
     "character-entities": "2.0.2",
-    "eslint": "9.26.0",
-    "eslint-plugin-jsdoc": "50.6.11",
-    "eslint-plugin-n": "17.17.0",
-    "eslint-plugin-regexp": "2.7.0",
-    "eslint-plugin-unicorn": "59.0.0",
+    "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": "62.0.0",
     "gemoji": "8.1.0",
-    "globby": "14.1.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",
@@ -105,12 +105,12 @@
     "markdown-it-sub": "2.0.0",
     "markdown-it-sup": "2.0.0",
     "markdownlint-rule-extended-ascii": "0.2.1",
-    "nano-spawn": "0.2.0",
+    "nano-spawn": "2.0.0",
     "npm-run-all": "4.1.5",
     "terser-webpack-plugin": "5.3.14",
     "toml": "3.0.0",
-    "typescript": "5.8.3",
-    "webpack": "5.99.7",
+    "typescript": "5.9.3",
+    "webpack": "5.103.0",
     "webpack-cli": "6.0.1"
   },
   "keywords": [