markdownlint 0.33.0 → 0.35.0

package/lib/md049-md050.js

@@ -5,10 +5,19 @@
 const { addError, emphasisOrStrongStyleFor } = require("../helpers");
 const { filterByPredicate, tokenIfType } = require("../helpers/micromark.cjs");
 
-const intrawordRe = /\w/;
+const intrawordRe = /^\w$/;
 
+/**
+ * @param {import("./markdownlint").RuleParams} params Rule parameters.
+ * @param {import("./markdownlint").RuleOnError} onError Error-reporting callback.
+ * @param {import("markdownlint-micromark").TokenType} type Token type.
+ * @param {import("markdownlint-micromark").TokenType} typeSequence Token sequence type.
+ * @param {"*" | "**"} asterisk Asterisk kind.
+ * @param {"_" | "__"} underline Underline kind.
+ * @param {"asterisk" | "consistent" | "underscore"} style Style string.
+ */
 const impl =
-  (params, onError, type, asterisk, underline, style = "consistent") => {
+  (params, onError, type, typeSequence, asterisk, underline, style = "consistent") => {
     const { lines, parsers } = params;
     const emphasisTokens = filterByPredicate(
       parsers.micromark.tokens,
@@ -17,9 +26,8 @@ const impl =
     );
     for (const token of emphasisTokens) {
       const { children } = token;
-      const childType = `${type}Sequence`;
-      const startSequence = tokenIfType(children[0], childType);
-      const endSequence = tokenIfType(children[children.length - 1], childType);
+      const startSequence = tokenIfType(children[0], typeSequence);
+      const endSequence = tokenIfType(children[children.length - 1], typeSequence);
       if (startSequence && endSequence) {
         const markupStyle = emphasisOrStrongStyleFor(startSequence.text);
         if (style === "consistent") {
@@ -55,16 +63,20 @@ const impl =
     }
   };
 
+// eslint-disable-next-line jsdoc/valid-types
+/** @type import("./markdownlint").Rule[] */
 module.exports = [
   {
     "names": [ "MD049", "emphasis-style" ],
     "description": "Emphasis style",
     "tags": [ "emphasis" ],
+    "parser": "micromark",
     "function": function MD049(params, onError) {
       return impl(
         params,
         onError,
         "emphasis",
+        "emphasisSequence",
         "*",
         "_",
         params.config.style || undefined
@@ -75,11 +87,13 @@ module.exports = [
     "names": [ "MD050", "strong-style" ],
     "description": "Strong style",
     "tags": [ "emphasis" ],
+    "parser": "micromark",
     "function": function MD050(params, onError) {
       return impl(
         params,
         onError,
         "strong",
+        "strongSequence",
         "**",
         "__",
         params.config.style || undefined

package/lib/md051.js

@@ -2,31 +2,27 @@
 
 "use strict";
 
-const { addError, addErrorDetailIf, getHtmlAttributeRe } =
-  require("../helpers");
-const { filterByPredicate, filterByTypes, getHtmlTagInfo } =
-  require("../helpers/micromark.cjs");
+const { addError, addErrorDetailIf, getHtmlAttributeRe } = require("../helpers");
+const { filterByPredicate, filterByTypes, getHtmlTagInfo } = require("../helpers/micromark.cjs");
+const { filterByTypesCached } = require("./cache");
 
 // Regular expression for identifying HTML anchor names
 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 +51,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 +60,18 @@ 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;
     const fragments = new Map();
 
     // Process headings
-    const headingTexts = filterByTypes(
-      tokens,
-      [ "atxHeadingText", "setextHeadingText" ]
-    );
+    const headingTexts = filterByTypesCached([ "atxHeadingText", "setextHeadingText" ]);
     for (const headingText of headingTexts) {
       const fragment = convertHeadingToHTMLFragment(headingText);
       if (fragment !== "#") {
@@ -96,7 +91,7 @@ module.exports = {
     }
 
     // Process HTML anchors
-    for (const token of filterByTypes(tokens, [ "htmlText" ])) {
+    for (const token of filterByTypesCached([ "htmlText" ], true)) {
       const htmlTagInfo = getHtmlTagInfo(token);
       if (htmlTagInfo && !htmlTagInfo.close) {
         const anchorMatch = idRe.exec(token.text) ||
@@ -108,22 +103,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 = filterByTypesCached([ 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

@@ -3,17 +3,20 @@
 "use strict";
 
 const { addError } = require("../helpers");
-const { referenceLinkImageData } = require("./cache");
+const { getReferenceLinkImageData } = 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;
-    const { definitions, references, shortcuts } = referenceLinkImageData();
+    const { definitions, references, shortcuts } = getReferenceLinkImageData();
     const entries = shortcutSyntax ?
       [ ...references.entries(), ...shortcuts.entries() ] :
       references.entries();

package/lib/md053.js

@@ -4,17 +4,20 @@
 
 const { addError, ellipsify, linkReferenceDefinitionRe } =
   require("../helpers");
-const { referenceLinkImageData } = require("./cache");
+const { getReferenceLinkImageData } = 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;
     const { references, shortcuts, definitions, duplicateDefinitions } =
-      referenceLinkImageData();
+      getReferenceLinkImageData();
     const singleLineDefinition = (line) => (
       line.replace(linkReferenceDefinitionRe, "").trim().length > 0
     );

package/lib/md054.js

@@ -3,9 +3,8 @@
 "use strict";
 
 const { addErrorContext, nextLinesRe } = require("../helpers");
-const { filterByTypes, filterByPredicate, getTokenTextByType } =
-  require("../helpers/micromark.cjs");
-const { referenceLinkImageData } = require("./cache");
+const { filterByPredicate, getTokenTextByType } = require("../helpers/micromark.cjs");
+const { getReferenceLinkImageData, filterByTypesCached } = require("./cache");
 
 const backslashEscapeRe = /\\([!"#$%&'()*+,\-./:;<=>?@[\\\]^_`{|}~])/g;
 const removeBackslashEscapes = (text) => text.replace(backslashEscapeRe, "$1");
@@ -21,12 +20,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 +39,8 @@ module.exports = {
       // Everything allowed, nothing to check
       return;
     }
-    const { definitions } = referenceLinkImageData();
-    const links = filterByTypes(
-      parsers.micromark.tokens,
-      [ "autolink", "image", "link" ]
-    );
+    const { definitions } = getReferenceLinkImageData();
+    const links = filterByTypesCached([ "autolink", "image", "link" ]);
     for (const link of links) {
       let label = null;
       let destination = null;
@@ -84,7 +83,8 @@ module.exports = {
         }
       }
       if (isError) {
-        let range = null;
+        // eslint-disable-next-line no-undef-init
+        let range = undefined;
         let fixInfo = null;
         if (startLine === endLine) {
           range = [ startColumn, endColumn - startColumn ];
@@ -114,8 +114,8 @@ module.exports = {
           onError,
           startLine,
           text.replace(nextLinesRe, ""),
-          null,
-          null,
+          undefined,
+          undefined,
           range,
           fixInfo
         );

package/lib/md055.js

@@ -4,6 +4,7 @@
 
 const { addErrorDetailIf } = require("../helpers");
 const { filterByTypes } = require("../helpers/micromark.cjs");
+const { filterByTypesCached } = require("./cache");
 
 const whitespaceTypes = new Set([ "linePrefix", "whitespace" ]);
 const ignoreWhitespace = (tokens) => tokens.filter(
@@ -13,10 +14,13 @@ 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;
@@ -24,9 +28,12 @@ module.exports = {
       ((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" ]);
+    const tables = filterByTypesCached([ "table" ]);
     for (const table of tables) {
-      const rows = filterByTypes(table.children, [ "tableDelimiterRow", "tableRow" ]);
+      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)
@@ -69,4 +76,4 @@ module.exports = {
       }
     }
   }
-}
+};

package/lib/md056.js

@@ -4,24 +4,36 @@
 
 const { addErrorDetailIf } = require("../helpers");
 const { filterByTypes } = require("../helpers/micromark.cjs");
+const { filterByTypesCached } = require("./cache");
 
 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) {
-    const tables = filterByTypes(params.parsers.micromark.tokens, [ "table" ]);
+    const tables = filterByTypesCached([ "table" ]);
     for (const table of tables) {
-      const rows = filterByTypes(table.children, [ "tableDelimiterRow", "tableRow" ]);
+      const rows = filterByTypes(
+        table.children,
+        [ "tableDelimiterRow", "tableRow" ]
+      );
       let expectedCount = 0;
       for (const row of rows) {
-        const cells = filterByTypes(row.children, [ "tableData", "tableDelimiter", "tableHeader" ]);
+        const cells = filterByTypes(
+          row.children,
+          [ "tableData", "tableDelimiter", "tableHeader" ]
+        );
         const actualCount = cells.length;
         expectedCount ||= actualCount;
-        let detail = null;
-        let range = null;
+        // eslint-disable-next-line no-undef-init
+        let detail = undefined;
+        // eslint-disable-next-line no-undef-init
+        let range = undefined;
         if (actualCount < expectedCount) {
           detail = "Too few cells, row will be missing data";
           range = [ row.endColumn - 1, 1 ];
@@ -35,7 +47,7 @@ module.exports = {
           expectedCount,
           actualCount,
           detail,
-          null,
+          undefined,
           range
         );
       }

package/lib/md058.js

@@ -0,0 +1,43 @@
+// @ts-check
+
+"use strict";
+
+const { addErrorContextForLine, isBlankLine } = require("../helpers");
+const { filterByTypesCached } = require("./cache");
+
+// eslint-disable-next-line jsdoc/valid-types
+/** @type import("./markdownlint").Rule */
+module.exports = {
+  "names": [ "MD058", "blanks-around-tables" ],
+  "description": "Tables should be surrounded by blank lines",
+  "tags": [ "table" ],
+  "parser": "micromark",
+  "function": function MD058(params, onError) {
+    const { lines } = params;
+    // For every table...
+    const tables = filterByTypesCached([ "table" ]);
+    for (const table of tables) {
+      // Look for a blank line above the table
+      const firstIndex = table.startLine - 1;
+      if (!isBlankLine(lines[firstIndex - 1])) {
+        addErrorContextForLine(
+          onError,
+          // @ts-ignore
+          lines,
+          firstIndex
+        );
+      }
+      // Look for a blank line below the table
+      const lastIndex = table.endLine - 1;
+      if (!isBlankLine(lines[lastIndex + 1])) {
+        addErrorContextForLine(
+          onError,
+          // @ts-ignore
+          lines,
+          lastIndex,
+          lastIndex + 2
+        );
+      }
+    }
+  }
+};

package/lib/rules.js

@@ -4,6 +4,11 @@
 
 const { homepage, version } = require("./constants");
 
+// @ts-ignore
+const [ md019, md021 ] = require("./md019-md021");
+// @ts-ignore
+const [ md049, md050 ] = require("./md049-md050");
+
 const rules = [
   require("./md001"),
   // md002: Deprecated and removed
@@ -19,9 +24,9 @@ const rules = [
   require("./md013"),
   require("./md014"),
   require("./md018"),
-  require("./md019"),
+  md019,
   require("./md020"),
-  require("./md021"),
+  md021,
   require("./md022"),
   require("./md023"),
   require("./md024"),
@@ -49,14 +54,16 @@ const rules = [
   require("./md046"),
   require("./md047"),
   require("./md048"),
-  ...require("./md049-md050"),
+  md049,
+  md050,
   require("./md051"),
   require("./md052"),
   require("./md053"),
   require("./md054"),
   require("./md055"),
-  require("./md056")
+  require("./md056"),
   // md057: See https://github.com/markdownlint/markdownlint
+  require("./md058")
 ];
 for (const rule of rules) {
   const name = rule.names[0].toLowerCase();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint",
-  "version": "0.33.0",
+  "version": "0.35.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",
@@ -49,13 +49,13 @@
     "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",
-    "lint": "eslint --ext .js,.cjs,.mjs --max-warnings 0 .",
+    "lint": "eslint --max-warnings 0",
     "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-declaration": "cd example/typescript && tsc --module nodenext && tsc --module commonjs && node type-check.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",
@@ -65,38 +65,35 @@
     "node": ">=18"
   },
   "dependencies": {
-    "markdown-it": "14.0.0",
-    "markdownlint-micromark": "0.1.8"
+    "markdown-it": "14.1.0",
+    "markdownlint-micromark": "0.1.10"
   },
   "devDependencies": {
-    "@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": "9.0.0",
+    "@eslint/js": "9.9.1",
+    "ajv": "8.17.1",
+    "ava": "6.1.3",
+    "c8": "10.1.2",
     "character-entities": "2.0.2",
-    "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",
+    "eslint": "9.9.1",
+    "eslint-plugin-jsdoc": "50.2.2",
+    "eslint-plugin-n": "17.10.2",
+    "eslint-plugin-regexp": "2.6.0",
+    "eslint-plugin-unicorn": "55.0.0",
     "gemoji": "8.1.0",
-    "globby": "14.0.0",
+    "globby": "14.0.2",
     "js-yaml": "4.1.0",
-    "json-schema-to-typescript": "13.1.1",
+    "json-schema-to-typescript": "15.0.1",
+    "jsonc-parser": "3.3.1",
     "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",
+    "markdownlint-rule-extended-ascii": "0.1.0",
     "npm-run-all": "4.1.5",
-    "strip-json-comments": "5.0.1",
     "terser-webpack-plugin": "5.3.10",
     "toml": "3.0.0",
-    "typescript": "5.3.3",
-    "webpack": "5.89.0",
-    "webpack-cli": "5.1.4",
-    "yaml": "2.3.4"
+    "typescript": "5.5.4",
+    "webpack": "5.94.0",
+    "webpack-cli": "5.1.4"
   },
   "keywords": [
     "markdown",