markdownlint 0.30.0 → 0.31.1

package/lib/md051.js

@@ -3,7 +3,7 @@
 "use strict";
 
 const { addError, addErrorDetailIf } = require("../helpers");
-const { filterByHtmlTokens, filterByTypes, getHtmlTagInfo } =
+const { filterByPredicate, filterByTypes, getHtmlTagInfo } =
   require("../helpers/micromark.cjs");
 
 // Regular expression for identifying HTML anchor names
@@ -11,16 +11,28 @@ const idRe = /\sid\s*=\s*['"]?([^'"\s>]+)/iu;
 const nameRe = /\sname\s*=\s*['"]?([^'"\s>]+)/iu;
 const anchorRe = /\{(#[a-z\d]+(?:[-_][a-z\d]+)*)\}/gu;
 
+// Sets for filtering heading tokens during conversion
+const childrenExclude = new Set([ "image", "reference", "resource" ]);
+const tokensInclude = new Set([ "codeTextData", "data" ]);
+
+/**
+ * @typedef {import("../helpers/micromark.cjs").Token} Token
+ */
+
 /**
  * Converts a Markdown heading into an HTML fragment according to the rules
  * used by GitHub.
  *
- * @param {Object} headingText Heading text token.
+ * @param {Token} headingText Heading text token.
  * @returns {string} Fragment string for heading.
  */
 function convertHeadingToHTMLFragment(headingText) {
   const inlineText =
-    filterByTypes(headingText.children, [ "codeTextData", "data" ])
+    filterByPredicate(
+      headingText.children,
+      (token) => tokensInclude.has(token.type),
+      (token) => (childrenExclude.has(token.type) ? [] : token.children)
+    )
       .map((token) => token.text)
       .join("");
   return "#" + encodeURIComponent(
@@ -38,6 +50,18 @@ function convertHeadingToHTMLFragment(headingText) {
   );
 }
 
+/**
+ * Unescapes the text of a String-type micromark Token.
+ *
+ * @param {Token} token String-type micromark Token.
+ * @returns {string} Unescaped token text.
+ */
+function unescapeStringTokenText(token) {
+  return filterByTypes(token.children, [ "characterEscapeValue", "data" ])
+    .map((child) => child.text)
+    .join("");
+}
+
 module.exports = {
   "names": [ "MD051", "link-fragments" ],
   "description": "Link fragments should be valid",
@@ -53,22 +77,24 @@ module.exports = {
     );
     for (const headingText of headingTexts) {
       const fragment = convertHeadingToHTMLFragment(headingText);
-      const count = fragments.get(fragment) || 0;
-      if (count) {
-        fragments.set(`${fragment}-${count}`, 0);
-      }
-      fragments.set(fragment, count + 1);
-      let match = null;
-      while ((match = anchorRe.exec(headingText.text)) !== null) {
-        const [ , anchor ] = match;
-        if (!fragments.has(anchor)) {
-          fragments.set(anchor, 1);
+      if (fragment !== "#") {
+        const count = fragments.get(fragment) || 0;
+        if (count) {
+          fragments.set(`${fragment}-${count}`, 0);
+        }
+        fragments.set(fragment, count + 1);
+        let match = null;
+        while ((match = anchorRe.exec(headingText.text)) !== null) {
+          const [ , anchor ] = match;
+          if (!fragments.has(anchor)) {
+            fragments.set(anchor, 1);
+          }
         }
       }
     }
 
     // Process HTML anchors
-    for (const token of filterByHtmlTokens(tokens)) {
+    for (const token of filterByTypes(tokens, [ "htmlText" ])) {
       const htmlTagInfo = getHtmlTagInfo(token);
       if (htmlTagInfo && !htmlTagInfo.close) {
         const anchorMatch = idRe.exec(token.text) ||
@@ -89,10 +115,13 @@ module.exports = {
       for (const link of links) {
         const definitions = filterByTypes(link.children, [ definitionType ]);
         for (const definition of definitions) {
+          const { endColumn, startColumn } = definition;
+          const text = unescapeStringTokenText(definition);
           if (
-            (definition.text.length > 1) &&
-            definition.text.startsWith("#") &&
-            !fragments.has(definition.text)
+            (text.length > 1) &&
+            text.startsWith("#") &&
+            !fragments.has(text) &&
+            !fragments.has(`#${encodeURIComponent(text.slice(1))}`)
           ) {
             // eslint-disable-next-line no-undef-init
             let context = undefined;
@@ -104,13 +133,13 @@ module.exports = {
               context = link.text;
               range = [ link.startColumn, link.endColumn - link.startColumn ];
               fixInfo = {
-                "editColumn": definition.startColumn,
-                "deleteCount": definition.endColumn - definition.startColumn
+                "editColumn": startColumn,
+                "deleteCount": endColumn - startColumn
               };
             }
-            const definitionTextLower = definition.text.toLowerCase();
+            const textLower = text.toLowerCase();
             const mixedCaseKey = [ ...fragments.keys() ]
-              .find((key) => definitionTextLower === key.toLowerCase());
+              .find((key) => textLower === key.toLowerCase());
             if (mixedCaseKey) {
               // @ts-ignore
               (fixInfo || {}).insertText = mixedCaseKey;
@@ -118,7 +147,7 @@ module.exports = {
                 onError,
                 link.startLine,
                 mixedCaseKey,
-                definition.text,
+                text,
                 undefined,
                 context,
                 range,

package/lib/md052.js

@@ -11,10 +11,14 @@ module.exports = {
     "Reference links and images should use a label that is defined",
   "tags": [ "images", "links" ],
   "function": function MD052(params, onError) {
-    const { lines } = params;
-    const { references, definitions } = referenceLinkImageData();
+    const { config, lines } = params;
+    const shortcutSyntax = config.shortcut_syntax || false;
+    const { definitions, references, shortcuts } = referenceLinkImageData();
+    const entries = shortcutSyntax ?
+      [ ...references.entries(), ...shortcuts.entries() ] :
+      references.entries();
     // Look for links/images that use an undefined link reference
-    for (const reference of references.entries()) {
+    for (const reference of entries) {
       const [ label, datas ] = reference;
       if (!definitions.has(label)) {
         for (const data of datas) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint",
-  "version": "0.30.0",
+  "version": "0.31.1",
   "description": "A Node.js style checker and lint tool for Markdown/CommonMark files.",
   "type": "commonjs",
   "main": "./lib/markdownlint.js",
@@ -18,7 +18,7 @@
   "homepage": "https://github.com/DavidAnson/markdownlint",
   "repository": {
     "type": "git",
-    "url": "https://github.com/DavidAnson/markdownlint.git"
+    "url": "git+https://github.com/DavidAnson/markdownlint.git"
   },
   "bugs": "https://github.com/DavidAnson/markdownlint/issues",
   "scripts": {
@@ -52,7 +52,7 @@
     "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 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": "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",
@@ -68,16 +68,16 @@
     "markdownlint-micromark": "0.1.7"
   },
   "devDependencies": {
-    "@babel/core": "7.22.10",
-    "@babel/preset-env": "7.22.10",
+    "@babel/core": "7.22.19",
+    "@babel/preset-env": "7.22.15",
     "ava": "5.3.1",
     "babel-loader": "9.1.3",
     "c8": "8.0.1",
     "character-entities": "2.0.2",
-    "eslint": "8.46.0",
+    "eslint": "8.49.0",
     "eslint-plugin-es": "4.1.0",
-    "eslint-plugin-jsdoc": "46.4.6",
-    "eslint-plugin-n": "16.0.1",
+    "eslint-plugin-jsdoc": "46.8.0",
+    "eslint-plugin-n": "16.1.0",
     "eslint-plugin-regexp": "1.15.0",
     "eslint-plugin-unicorn": "48.0.1",
     "gemoji": "8.1.0",
@@ -86,16 +86,16 @@
     "markdown-it-for-inline": "0.1.1",
     "markdown-it-sub": "1.0.0",
     "markdown-it-sup": "1.0.0",
-    "markdownlint-rule-helpers": "0.20.0",
+    "markdownlint-rule-helpers": "0.22.0",
     "npm-run-all": "4.1.5",
     "strip-json-comments": "5.0.1",
     "terser-webpack-plugin": "5.3.9",
     "toml": "3.0.0",
     "tv4": "1.3.0",
-    "typescript": "5.1.6",
+    "typescript": "5.2.2",
     "webpack": "5.88.2",
     "webpack-cli": "5.1.4",
-    "yaml": "2.3.1"
+    "yaml": "2.3.2"
   },
   "keywords": [
     "markdown",

package/schema/.markdownlint.jsonc

@@ -279,7 +279,10 @@
   "MD051": true,
 
   // MD052/reference-links-images - Reference links and images should use a label that is defined
-  "MD052": true,
+  "MD052": {
+    // Include shortcut syntax
+    "shortcut_syntax": false
+  },
 
   // MD053/link-image-reference-definitions - Link and image reference definitions should be needed
   "MD053": {

package/schema/.markdownlint.yaml

@@ -252,7 +252,9 @@ MD050:
 MD051: true
 
 # MD052/reference-links-images - Reference links and images should use a label that is defined
-MD052: true
+MD052:
+  # Include shortcut syntax
+  shortcut_syntax: false
 
 # MD053/link-image-reference-definitions - Link and image reference definitions should be needed
 MD053:

package/schema/markdownlint-config-schema.json

@@ -937,8 +937,19 @@
     },
     "MD052": {
       "description": "MD052/reference-links-images - Reference links and images should use a label that is defined",
-      "type": "boolean",
-      "default": true
+      "type": [
+        "boolean",
+        "object"
+      ],
+      "default": true,
+      "properties": {
+        "shortcut_syntax": {
+          "description": "Include shortcut syntax",
+          "type": "boolean",
+          "default": false
+        }
+      },
+      "additionalProperties": false
     },
     "reference-links-images": {
       "$ref": "#/properties/MD052"