markdownlint 0.28.2 → 0.30.0

package/lib/md049-md050.js

@@ -2,54 +2,55 @@
 
 "use strict";
 
-const { addError, emphasisOrStrongStyleFor, forEachInlineChild,
-  getNextChildToken, getRangeAndFixInfoIfFound } = require("../helpers");
+const { addError, emphasisOrStrongStyleFor } = require("../helpers");
+const { filterByTypes, tokenIfType } = require("../helpers/micromark.cjs");
 
-const impl = (params, onError, tagPrefix, asterisk, underline, style) => {
-  let lastLineNumber = -1;
-  const instances = new Map();
-  forEachInlineChild(params, `${tagPrefix}_open`, (token, parent) => {
-    const { lineNumber, markup } = token;
-    const markupStyle = emphasisOrStrongStyleFor(markup);
-    if (style === "consistent") {
-      style = markupStyle;
-    }
-    if (style !== markupStyle) {
-      let rangeAndFixInfo = {};
-      const contentToken = getNextChildToken(
-        parent, token, "text", `${tagPrefix}_close`
-      );
-      if (contentToken) {
-        const { content } = contentToken;
-        const actual = `${markup}${content}${markup}`;
-        const expectedMarkup =
-          (style === "asterisk") ? asterisk : underline;
-        const expected = `${expectedMarkup}${content}${expectedMarkup}`;
-        if (lastLineNumber !== lineNumber) {
-          lastLineNumber = lineNumber;
-          instances.clear();
+const intrawordRe = /\w/;
+
+const impl =
+  (params, onError, type, asterisk, underline, style = "consistent") => {
+    const { lines, parsers } = params;
+    const emphasisTokens =
+      filterByTypes(parsers.micromark.tokens, [ type ]);
+    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);
+      if (startSequence && endSequence) {
+        const markupStyle = emphasisOrStrongStyleFor(startSequence.text);
+        if (style === "consistent") {
+          style = markupStyle;
+        }
+        if (style !== markupStyle) {
+          const underscoreIntraword = (style === "underscore") && (
+            intrawordRe.test(
+              lines[startSequence.startLine - 1][startSequence.startColumn - 2]
+            ) ||
+            intrawordRe.test(
+              lines[endSequence.endLine - 1][endSequence.endColumn - 1]
+            )
+          );
+          if (!underscoreIntraword) {
+            for (const sequence of [ startSequence, endSequence ]) {
+              addError(
+                onError,
+                sequence.startLine,
+                `Expected: ${style}; Actual: ${markupStyle}`,
+                undefined,
+                [ sequence.startColumn, sequence.text.length ],
+                {
+                  "editColumn": sequence.startColumn,
+                  "deleteCount": sequence.text.length,
+                  "insertText": (style === "asterisk") ? asterisk : underline
+                }
+              );
+            }
+          }
         }
-        const instance = (instances.get(expected) || 0) + 1;
-        instances.set(expected, instance);
-        rangeAndFixInfo = getRangeAndFixInfoIfFound(
-          params.lines,
-          lineNumber - 1,
-          actual,
-          expected,
-          instance
-        );
       }
-      addError(
-        onError,
-        lineNumber,
-        `Expected: ${style}; Actual: ${markupStyle}`,
-        null,
-        rangeAndFixInfo.range,
-        rangeAndFixInfo.fixInfo
-      );
     }
-  });
-};
+  };
 
 module.exports = [
   {
@@ -57,8 +58,14 @@ module.exports = [
     "description": "Emphasis style should be consistent",
     "tags": [ "emphasis" ],
     "function": function MD049(params, onError) {
-      const style = String(params.config.style || "consistent");
-      return impl(params, onError, "em", "*", "_", style);
+      return impl(
+        params,
+        onError,
+        "emphasis",
+        "*",
+        "_",
+        params.config.style || undefined
+      );
     }
   },
   {
@@ -66,8 +73,14 @@ module.exports = [
     "description": "Strong style should be consistent",
     "tags": [ "emphasis" ],
     "function": function MD050(params, onError) {
-      const style = String(params.config.style || "consistent");
-      return impl(params, onError, "strong", "**", "__", style);
+      return impl(
+        params,
+        onError,
+        "strong",
+        "**",
+        "__",
+        params.config.style || undefined
+      );
     }
   }
 ];

package/lib/md051.js

@@ -2,25 +2,27 @@
 
 "use strict";
 
-const { addError, addErrorDetailIf, escapeForRegExp, filterTokens,
-  forEachInlineChild, forEachHeading, htmlElementRe } = require("../helpers");
+const { addError, addErrorDetailIf } = require("../helpers");
+const { filterByHtmlTokens, 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 anchorRe = /\{(#[a-z\d]+(?:[-_][a-z\d]+)*)\}/gu;
 
 /**
  * Converts a Markdown heading into an HTML fragment according to the rules
  * used by GitHub.
  *
- * @param {Object} inline Inline token for heading.
+ * @param {Object} headingText Heading text token.
  * @returns {string} Fragment string for heading.
  */
-function convertHeadingToHTMLFragment(inline) {
-  const inlineText = inline.children
-    .filter((token) => token.type !== "html_inline")
-    .map((token) => token.content)
-    .join("");
+function convertHeadingToHTMLFragment(headingText) {
+  const inlineText =
+    filterByTypes(headingText.children, [ "codeTextData", "data" ])
+      .map((token) => token.text)
+      .join("");
   return "#" + encodeURIComponent(
     inlineText
       .toLowerCase()
@@ -41,79 +43,99 @@ module.exports = {
   "description": "Link fragments should be valid",
   "tags": [ "links" ],
   "function": function MD051(params, onError) {
+    const { tokens } = params.parsers.micromark;
     const fragments = new Map();
+
     // Process headings
-    forEachHeading(params, (heading, content, inline) => {
-      const fragment = convertHeadingToHTMLFragment(inline);
+    const headingTexts = filterByTypes(
+      tokens,
+      [ "atxHeadingText", "setextHeadingText" ]
+    );
+    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);
-    });
-    // Process HTML anchors
-    const processHtmlToken = (token) => {
       let match = null;
-      while ((match = htmlElementRe.exec(token.content)) !== null) {
-        const [ tag, , element ] = match;
-        const anchorMatch = idRe.exec(tag) ||
-            (element.toLowerCase() === "a" && nameRe.exec(tag));
+      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)) {
+      const htmlTagInfo = getHtmlTagInfo(token);
+      if (htmlTagInfo && !htmlTagInfo.close) {
+        const anchorMatch = idRe.exec(token.text) ||
+          (htmlTagInfo.name.toLowerCase() === "a" && nameRe.exec(token.text));
         if (anchorMatch) {
           fragments.set(`#${anchorMatch[1]}`, 0);
         }
       }
-    };
-    filterTokens(params, "html_block", processHtmlToken);
-    forEachInlineChild(params, "html_inline", processHtmlToken);
-    // Process link fragments
-    forEachInlineChild(params, "link_open", (token) => {
-      const { attrs, lineNumber, line } = token;
-      const href = attrs.find((attr) => attr[0] === "href");
-      const id = href && href[1];
-      if (id && (id.length > 1) && (id[0] === "#") && !fragments.has(id)) {
-        let context = id;
-        let range = null;
-        let fixInfo = null;
-        const match = line.match(
-          new RegExp(`\\[.*?\\]\\(${escapeForRegExp(context)}\\)`)
-        );
-        if (match) {
-          [ context ] = match;
-          const index = match.index;
-          const length = context.length;
-          range = [ index + 1, length ];
-          fixInfo = {
-            "editColumn": index + (length - id.length),
-            "deleteCount": id.length,
-            "insertText": null
-          };
-        }
-        const idLower = id.toLowerCase();
-        const mixedCaseKey = [ ...fragments.keys() ]
-          .find((key) => idLower === key.toLowerCase());
-        if (mixedCaseKey) {
-          (fixInfo || {}).insertText = mixedCaseKey;
-          addErrorDetailIf(
-            onError,
-            lineNumber,
-            mixedCaseKey,
-            id,
-            undefined,
-            context,
-            range,
-            fixInfo
-          );
-        } else {
-          addError(
-            onError,
-            lineNumber,
-            undefined,
-            context,
-            // @ts-ignore
-            range
-          );
+    }
+
+    // Process link and definition fragments
+    const parentChilds = [
+      [ "link", "resourceDestinationString" ],
+      [ "definition", "definitionDestinationString" ]
+    ];
+    for (const [ parentType, definitionType ] of parentChilds) {
+      const links = filterByTypes(tokens, [ parentType ]);
+      for (const link of links) {
+        const definitions = filterByTypes(link.children, [ definitionType ]);
+        for (const definition of definitions) {
+          if (
+            (definition.text.length > 1) &&
+            definition.text.startsWith("#") &&
+            !fragments.has(definition.text)
+          ) {
+            // eslint-disable-next-line no-undef-init
+            let context = undefined;
+            // eslint-disable-next-line no-undef-init
+            let range = undefined;
+            // eslint-disable-next-line no-undef-init
+            let fixInfo = undefined;
+            if (link.startLine === link.endLine) {
+              context = link.text;
+              range = [ link.startColumn, link.endColumn - link.startColumn ];
+              fixInfo = {
+                "editColumn": definition.startColumn,
+                "deleteCount": definition.endColumn - definition.startColumn
+              };
+            }
+            const definitionTextLower = definition.text.toLowerCase();
+            const mixedCaseKey = [ ...fragments.keys() ]
+              .find((key) => definitionTextLower === key.toLowerCase());
+            if (mixedCaseKey) {
+              // @ts-ignore
+              (fixInfo || {}).insertText = mixedCaseKey;
+              addErrorDetailIf(
+                onError,
+                link.startLine,
+                mixedCaseKey,
+                definition.text,
+                undefined,
+                context,
+                range,
+                fixInfo
+              );
+            } else {
+              addError(
+                onError,
+                link.startLine,
+                undefined,
+                context,
+                range
+              );
+            }
+          }
         }
       }
-    });
+    }
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint",
-  "version": "0.28.2",
+  "version": "0.30.0",
   "description": "A Node.js style checker and lint tool for Markdown/CommonMark files.",
   "type": "commonjs",
   "main": "./lib/markdownlint.js",
@@ -26,74 +26,76 @@
     "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-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 && cd demo && webpack --no-stats",
+    "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",
     "build-micromark": "cd micromark && npm run build",
     "ci": "npm-run-all --continue-on-error --parallel lint serial-config-docs serial-declaration-demo test-cover && git diff --exit-code",
     "clone-test-repos-apache-airflow": "cd test-repos && git clone https://github.com/apache/airflow apache-airflow --depth 1 --no-tags --quiet",
     "clone-test-repos-dotnet-docs": "cd test-repos && git clone https://github.com/dotnet/docs dotnet-docs --depth 1 --no-tags --quiet",
-    "clone-test-repos-electron-electron": "cd test-repos && git clone https://github.com/electron/electron electron-electron --depth 1 --no-tags --quiet",
+    "clone-test-repos-electron-electron": "cd test-repos && git clone https://github.com/electron/electron electron-electron --depth 1 --no-tags --quiet && cd electron-electron && npm install --ignore-scripts @electron/lint-roller typescript@4",
     "clone-test-repos-eslint-eslint": "cd test-repos && git clone https://github.com/eslint/eslint eslint-eslint --depth 1 --no-tags --quiet",
     "clone-test-repos-mdn-content": "cd test-repos && git clone https://github.com/mdn/content mdn-content --depth 1 --no-tags --quiet",
-    "clone-test-repos-mdn-translated-content": "cd test-repos && git clone https://github.com/mdn/translated-content mdn-translated-content --depth 1 --no-tags --quiet",
     "clone-test-repos-mkdocs-mkdocs": "cd test-repos && git clone https://github.com/mkdocs/mkdocs mkdocs-mkdocs --depth 1 --no-tags --quiet",
     "clone-test-repos-mochajs-mocha": "cd test-repos && git clone https://github.com/mochajs/mocha mochajs-mocha --depth 1 --no-tags --quiet",
     "clone-test-repos-pi-hole-docs": "cd test-repos && git clone https://github.com/pi-hole/docs pi-hole-docs --depth 1 --no-tags --quiet",
     "clone-test-repos-v8-v8-dev": "cd test-repos && git clone https://github.com/v8/v8.dev v8-v8-dev --depth 1 --no-tags --quiet",
     "clone-test-repos-webhintio-hint": "cd test-repos && git clone https://github.com/webhintio/hint webhintio-hint --depth 1 --no-tags --quiet",
     "clone-test-repos-webpack-webpack-js-org": "cd test-repos && git clone https://github.com/webpack/webpack.js.org webpack-webpack-js-org --depth 1 --no-tags --quiet",
-    "clone-test-repos": "mkdir test-repos && cd test-repos && npm run clone-test-repos-apache-airflow && npm run clone-test-repos-dotnet-docs && npm run clone-test-repos-electron-electron && npm run clone-test-repos-eslint-eslint && npm run clone-test-repos-mdn-content && npm run clone-test-repos-mdn-translated-content && npm run clone-test-repos-mkdocs-mkdocs && npm run clone-test-repos-mochajs-mocha && npm run clone-test-repos-pi-hole-docs && npm run clone-test-repos-v8-v8-dev && npm run clone-test-repos-webhintio-hint && npm run clone-test-repos-webpack-webpack-js-org",
+    "clone-test-repos": "mkdir test-repos && cd test-repos && npm run clone-test-repos-apache-airflow && npm run clone-test-repos-dotnet-docs && npm run clone-test-repos-electron-electron && npm run clone-test-repos-eslint-eslint && npm run clone-test-repos-mdn-content && npm run clone-test-repos-mkdocs-mkdocs && npm run clone-test-repos-mochajs-mocha && npm run clone-test-repos-pi-hole-docs && npm run clone-test-repos-v8-v8-dev && npm run clone-test-repos-webhintio-hint && npm run clone-test-repos-webpack-webpack-js-org",
     "declaration": "npm run build-declaration && npm run test-declaration",
     "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:16 npm install",
-    "docker-npm-run-upgrade": "docker run --rm --tty --name npm-run-upgrade --volume $PWD:/home/workdir --workdir /home/workdir --user node node:16 npm run upgrade",
+    "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",
     "lint": "eslint --ext .js,.cjs,.mjs --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 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 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --exclude 'test/**' --exclude 'micromark/**' npm test",
+    "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",
     "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",
     "upgrade": "npx --yes npm-check-updates --upgrade"
   },
   "engines": {
-    "node": ">=14.18.0"
+    "node": ">=16"
   },
   "dependencies": {
     "markdown-it": "13.0.1",
-    "markdownlint-micromark": "0.1.2"
+    "markdownlint-micromark": "0.1.7"
   },
   "devDependencies": {
-    "ava": "5.2.0",
-    "babel-loader": "9.1.2",
-    "@babel/core": "7.21.4",
-    "@babel/preset-env": "7.21.4",
-    "c8": "7.13.0",
-    "eslint": "8.39.0",
+    "@babel/core": "7.22.10",
+    "@babel/preset-env": "7.22.10",
+    "ava": "5.3.1",
+    "babel-loader": "9.1.3",
+    "c8": "8.0.1",
+    "character-entities": "2.0.2",
+    "eslint": "8.46.0",
     "eslint-plugin-es": "4.1.0",
-    "eslint-plugin-jsdoc": "43.0.7",
-    "eslint-plugin-n": "15.7.0",
-    "eslint-plugin-regexp": "1.14.0",
-    "eslint-plugin-unicorn": "46.0.0",
-    "globby": "13.1.4",
+    "eslint-plugin-jsdoc": "46.4.6",
+    "eslint-plugin-n": "16.0.1",
+    "eslint-plugin-regexp": "1.15.0",
+    "eslint-plugin-unicorn": "48.0.1",
+    "gemoji": "8.1.0",
+    "globby": "13.2.2",
     "js-yaml": "4.1.0",
     "markdown-it-for-inline": "0.1.1",
     "markdown-it-sub": "1.0.0",
     "markdown-it-sup": "1.0.0",
-    "markdown-it-texmath": "1.0.0",
-    "markdownlint-rule-helpers": "0.19.0",
+    "markdownlint-rule-helpers": "0.20.0",
     "npm-run-all": "4.1.5",
-    "strip-json-comments": "5.0.0",
-    "terser-webpack-plugin": "5.3.7",
+    "strip-json-comments": "5.0.1",
+    "terser-webpack-plugin": "5.3.9",
     "toml": "3.0.0",
     "tv4": "1.3.0",
-    "typescript": "5.0.4",
-    "webpack": "5.81.0",
-    "webpack-cli": "5.0.2",
-    "yaml": "2.2.2"
+    "typescript": "5.1.6",
+    "webpack": "5.88.2",
+    "webpack-cli": "5.1.4",
+    "yaml": "2.3.1"
   },
   "keywords": [
     "markdown",

package/schema/.markdownlint.jsonc

@@ -139,7 +139,7 @@
 
   // MD026/no-trailing-punctuation - Trailing punctuation in heading
   "MD026": {
-    // Punctuation characters not allowed at end of headings
+    // Punctuation characters
     "punctuation": ".,;:!。，；：！"
   },
 
@@ -265,13 +265,13 @@
 
   // MD049/emphasis-style - Emphasis style should be consistent
   "MD049": {
-    // Emphasis style should be consistent
+    // Emphasis style
     "style": "consistent"
   },
 
   // MD050/strong-style - Strong style should be consistent
   "MD050": {
-    // Strong style should be consistent
+    // Strong style
     "style": "consistent"
   },
 

package/schema/.markdownlint.yaml

@@ -127,7 +127,7 @@ MD025:
 
 # MD026/no-trailing-punctuation - Trailing punctuation in heading
 MD026:
-  # Punctuation characters not allowed at end of headings
+  # Punctuation characters
   punctuation: ".,;:!。，；：！"
 
 # MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol
@@ -240,12 +240,12 @@ MD048:
 
 # MD049/emphasis-style - Emphasis style should be consistent
 MD049:
-  # Emphasis style should be consistent
+  # Emphasis style
   style: "consistent"
 
 # MD050/strong-style - Strong style should be consistent
 MD050:
-  # Strong style should be consistent
+  # Strong style
   style: "consistent"
 
 # MD051/link-fragments - Link fragments should be valid

package/schema/markdownlint-config-schema.json

@@ -361,14 +361,26 @@
       "properties": {
         "lines_above": {
           "description": "Blank lines above heading",
-          "type": "integer",
-          "minimum": 0,
+          "type": [
+            "integer",
+            "array"
+          ],
+          "items": {
+            "type": "integer"
+          },
+          "minimum": -1,
           "default": 1
         },
         "lines_below": {
           "description": "Blank lines below heading",
-          "type": "integer",
-          "minimum": 0,
+          "type": [
+            "integer",
+            "array"
+          ],
+          "items": {
+            "type": "integer"
+          },
+          "minimum": -1,
           "default": 1
         }
       },
@@ -456,7 +468,7 @@
       "default": true,
       "properties": {
         "punctuation": {
-          "description": "Punctuation characters not allowed at end of headings",
+          "description": "Punctuation characters",
           "type": "string",
           "default": ".,;:!。，；：！"
         }
@@ -876,7 +888,7 @@
       "default": true,
       "properties": {
         "style": {
-          "description": "Emphasis style should be consistent",
+          "description": "Emphasis style",
           "type": "string",
           "enum": [
             "consistent",
@@ -900,7 +912,7 @@
       "default": true,
       "properties": {
         "style": {
-          "description": "Strong style should be consistent",
+          "description": "Strong style",
           "type": "string",
           "enum": [
             "consistent",