markdownlint 0.31.0 → 0.32.0

package/lib/md038.js

@@ -3,7 +3,8 @@
 "use strict";
 
 const { addErrorContext } = require("../helpers");
-const { filterByTypes, tokenIfType } = require("../helpers/micromark.cjs");
+const { filterByTypes, inHtmlFlow, tokenIfType } =
+  require("../helpers/micromark.cjs");
 
 const leftSpaceRe = /^\s(?:[^`]|$)/;
 const rightSpaceRe = /[^`]\s$/;
@@ -23,10 +24,11 @@ module.exports = {
   "description": "Spaces inside code span elements",
   "tags": [ "whitespace", "code" ],
   "function": function MD038(params, onError) {
-    const codeTextTokens =
-      filterByTypes(params.parsers.micromark.tokens, [ "codeText" ]);
-    for (const token of codeTextTokens) {
-      const { children } = token;
+    const codeTexts =
+      filterByTypes(params.parsers.micromark.tokens, [ "codeText" ])
+        .filter((codeText) => !inHtmlFlow(codeText));
+    for (const codeText of codeTexts) {
+      const { children } = codeText;
       const first = 0;
       const last = children.length - 1;
       const startSequence = tokenIfType(children[first], "codeTextSequence");

package/lib/md041.js

@@ -7,7 +7,7 @@ const { addErrorContext, frontMatterHasTitle } = require("../helpers");
 module.exports = {
   "names": [ "MD041", "first-line-heading", "first-line-h1" ],
   "description": "First line in a file should be a top-level heading",
-  "tags": [ "headings", "headers" ],
+  "tags": [ "headings" ],
   "function": function MD041(params, onError) {
     const level = Number(params.config.level || 1);
     const tag = "h" + level;

package/lib/md043.js

@@ -6,11 +6,11 @@ const { addErrorContext, addErrorDetailIf, forEachHeading } =
   require("../helpers");
 
 module.exports = {
-  "names": [ "MD043", "required-headings", "required-headers" ],
+  "names": [ "MD043", "required-headings" ],
   "description": "Required heading structure",
-  "tags": [ "headings", "headers" ],
+  "tags": [ "headings" ],
   "function": function MD043(params, onError) {
-    const requiredHeadings = params.config.headings || params.config.headers;
+    const requiredHeadings = params.config.headings;
     if (!Array.isArray(requiredHeadings)) {
       // Nothing to check; avoid doing any work
       return;

package/lib/md045.js

@@ -2,15 +2,20 @@
 
 "use strict";
 
-const { addError } = require("../helpers");
-const { filterByTypes } = require("../helpers/micromark.cjs");
+const { addError, getHtmlAttributeRe, nextLinesRe } = require("../helpers");
+const { filterByTypes, getHtmlTagInfo } = require("../helpers/micromark.cjs");
+
+const altRe = getHtmlAttributeRe("alt");
 
 module.exports = {
   "names": [ "MD045", "no-alt-text" ],
   "description": "Images should have alternate text (alt text)",
   "tags": [ "accessibility", "images" ],
   "function": function MD045(params, onError) {
-    const images = filterByTypes(params.parsers.micromark.tokens, [ "image" ]);
+    const { tokens } = params.parsers.micromark;
+
+    // Process Markdown images
+    const images = filterByTypes(tokens, [ "image" ]);
     for (const image of images) {
       const labelTexts = filterByTypes(image.children, [ "labelText" ]);
       if (labelTexts.some((labelText) => labelText.text.length === 0)) {
@@ -26,5 +31,30 @@ module.exports = {
         );
       }
     }
+
+    // Process HTML images
+    const htmlTexts = filterByTypes(tokens, [ "htmlText" ]);
+    for (const htmlText of htmlTexts) {
+      const { startColumn, startLine, text } = htmlText;
+      const htmlTagInfo = getHtmlTagInfo(htmlText);
+      if (
+        htmlTagInfo &&
+        !htmlTagInfo.close &&
+        (htmlTagInfo.name.toLowerCase() === "img") &&
+        !altRe.test(text)
+      ) {
+        const range = [
+          startColumn,
+          text.replace(nextLinesRe, "").length
+        ];
+        addError(
+          onError,
+          startLine,
+          undefined,
+          undefined,
+          range
+        );
+      }
+    }
   }
 };

package/lib/md049-md050.js

@@ -58,7 +58,7 @@ const impl =
 module.exports = [
   {
     "names": [ "MD049", "emphasis-style" ],
-    "description": "Emphasis style should be consistent",
+    "description": "Emphasis style",
     "tags": [ "emphasis" ],
     "function": function MD049(params, onError) {
       return impl(
@@ -73,7 +73,7 @@ module.exports = [
   },
   {
     "names": [ "MD050", "strong-style" ],
-    "description": "Strong style should be consistent",
+    "description": "Strong style",
     "tags": [ "emphasis" ],
     "function": function MD050(params, onError) {
       return impl(

package/lib/md051.js

@@ -2,18 +2,21 @@
 
 "use strict";
 
-const { addError, addErrorDetailIf } = require("../helpers");
+const { addError, addErrorDetailIf, getHtmlAttributeRe } =
+  require("../helpers");
 const { filterByPredicate, filterByTypes, getHtmlTagInfo } =
   require("../helpers/micromark.cjs");
 
 // Regular expression for identifying HTML anchor names
-const idRe = /\sid\s*=\s*['"]?([^'"\s>]+)/iu;
-const nameRe = /\sname\s*=\s*['"]?([^'"\s>]+)/iu;
+const idRe = getHtmlAttributeRe("id");
+const nameRe = getHtmlAttributeRe("name");
 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" ]);
+const tokensInclude = new Set(
+  [ "characterEscapeValue", "codeTextData", "data" ]
+);
 
 /**
  * @typedef {import("../helpers/micromark.cjs").Token} Token
@@ -39,7 +42,6 @@ function convertHeadingToHTMLFragment(headingText) {
     inlineText
       .toLowerCase()
       // RegExp source with Ruby's \p{Word} expanded into its General Categories
-      // eslint-disable-next-line max-len
       // https://github.com/gjtorikian/html-pipeline/blob/main/lib/html/pipeline/toc_filter.rb
       // https://ruby-doc.org/core-3.0.2/Regexp.html
       .replace(
@@ -99,7 +101,7 @@ module.exports = {
       if (htmlTagInfo && !htmlTagInfo.close) {
         const anchorMatch = idRe.exec(token.text) ||
           (htmlTagInfo.name.toLowerCase() === "a" && nameRe.exec(token.text));
-        if (anchorMatch) {
+        if (anchorMatch && anchorMatch.length > 0) {
           fragments.set(`#${anchorMatch[1]}`, 0);
         }
       }

package/lib/md053.js

@@ -23,7 +23,7 @@ module.exports = {
     };
     // Look for unused link references (unreferenced by any link/image)
     for (const definition of definitions.entries()) {
-      const [ label, lineIndex ] = definition;
+      const [ label, [ lineIndex ] ] = definition;
       if (
         !ignored.has(label) &&
         !references.has(label) &&

package/lib/md054.js

@@ -0,0 +1,118 @@
+// @ts-check
+
+"use strict";
+
+const { addErrorContext, nextLinesRe } = require("../helpers");
+const { filterByTypes, filterByPredicate, getTokenTextByType } =
+  require("../helpers/micromark.cjs");
+const { referenceLinkImageData } = require("./cache");
+
+const backslashEscapeRe = /\\([!"#$%&'()*+,\-./:;<=>?@[\\\]^_`{|}~])/g;
+const removeBackslashEscapes = (text) => text.replace(backslashEscapeRe, "$1");
+const autolinkDisallowedRe = /[ <>]/;
+const autolinkAble = (destination) => {
+  try {
+    // eslint-disable-next-line no-new
+    new URL(destination);
+  } catch {
+    // Not an absolute URL
+    return false;
+  }
+  return !autolinkDisallowedRe.test(destination);
+};
+
+module.exports = {
+  "names": [ "MD054", "link-image-style" ],
+  "description": "Link and image style",
+  "tags": [ "images", "links" ],
+  "function": (params, onError) => {
+    const { parsers, config } = params;
+    const autolink = (config.autolink === undefined) || !!config.autolink;
+    const inline = (config.inline === undefined) || !!config.inline;
+    const full = (config.full === undefined) || !!config.full;
+    const collapsed = (config.collapsed === undefined) || !!config.collapsed;
+    const shortcut = (config.shortcut === undefined) || !!config.shortcut;
+    const urlInline = (config.url_inline === undefined) || !!config.url_inline;
+    if (autolink && inline && full && collapsed && shortcut && urlInline) {
+      // Everything allowed, nothing to check
+      return;
+    }
+    const { definitions } = referenceLinkImageData();
+    const links = filterByTypes(
+      parsers.micromark.tokens,
+      [ "autolink", "image", "link" ]
+    );
+    for (const link of links) {
+      let label = null;
+      let destination = null;
+      const {
+        children, endColumn, endLine, startColumn, startLine, text, type
+      } = link;
+      const image = (type === "image");
+      let isError = false;
+      if (type === "autolink") {
+        // link kind is an autolink
+        destination = getTokenTextByType(children, "autolinkProtocol");
+        label = destination;
+        isError = !autolink;
+      } else {
+        // link type is "image" or "link"
+        const descendents = filterByPredicate(children);
+        label = getTokenTextByType(descendents, "labelText");
+        destination =
+          getTokenTextByType(descendents, "resourceDestinationString");
+        if (destination) {
+          // link kind is an inline link
+          const title = getTokenTextByType(descendents, "resourceTitleString");
+          isError = !inline || (!urlInline && autolink && !title && !image);
+        } else {
+          // link kind is a full/collapsed/shortcut reference link
+          const isShortcut = !children.some((t) => t.type === "reference");
+          const referenceString = getTokenTextByType(descendents, "referenceString");
+          const isCollapsed = (referenceString === null);
+          const definition = definitions.get(referenceString || label);
+          destination = definition && definition[1];
+          isError = destination &&
+            (isShortcut ? !shortcut : (isCollapsed ? !collapsed : !full));
+        }
+      }
+      if (isError) {
+        let range = null;
+        let fixInfo = null;
+        if (startLine === endLine) {
+          range = [ startColumn, endColumn - startColumn ];
+          let insertText = null;
+          const canInline = (inline && label);
+          const canAutolink = (autolink && !image && autolinkAble(destination));
+          if (canInline && (urlInline || !canAutolink)) {
+            // Most useful form
+            const prefix = (image ? "!" : "");
+            // @ts-ignore
+            const escapedLabel = label.replace(/[[\]]/g, "\\$&");
+            const escapedDestination = destination.replace(/[()]/g, "\\$&");
+            insertText = `${prefix}[${escapedLabel}](${escapedDestination})`;
+          } else if (canAutolink) {
+            // Simplest form
+            insertText = `<${removeBackslashEscapes(destination)}>`;
+          }
+          if (insertText) {
+            fixInfo = {
+              "editColumn": range[0],
+              insertText,
+              "deleteCount": range[1]
+            };
+          }
+        }
+        addErrorContext(
+          onError,
+          startLine,
+          text.replace(nextLinesRe, ""),
+          null,
+          null,
+          range,
+          fixInfo
+        );
+      }
+    }
+  }
+};

package/lib/rules.js

@@ -6,11 +6,9 @@ const { homepage, version } = require("./constants");
 
 const rules = [
   require("./md001"),
-  require("./md002"),
   require("./md003"),
   require("./md004"),
   require("./md005"),
-  require("./md006"),
   require("./md007"),
   require("./md009"),
   require("./md010"),
@@ -52,7 +50,11 @@ const rules = [
   ...require("./md049-md050"),
   require("./md051"),
   require("./md052"),
-  require("./md053")
+  require("./md053"),
+  require("./md054")
+  // md055: See https://github.com/markdownlint/markdownlint
+  // md056: See https://github.com/markdownlint/markdownlint
+  // md057: See https://github.com/markdownlint/markdownlint
 ];
 for (const rule of rules) {
   const name = rule.names[0].toLowerCase();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint",
-  "version": "0.31.0",
+  "version": "0.32.0",
   "description": "A Node.js style checker and lint tool for Markdown/CommonMark files.",
   "type": "commonjs",
   "main": "./lib/markdownlint.js",
@@ -18,14 +18,15 @@
   "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",
+  "funding": "https://github.com/sponsors/DavidAnson",
   "scripts": {
     "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/{c,md,r}*.d.ts' 'micromark/*.d.cts' 'helpers/*.d.{cts,ts}'",
+    "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-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",
@@ -61,41 +62,42 @@
     "upgrade": "npx --yes npm-check-updates --upgrade"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "dependencies": {
-    "markdown-it": "13.0.1",
+    "markdown-it": "13.0.2",
     "markdownlint-micromark": "0.1.7"
   },
   "devDependencies": {
-    "@babel/core": "7.22.15",
-    "@babel/preset-env": "7.22.15",
+    "@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",
     "character-entities": "2.0.2",
-    "eslint": "8.48.0",
+    "eslint": "8.53.0",
     "eslint-plugin-es": "4.1.0",
-    "eslint-plugin-jsdoc": "46.5.1",
-    "eslint-plugin-n": "16.0.2",
-    "eslint-plugin-regexp": "1.15.0",
-    "eslint-plugin-unicorn": "48.0.1",
+    "eslint-plugin-jsdoc": "46.9.0",
+    "eslint-plugin-n": "16.3.1",
+    "eslint-plugin-regexp": "2.1.1",
+    "eslint-plugin-unicorn": "49.0.0",
     "gemoji": "8.1.0",
-    "globby": "13.2.2",
+    "globby": "14.0.0",
     "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.21.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.2.2",
-    "webpack": "5.88.2",
+    "webpack": "5.89.0",
     "webpack-cli": "5.1.4",
-    "yaml": "2.3.2"
+    "yaml": "2.3.4"
   },
   "keywords": [
     "markdown",