markdownlint 0.40.0 → 0.41.1

package/doc/md060.md

@@ -10,6 +10,8 @@ Parameters:
 - `style`: Table column style (`string`, default `any`, values `aligned` /
   `any` / `compact` / `tight`)
 
+Fixable: Some violations can be fixed by tooling
+
 This rule is triggered when the column separator pipe characters (`|`) of a
 [GitHub Flavored Markdown table][gfm-table-060] are used inconsistently.
 
@@ -81,6 +83,16 @@ Style `tight` with `aligned_delimiter`:
 |N|No|
 ```
 
+Violations for styles `compact` and `tight` are simple/independent and can be
+fixed automatically. However, fixing even single violations for style `aligned`
+may require modifying the entire table, and therefore are not automatic:
+
+```markdown
+|Alpha |Delta|
+|------|-----|
+|Charlie|Beta|
+```
+
 **Note**: This rule does not require leading/trailing pipe characters, so this
 is also a valid table for style `compact`:
 
@@ -112,7 +124,7 @@ appear aligned in most editors and monospaced fonts:
 
 Rationale: Consistent formatting makes it easier to understand a document.
 
-[cjk-characters]: https://en.wikipedia.org/wiki/CJK_characters
-[emoji]: https://en.wikipedia.org/wiki/Emoji
+[cjk-characters]: https://wikipedia.org/wiki/CJK_characters
+[emoji]: https://wikipedia.org/wiki/Emoji
 [gfm-table-060]: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-tables
-[latin-script]: https://en.wikipedia.org/wiki/Latin_script
+[latin-script]: https://wikipedia.org/wiki/Latin_script

package/helpers/README.md

@@ -22,8 +22,8 @@ be useful to custom rule authors and may avoid duplicating code.
 *None* - The entire body of code is tested to 100% coverage by the core
 `markdownlint` project, so there are no additional tests here.
 
-[custom-rules]: https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/CustomRules.md
-[jsdoc]: https://en.m.wikipedia.org/wiki/JSDoc
-[markdown]: https://en.wikipedia.org/wiki/Markdown
+[custom-rules]: https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/CustomRules.md
+[jsdoc]: https://wikipedia.org/wiki/JSDoc
+[markdown]: https://wikipedia.org/wiki/Markdown
 [markdownlint]: https://github.com/DavidAnson/markdownlint
-[rules]: https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/Rules.md
+[rules]: https://github.com/DavidAnson/markdownlint/blob/v0.41.1/doc/Rules.md

package/helpers/helpers.cjs

@@ -2,11 +2,12 @@
 
 "use strict";
 
-const micromark = require("./micromark-helpers.cjs");
+/* eslint-disable unicorn/comment-content */
 
-const { newLineRe, nextLinesRe } = require("./shared.cjs");
+const micromark = require("./micromark-helpers.cjs");
+const { newlineRe, nextLinesRe } = require("./shared.cjs");
 
-module.exports.newLineRe = newLineRe;
+module.exports.newLineRe = newlineRe;
 module.exports.nextLinesRe = nextLinesRe;
 
 /** @typedef {import("../lib/exports.mjs").RuleOnError} RuleOnError */
@@ -20,6 +21,7 @@ module.exports.nextLinesRe = nextLinesRe;
 // Regular expression for matching common front matter (YAML and TOML)
 // @ts-ignore
 module.exports.frontMatterRe =
+  // eslint-disable-next-line unicorn/prefer-unicode-code-point-escapes
   /((^---[^\S\r\n\u2028\u2029]*$[\s\S]+?^---\s*)|(^\+\+\+[^\S\r\n\u2028\u2029]*$[\s\S]+?^(\+\+\+|\.\.\.)\s*)|(^\{[^\S\r\n\u2028\u2029]*$[\s\S]+?^\}\s*))(\r\n|\r|\n|$)/m;
 
 // Regular expression for matching the start of inline disable/enable comments
@@ -178,6 +180,7 @@ const startsWithPipeRe = /^ *\|/;
 const notCrLfRe = /[^\r\n]/g;
 const notSpaceCrLfRe = /[^ \r\n]/g;
 const trailingSpaceRe = / +[\r\n]/g;
+// eslint-disable-next-line unicorn/no-unsafe-string-replacement
 const replaceTrailingSpace = (/** @type {string} */ s) => s.replace(notCrLfRe, safeCommentCharacter);
 module.exports.clearHtmlCommentText = function clearHtmlCommentText(/** @type {string} */ text) {
   let i = 0;
@@ -207,7 +210,9 @@ module.exports.clearHtmlCommentText = function clearHtmlCommentText(/** @type {s
       // If a valid block/inline comment...
       if (isValid) {
         const clearedContent = content
+          // eslint-disable-next-line unicorn/no-unsafe-string-replacement
           .replace(notSpaceCrLfRe, safeCommentCharacter)
+          // eslint-disable-next-line unicorn/no-unsafe-string-replacement
           .replace(trailingSpaceRe, replaceTrailingSpace);
         text =
           text.slice(0, i + htmlCommentBegin.length) +
@@ -222,6 +227,7 @@ module.exports.clearHtmlCommentText = function clearHtmlCommentText(/** @type {s
 
 // Escapes a string for use in a RegExp
 module.exports.escapeForRegExp = function escapeForRegExp(/** @type {string} */ str) {
+  // eslint-disable-next-line unicorn/prefer-regexp-escape
   return str.replace(/[-/\\^$*+?.()|[\]{}]/g, "\\$&");
 };
 
@@ -311,7 +317,7 @@ module.exports.addErrorDetailIf = addErrorDetailIf;
  */
 function addErrorContext(onError, lineNumber, context, start, end, range, fixInfo) {
   // Normalize new line characters so Linux and Windows trim consistently
-  context = ellipsify(context.replace(newLineRe, "\n"), start, end);
+  context = ellipsify(context.replace(newlineRe, "\n"), start, end);
   addError(onError, lineNumber, undefined, context, range, fixInfo);
 }
 module.exports.addErrorContext = addErrorContext;
@@ -438,59 +444,59 @@ function getReferenceLinkImageData(tokens) {
       case "gfmFootnoteDefinitionLabelString":
         labelPrefix = "^";
       case "definitionLabelString": // eslint-disable-line no-fallthrough
-        {
-          // definitions and definitionLineIndices
-          const reference = normalizeReference(`${labelPrefix}${token.text}`);
-          if (definitions.has(reference)) {
-            duplicateDefinitions.push([ reference, token.startLine - 1 ]);
-          } else {
-            const parent =
-              micromark.getParentOfType(token, [ "definition" ]);
-            const destinationString = parent &&
-              micromark.getDescendantsByType(parent, [ "definitionDestination", "definitionDestinationRaw", "definitionDestinationString" ])[0]?.text;
-            definitions.set(
-              reference,
-              [ token.startLine - 1, destinationString || "" ]
-            );
-          }
+      {
+        // definitions and definitionLineIndices
+        const reference = normalizeReference(`${labelPrefix}${token.text}`);
+        if (definitions.has(reference)) {
+          duplicateDefinitions.push([ reference, token.startLine - 1 ]);
+        } else {
+          const parent =
+            micromark.getParentOfType(token, [ "definition" ]);
+          const destinationString = parent &&
+            micromark.getDescendantsByType(parent, [ "definitionDestination", "definitionDestinationRaw", "definitionDestinationString" ])[0]?.text;
+          definitions.set(
+            reference,
+            [ token.startLine - 1, destinationString || "" ]
+          );
         }
         break;
+      }
       case "gfmFootnoteCall":
       case "image":
       case "link":
-        {
-          // Identify if shortcut or full/collapsed
-          let isShortcut = (token.children.length === 1);
-          const isFullOrCollapsed = (token.children.length === 2) && !token.children.some((t) => t.type === "resource");
-          const [ labelText ] = micromark.getDescendantsByType(token, [ "label", "labelText" ]);
-          const [ referenceString ] = micromark.getDescendantsByType(token, [ "reference", "referenceString" ]);
-          let label = getText(labelText);
-          // Identify if footnote
-          if (!isShortcut && !isFullOrCollapsed) {
-            const [ footnoteCallMarker, footnoteCallString ] = token.children.filter(
-              (t) => [ "gfmFootnoteCallMarker", "gfmFootnoteCallString" ].includes(t.type)
-            );
-            if (footnoteCallMarker && footnoteCallString) {
-              label = `${footnoteCallMarker.text}${footnoteCallString.text}`;
-              isShortcut = true;
-            }
-          }
-          // Track link (handle shortcuts separately due to ambiguity in "text [text] text")
-          if (isShortcut || isFullOrCollapsed) {
-            addReferenceToDictionary(token, getText(referenceString) || label, isShortcut);
+      {
+        // Identify if shortcut or full/collapsed
+        let isShortcut = (token.children.length === 1);
+        const isFullOrCollapsed = (token.children.length === 2) && !token.children.some((t) => t.type === "resource");
+        const [ labelText ] = micromark.getDescendantsByType(token, [ "label", "labelText" ]);
+        const [ referenceString ] = micromark.getDescendantsByType(token, [ "reference", "referenceString" ]);
+        let label = getText(labelText);
+        // Identify if footnote
+        if (!isShortcut && !isFullOrCollapsed) {
+          const [ footnoteCallMarker, footnoteCallString ] = token.children.filter(
+            (t) => [ "gfmFootnoteCallMarker", "gfmFootnoteCallString" ].includes(t.type)
+          );
+          if (footnoteCallMarker && footnoteCallString) {
+            label = `${footnoteCallMarker.text}${footnoteCallString.text}`;
+            isShortcut = true;
           }
         }
+        // Track link (handle shortcuts separately due to ambiguity in "text [text] text")
+        if (isShortcut || isFullOrCollapsed) {
+          addReferenceToDictionary(token, getText(referenceString) || label, isShortcut);
+        }
         break;
+      }
       case "undefinedReferenceCollapsed":
       case "undefinedReferenceFull":
       case "undefinedReferenceShortcut":
-        {
-          const undefinedReference = micromark.getDescendantsByType(token, [ "undefinedReference" ])[0];
-          const label = undefinedReference.children.map((t) => t.text).join("");
-          const isShortcut = (token.type === "undefinedReferenceShortcut");
-          addReferenceToDictionary(token, label, isShortcut);
-        }
+      {
+        const undefinedReference = micromark.getDescendantsByType(token, [ "undefinedReference" ])[0];
+        const label = undefinedReference.children.map((t) => t.text).join("");
+        const isShortcut = (token.type === "undefinedReferenceShortcut");
+        addReferenceToDictionary(token, label, isShortcut);
         break;
+      }
     }
   }
   return {
@@ -514,7 +520,7 @@ function getPreferredLineEnding(input, os) {
   let cr = 0;
   let lf = 0;
   let crlf = 0;
-  const endings = input.match(newLineRe) || [];
+  const endings = input.match(newlineRe) || [];
   for (const ending of endings) {
     // eslint-disable-next-line default-case
     switch (ending) {
@@ -552,6 +558,7 @@ module.exports.getPreferredLineEnding = getPreferredLineEnding;
  */
 function expandTildePath(file, os) {
   const homedir = os && os.homedir && os.homedir();
+  // eslint-disable-next-line unicorn/no-unsafe-string-replacement
   return homedir ? file.replace(/^~($|\/|\\)/, `${homedir}$1`) : file;
 }
 module.exports.expandTildePath = expandTildePath;
@@ -630,9 +637,8 @@ function convertLintErrorsVersion2To0(errors) {
 function copyAndTransformResults(results, transform) {
   /** @type {Object.<string, LintErrors>} */
   const newResults = {};
-  Object.defineProperty(newResults, "toString", { "value": results.toString });
-  for (const key of Object.keys(results)) {
-    const arr = results[key].map((r) => ({ ...r }));
+  for (const [ key, value ] of Object.entries(results)) {
+    const arr = value.map((r) => ({ ...r }));
     newResults[key] = transform(arr);
   }
   // @ts-ignore

package/helpers/micromark-helpers.cjs

@@ -2,7 +2,7 @@
 
 "use strict";
 
-const { flatTokensSymbol, htmlFlowSymbol, newLineRe } = require("./shared.cjs");
+const { flatTokensSymbol, htmlFlowSymbol, newlineRe } = require("./shared.cjs");
 
 // eslint-disable-next-line jsdoc/valid-types
 /** @typedef {import("micromark-util-types", { with: { "resolution-mode": "import" } }).TokenType} TokenType */
@@ -17,8 +17,7 @@ const { flatTokensSymbol, htmlFlowSymbol, newLineRe } = require("./shared.cjs");
  * @returns {boolean} True iff the token is within an htmlFlow type.
  */
 function inHtmlFlow(token) {
-  // @ts-ignore
-  return Boolean(token[htmlFlowSymbol]);
+  return Object.hasOwn(token, htmlFlowSymbol);
 }
 
 /**
@@ -152,7 +151,6 @@ function getBlockQuotePrefixText(tokens, lineNumber, count = 1) {
     .map((prefix) => prefix.text)
     .join("")
     .trimEnd()
-    // eslint-disable-next-line unicorn/prefer-spread
     .concat("\n")
     .repeat(count);
 };
@@ -224,7 +222,7 @@ function getHeadingText(heading) {
     .flatMap((descendant) => descendant.children.filter((child) => child.type !== "htmlText"))
     .map((data) => data.text)
     .join("")
-    .replace(newLineRe, " ");
+    .replace(newlineRe, " ");
 }
 
 /**
@@ -285,7 +283,9 @@ function isDocfxTab(heading) {
   // See https://dotnet.github.io/docfx/docs/markdown.html?tabs=linux%2Cdotnet#tabs
   if (heading?.type === "atxHeading") {
     const headingTexts = getDescendantsByType(heading, [ "atxHeadingText" ]);
+    // eslint-disable-next-line unicorn/better-dom-traversing
     if ((headingTexts.length === 1) && (headingTexts[0].children.length === 1) && (headingTexts[0].children[0].type === "link")) {
+      // eslint-disable-next-line unicorn/better-dom-traversing
       const resourceDestinationStrings = filterByTypes(headingTexts[0].children[0].children, [ "resourceDestinationString" ]);
       return (resourceDestinationStrings.length === 1) && docfxTabSyntaxRe.test(resourceDestinationStrings[0].text);
     }

package/helpers/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint-rule-helpers",
-  "version": "0.30.0",
+  "version": "0.31.0",
   "description": "A collection of markdownlint helper functions for custom rules",
   "main": "./helpers.cjs",
   "exports": {
@@ -17,7 +17,7 @@
   "bugs": "https://github.com/DavidAnson/markdownlint/issues",
   "funding": "https://github.com/sponsors/DavidAnson",
   "engines": {
-    "node": ">=18"
+    "node": ">=22"
   },
   "keywords": [
     "markdownlint",

package/helpers/shared.cjs

@@ -2,7 +2,7 @@
 
 "use strict";
 
-// Symbol for identifing the flat tokens array from micromark parse
+// Symbol for identifying the flat tokens array from micromark parse
 module.exports.flatTokensSymbol = Symbol("flat-tokens");
 
 // Symbol for identifying the htmlFlow token from micromark parse
@@ -10,7 +10,7 @@ module.exports.htmlFlowSymbol = Symbol("html-flow");
 
 // Regular expression for matching common newline characters
 // See NEWLINES_RE in markdown-it/lib/rules_core/normalize.js
-module.exports.newLineRe = /\r\n?|\n/g;
+module.exports.newlineRe = /\r\n?|\n/g;
 
 // Regular expression for matching next lines
 module.exports.nextLinesRe = /[\r\n][\s\S]*$/;

package/lib/cache.mjs

@@ -21,6 +21,7 @@ let params = undefined;
  */
 export function initialize(p) {
   map.clear();
+  // eslint-disable-next-line unicorn/no-top-level-assignment-in-function
   params = p;
 }