markdownlint 0.32.1 → 0.34.0

package/lib/md051.js

@@ -11,22 +11,19 @@ const { filterByPredicate, filterByTypes, getHtmlTagInfo } =
 const idRe = getHtmlAttributeRe("id");
 const nameRe = getHtmlAttributeRe("name");
 const anchorRe = /\{(#[a-z\d]+(?:[-_][a-z\d]+)*)\}/gu;
+const lineFragmentRe = /^#(?:L\d+(?:C\d+)?-L\d+(?:C\d+)?|L\d+)$/;
 
 // Sets for filtering heading tokens during conversion
 const childrenExclude = new Set([ "image", "reference", "resource" ]);
 const tokensInclude = new Set(
-  [ "characterEscapeValue", "codeTextData", "data" ]
+  [ "characterEscapeValue", "codeTextData", "data", "mathTextData" ]
 );
 
-/**
- * @typedef {import("../helpers/micromark.cjs").Token} Token
- */
-
 /**
  * Converts a Markdown heading into an HTML fragment according to the rules
  * used by GitHub.
  *
- * @param {Token} headingText Heading text token.
+ * @param {import("../helpers/micromark.cjs").Token} headingText Heading text token.
  * @returns {string} Fragment string for heading.
  */
 function convertHeadingToHTMLFragment(headingText) {
@@ -55,7 +52,7 @@ function convertHeadingToHTMLFragment(headingText) {
 /**
  * Unescapes the text of a String-type micromark Token.
  *
- * @param {Token} token String-type micromark Token.
+ * @param {import("../helpers/micromark.cjs").Token} token String-type micromark Token.
  * @returns {string} Unescaped token text.
  */
 function unescapeStringTokenText(token) {
@@ -64,19 +61,23 @@ function unescapeStringTokenText(token) {
     .join("");
 }
 
+// eslint-disable-next-line jsdoc/valid-types
+/** @type import("./markdownlint").Rule */
 module.exports = {
   "names": [ "MD051", "link-fragments" ],
   "description": "Link fragments should be valid",
   "tags": [ "links" ],
+  "parser": "micromark",
   "function": function MD051(params, onError) {
-    const { tokens } = params.parsers.micromark;
+    // eslint-disable-next-line jsdoc/valid-types
+    /** @type import("../helpers/micromark.cjs").Token[] */
+    const micromarkTokens =
+      // @ts-ignore
+      params.parsers.micromark.tokens;
     const fragments = new Map();
 
     // Process headings
-    const headingTexts = filterByTypes(
-      tokens,
-      [ "atxHeadingText", "setextHeadingText" ]
-    );
+    const headingTexts = filterByTypes(micromarkTokens, [ "atxHeadingText", "setextHeadingText" ]);
     for (const headingText of headingTexts) {
       const fragment = convertHeadingToHTMLFragment(headingText);
       if (fragment !== "#") {
@@ -96,7 +97,7 @@ module.exports = {
     }
 
     // Process HTML anchors
-    for (const token of filterByTypes(tokens, [ "htmlText" ])) {
+    for (const token of filterByTypes(micromarkTokens, [ "htmlText" ])) {
       const htmlTagInfo = getHtmlTagInfo(token);
       if (htmlTagInfo && !htmlTagInfo.close) {
         const anchorMatch = idRe.exec(token.text) ||
@@ -108,22 +109,25 @@ module.exports = {
     }
 
     // Process link and definition fragments
+    // eslint-disable-next-line jsdoc/valid-types
+    /** @type import("../helpers/micromark.cjs").TokenType[][] */
     const parentChilds = [
       [ "link", "resourceDestinationString" ],
       [ "definition", "definitionDestinationString" ]
     ];
     for (const [ parentType, definitionType ] of parentChilds) {
-      const links = filterByTypes(tokens, [ parentType ]);
+      const links = filterByTypes(micromarkTokens, [ parentType ]);
       for (const link of links) {
         const definitions = filterByTypes(link.children, [ definitionType ]);
         for (const definition of definitions) {
           const { endColumn, startColumn } = definition;
           const text = unescapeStringTokenText(definition);
+          const encodedText = `#${encodeURIComponent(text.slice(1))}`;
           if (
             (text.length > 1) &&
             text.startsWith("#") &&
-            !fragments.has(text) &&
-            !fragments.has(`#${encodeURIComponent(text.slice(1))}`)
+            !fragments.has(encodedText) &&
+            !lineFragmentRe.test(encodedText)
           ) {
             // eslint-disable-next-line no-undef-init
             let context = undefined;

package/lib/md052.js

@@ -5,11 +5,14 @@
 const { addError } = require("../helpers");
 const { referenceLinkImageData } = require("./cache");
 
+// eslint-disable-next-line jsdoc/valid-types
+/** @type import("./markdownlint").Rule */
 module.exports = {
   "names": [ "MD052", "reference-links-images" ],
   "description":
     "Reference links and images should use a label that is defined",
   "tags": [ "images", "links" ],
+  "parser": "none",
   "function": function MD052(params, onError) {
     const { config, lines } = params;
     const shortcutSyntax = config.shortcut_syntax || false;

package/lib/md053.js

@@ -6,10 +6,13 @@ const { addError, ellipsify, linkReferenceDefinitionRe } =
   require("../helpers");
 const { referenceLinkImageData } = require("./cache");
 
+// eslint-disable-next-line jsdoc/valid-types
+/** @type import("./markdownlint").Rule */
 module.exports = {
   "names": [ "MD053", "link-image-reference-definitions" ],
   "description": "Link and image reference definitions should be needed",
   "tags": [ "images", "links" ],
+  "parser": "none",
   "function": function MD053(params, onError) {
     const ignored = new Set(params.config.ignored_definitions || [ "//" ]);
     const lines = params.lines;

package/lib/md054.js

@@ -21,12 +21,15 @@ const autolinkAble = (destination) => {
   return !autolinkDisallowedRe.test(destination);
 };
 
+// eslint-disable-next-line jsdoc/valid-types
+/** @type import("./markdownlint").Rule */
 module.exports = {
   "names": [ "MD054", "link-image-style" ],
   "description": "Link and image style",
   "tags": [ "images", "links" ],
+  "parser": "micromark",
   "function": (params, onError) => {
-    const { parsers, config } = params;
+    const config = params.config;
     const autolink = (config.autolink === undefined) || !!config.autolink;
     const inline = (config.inline === undefined) || !!config.inline;
     const full = (config.full === undefined) || !!config.full;
@@ -37,11 +40,13 @@ module.exports = {
       // Everything allowed, nothing to check
       return;
     }
+    // eslint-disable-next-line jsdoc/valid-types
+    /** @type import("../helpers/micromark.cjs").Token[] */
+    const micromarkTokens =
+      // @ts-ignore
+      params.parsers.micromark.tokens;
     const { definitions } = referenceLinkImageData();
-    const links = filterByTypes(
-      parsers.micromark.tokens,
-      [ "autolink", "image", "link" ]
-    );
+    const links = filterByTypes(micromarkTokens, [ "autolink", "image", "link" ]);
     for (const link of links) {
       let label = null;
       let destination = null;

package/lib/md055.js

@@ -0,0 +1,80 @@
+// @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 ];
+
+// eslint-disable-next-line jsdoc/valid-types
+/** @type import("./markdownlint").Rule */
+module.exports = {
+  "names": [ "MD055", "table-pipe-style" ],
+  "description": "Table pipe style",
+  "tags": [ "table" ],
+  "parser": "micromark",
+  "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"));
+    // eslint-disable-next-line jsdoc/valid-types
+    /** @type import("../helpers/micromark.cjs").Token[] */
+    const micromarkTokens =
+      // @ts-ignore
+      params.parsers.micromark.tokens;
+    const tables = filterByTypes(micromarkTokens, [ "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,52 @@
+// @ts-check
+
+"use strict";
+
+const { addErrorDetailIf } = require("../helpers");
+const { filterByTypes } = require("../helpers/micromark.cjs");
+
+const makeRange = (start, end) => [ start, end - start + 1 ];
+
+// eslint-disable-next-line jsdoc/valid-types
+/** @type import("./markdownlint").Rule */
+module.exports = {
+  "names": [ "MD056", "table-column-count" ],
+  "description": "Table column count",
+  "tags": [ "table" ],
+  "parser": "micromark",
+  "function": function MD056(params, onError) {
+    // eslint-disable-next-line jsdoc/valid-types
+    /** @type import("../helpers/micromark.cjs").Token[] */
+    const micromarkTokens =
+      // @ts-ignore
+      params.parsers.micromark.tokens;
+    const tables = filterByTypes(micromarkTokens, [ "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.1",
+  "version": "0.34.0",
   "description": "A Node.js style checker and lint tool for Markdown/CommonMark files.",
   "type": "commonjs",
   "main": "./lib/markdownlint.js",
@@ -26,7 +26,7 @@
     "build-config": "npm run build-config-schema && npm run build-config-example",
     "build-config-example": "node schema/build-config-example.js",
     "build-config-schema": "node schema/build-config-schema.js",
-    "build-declaration": "tsc --allowJs --declaration --emitDeclarationOnly --module commonjs --resolveJsonModule --target es2015 lib/markdownlint.js && node scripts delete 'lib/{cache,constants,md,r}*.d.ts' 'micromark/*.d.cts' 'helpers/*.d.{cts,ts}'",
+    "build-declaration": "tsc --allowJs --declaration --emitDeclarationOnly --module commonjs --outDir dts --resolveJsonModule --target es2015 lib/markdownlint.js && node scripts copy dts/lib/markdownlint.d.ts lib/markdownlint.d.ts && node scripts remove dts",
     "build-demo": "node scripts copy node_modules/markdown-it/dist/markdown-it.min.js demo/markdown-it.min.js && node scripts copy node_modules/markdownlint-micromark/micromark-browser.js demo/micromark-browser.js && node scripts copy node_modules/markdownlint-micromark/micromark-html-browser.js demo/micromark-html-browser.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",
@@ -48,56 +48,50 @@
     "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.1.0",
+    "markdownlint-micromark": "0.1.9"
   },
   "devDependencies": {
-    "@babel/core": "7.23.3",
-    "@babel/preset-env": "7.23.3",
-    "@hyperjump/json-schema": "1.6.5",
-    "ava": "5.3.1",
-    "babel-loader": "9.1.3",
-    "c8": "8.0.1",
+    "ajv": "8.12.0",
+    "ava": "6.1.2",
+    "c8": "9.1.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.57.0",
+    "eslint-plugin-jsdoc": "48.2.1",
+    "eslint-plugin-n": "16.6.2",
+    "eslint-plugin-regexp": "2.3.0",
+    "eslint-plugin-unicorn": "51.0.1",
     "gemoji": "8.1.0",
-    "globby": "14.0.0",
+    "globby": "14.0.1",
     "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.23.0",
+    "json-schema-to-typescript": "13.1.2",
+    "jsonc-parser": "3.2.1",
+    "markdown-it-for-inline": "2.0.1",
+    "markdown-it-sub": "2.0.0",
+    "markdown-it-sup": "2.0.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",
-    "webpack": "5.89.0",
-    "webpack-cli": "5.1.4",
-    "yaml": "2.3.4"
+    "typescript": "5.4.3",
+    "webpack": "5.91.0",
+    "webpack-cli": "5.1.4"
   },
   "keywords": [
     "markdown",