markdownlint 0.24.0 → 0.25.0

package/lib/md010.js

@@ -2,8 +2,8 @@
 
 "use strict";
 
-const { addError, forEachLine } = require("../helpers");
-const { lineMetadata } = require("./cache");
+const { addError, forEachLine, overlapsAnyRange } = require("../helpers");
+const { codeBlockAndSpanRanges, lineMetadata } = require("./cache");
 
 const tabRe = /\t+/g;
 
@@ -13,28 +13,33 @@ module.exports = {
   "tags": [ "whitespace", "hard_tab" ],
   "function": function MD010(params, onError) {
     const codeBlocks = params.config.code_blocks;
-    const includeCodeBlocks = (codeBlocks === undefined) ? true : !!codeBlocks;
+    const includeCode = (codeBlocks === undefined) ? true : !!codeBlocks;
     const spacesPerTab = params.config.spaces_per_tab;
     const spaceMultiplier = (spacesPerTab === undefined) ?
       1 :
       Math.max(0, Number(spacesPerTab));
+    const exclusions = includeCode ? [] : codeBlockAndSpanRanges();
     forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
-      if (!inCode || includeCodeBlocks) {
+      if (includeCode || !inCode) {
         let match = null;
         while ((match = tabRe.exec(line)) !== null) {
-          const column = match.index + 1;
+          const { index } = match;
+          const column = index + 1;
           const length = match[0].length;
-          addError(
-            onError,
-            lineIndex + 1,
-            "Column: " + column,
-            null,
-            [ column, length ],
-            {
-              "editColumn": column,
-              "deleteCount": length,
-              "insertText": "".padEnd(length * spaceMultiplier)
-            });
+          if (!overlapsAnyRange(exclusions, lineIndex, index, length)) {
+            addError(
+              onError,
+              lineIndex + 1,
+              "Column: " + column,
+              null,
+              [ column, length ],
+              {
+                "editColumn": column,
+                "deleteCount": length,
+                "insertText": "".padEnd(length * spaceMultiplier)
+              }
+            );
+          }
         }
       }
     });

package/lib/md011.js

@@ -3,7 +3,7 @@
 "use strict";
 
 const { addError, forEachLine, overlapsAnyRange } = require("../helpers");
-const { inlineCodeSpanRanges, lineMetadata } = require("./cache");
+const { codeBlockAndSpanRanges, lineMetadata } = require("./cache");
 
 const reversedLinkRe =
   /(^|[^\\])\(([^)]+)\)\[([^\]^][^\]]*)](?!\()/g;
@@ -13,7 +13,7 @@ module.exports = {
   "description": "Reversed link syntax",
   "tags": [ "links" ],
   "function": function MD011(params, onError) {
-    const exclusions = inlineCodeSpanRanges();
+    const exclusions = codeBlockAndSpanRanges();
     forEachLine(lineMetadata(), (line, lineIndex, inCode, onFence) => {
       if (!inCode && !onFence) {
         let match = null;

package/lib/md033.js

@@ -2,12 +2,13 @@
 
 "use strict";
 
-const { addError, forEachLine, unescapeMarkdown } = require("../helpers");
-const { lineMetadata } = require("./cache");
+const {
+  addError, forEachLine, overlapsAnyRange, unescapeMarkdown
+} = require("../helpers");
+const { codeBlockAndSpanRanges, lineMetadata } = require("./cache");
 
 const htmlElementRe = /<(([A-Za-z][A-Za-z0-9-]*)(?:\s[^>]*)?)\/?>/g;
 const linkDestinationRe = /]\(\s*$/;
-const inlineCodeRe = /^[^`]*(`+[^`]+`+[^`]+)*`+[^`]*$/;
 // See https://spec.commonmark.org/0.29/#autolinks
 const emailAddressRe =
   // eslint-disable-next-line max-len
@@ -21,19 +22,22 @@ module.exports = {
     let allowedElements = params.config.allowed_elements;
     allowedElements = Array.isArray(allowedElements) ? allowedElements : [];
     allowedElements = allowedElements.map((element) => element.toLowerCase());
+    const exclusions = codeBlockAndSpanRanges();
     forEachLine(lineMetadata(), (line, lineIndex, inCode) => {
       let match = null;
       // eslint-disable-next-line no-unmodified-loop-condition
       while (!inCode && ((match = htmlElementRe.exec(line)) !== null)) {
         const [ tag, content, element ] = match;
-        if (!allowedElements.includes(element.toLowerCase()) &&
+        if (
+          !allowedElements.includes(element.toLowerCase()) &&
           !tag.endsWith("\\>") &&
-          !emailAddressRe.test(content)) {
+          !emailAddressRe.test(content) &&
+          !overlapsAnyRange(exclusions, lineIndex, match.index, match[0].length)
+        ) {
           const prefix = line.substring(0, match.index);
-          if (!linkDestinationRe.test(prefix) && !inlineCodeRe.test(prefix)) {
+          if (!linkDestinationRe.test(prefix)) {
             const unescaped = unescapeMarkdown(prefix + "<", "_");
-            if (!unescaped.endsWith("_") &&
-              ((unescaped + "`").match(/`/g).length % 2)) {
+            if (!unescaped.endsWith("_")) {
               addError(onError, lineIndex + 1, "Element: " + element,
                 null, [ match.index + 1, tag.length ]);
             }

package/lib/md035.js

@@ -10,12 +10,12 @@ module.exports = {
   "tags": [ "hr" ],
   "function": function MD035(params, onError) {
     let style = String(params.config.style || "consistent");
-    filterTokens(params, "hr", function forToken(token) {
-      const lineTrim = token.line.trim();
+    filterTokens(params, "hr", (token) => {
+      const { lineNumber, markup } = token;
       if (style === "consistent") {
-        style = lineTrim;
+        style = markup;
       }
-      addErrorDetailIf(onError, token.lineNumber, style, lineTrim);
+      addErrorDetailIf(onError, lineNumber, style, markup);
     });
   }
 };

package/lib/md037.js

@@ -7,6 +7,7 @@ const { addErrorContext, emphasisMarkersInContent, forEachLine, isBlankLine } =
 const { lineMetadata } = require("./cache");
 
 const emphasisRe = /(^|[^\\]|\\\\)(?:(\*\*?\*?)|(__?_?))/g;
+const embeddedUnderscoreRe = /([A-Za-z0-9])_([A-Za-z0-9])/g;
 const asteriskListItemMarkerRe = /^([\s>]*)\*(\s+)/;
 const leftSpaceRe = /^\s+/;
 const rightSpaceRe = /\s+$/;
@@ -98,14 +99,15 @@ module.exports = {
           // Emphasis has no meaning here
           return;
         }
+        let patchedLine = line.replace(embeddedUnderscoreRe, "$1 $2");
         if (onItemStart) {
           // Trim overlapping '*' list item marker
-          line = line.replace(asteriskListItemMarkerRe, "$1 $2");
+          patchedLine = patchedLine.replace(asteriskListItemMarkerRe, "$1 $2");
         }
         let match = null;
         // Match all emphasis-looking runs in the line...
-        while ((match = emphasisRe.exec(line))) {
-          const ignoreMarkersForLine = ignoreMarkersByLine[lineIndex] || [];
+        while ((match = emphasisRe.exec(patchedLine))) {
+          const ignoreMarkersForLine = ignoreMarkersByLine[lineIndex];
           const matchIndex = match.index + match[1].length;
           if (ignoreMarkersForLine.includes(matchIndex)) {
             // Ignore emphasis markers inside code spans and links

package/lib/md039.js

@@ -4,7 +4,8 @@
 
 const { addErrorContext, filterTokens } = require("../helpers");
 
-const spaceInLinkRe = /\[(?:\s+(?:[^\]]*?)\s*|(?:[^\]]*?)\s+)](?=\(\S*\))/;
+const spaceInLinkRe =
+  /\[(?:\s+(?:[^\]]*?)\s*|(?:[^\]]*?)\s+)](?=((?:\([^)]*\))|(?:\[[^\]]*\])))/;
 
 module.exports = {
   "names": [ "MD039", "no-space-in-links" ],

package/lib/md043.js

@@ -20,7 +20,6 @@ module.exports = {
       let matchAny = false;
       let hasError = false;
       let anyHeadings = false;
-      // eslint-disable-next-line func-style
       const getExpected = () => requiredHeadings[i++] || "[None]";
       forEachHeading(params, (heading, content) => {
         if (!hasError) {

package/lib/md044.js

@@ -4,7 +4,7 @@
 
 const { addErrorDetailIf, bareUrlRe, escapeForRegExp, forEachLine,
   overlapsAnyRange, linkRe, linkReferenceRe } = require("../helpers");
-const { inlineCodeSpanRanges, lineMetadata } = require("./cache");
+const { codeBlockAndSpanRanges, lineMetadata } = require("./cache");
 
 module.exports = {
   "names": [ "MD044", "proper-names" ],
@@ -36,7 +36,7 @@ module.exports = {
       }
     });
     if (!includeCodeBlocks) {
-      exclusions.push(...inlineCodeSpanRanges());
+      exclusions.push(...codeBlockAndSpanRanges());
     }
     for (const name of names) {
       const escapedName = escapeForRegExp(name);

package/lib/md049.js

@@ -0,0 +1,45 @@
+// @ts-check
+
+"use strict";
+
+const { addError, emphasisOrStrongStyleFor, forEachInlineChild,
+  getNextChildToken, getRangeAndFixInfoIfFound } = require("../helpers");
+
+module.exports = {
+  "names": [ "MD049", "emphasis-style" ],
+  "description": "Emphasis style should be consistent",
+  "tags": [ "emphasis" ],
+  "function": function MD049(params, onError) {
+    let expectedStyle = String(params.config.style || "consistent");
+    forEachInlineChild(params, "em_open", (token, parent) => {
+      const { lineNumber, markup } = token;
+      const markupStyle = emphasisOrStrongStyleFor(markup);
+      if (expectedStyle === "consistent") {
+        expectedStyle = markupStyle;
+      }
+      if (expectedStyle !== markupStyle) {
+        let rangeAndFixInfo = {};
+        const contentToken = getNextChildToken(
+          parent, token, "text", "em_close"
+        );
+        if (contentToken) {
+          const { content } = contentToken;
+          const actual = `${markup}${content}${markup}`;
+          const expectedMarkup = (expectedStyle === "asterisk") ? "*" : "_";
+          const expected = `${expectedMarkup}${content}${expectedMarkup}`;
+          rangeAndFixInfo = getRangeAndFixInfoIfFound(
+            params.lines, lineNumber - 1, actual, expected
+          );
+        }
+        addError(
+          onError,
+          lineNumber,
+          `Expected: ${expectedStyle}; Actual: ${markupStyle}`,
+          null,
+          rangeAndFixInfo.range,
+          rangeAndFixInfo.fixInfo
+        );
+      }
+    });
+  }
+};

package/lib/md050.js

@@ -0,0 +1,45 @@
+// @ts-check
+
+"use strict";
+
+const { addError, emphasisOrStrongStyleFor, forEachInlineChild,
+  getNextChildToken, getRangeAndFixInfoIfFound } = require("../helpers");
+
+module.exports = {
+  "names": [ "MD050", "strong-style" ],
+  "description": "Strong style should be consistent",
+  "tags": [ "emphasis" ],
+  "function": function MD050(params, onError) {
+    let expectedStyle = String(params.config.style || "consistent");
+    forEachInlineChild(params, "strong_open", (token, parent) => {
+      const { lineNumber, markup } = token;
+      const markupStyle = emphasisOrStrongStyleFor(markup);
+      if (expectedStyle === "consistent") {
+        expectedStyle = markupStyle;
+      }
+      if (expectedStyle !== markupStyle) {
+        let rangeAndFixInfo = {};
+        const contentToken = getNextChildToken(
+          parent, token, "text", "strong_close"
+        );
+        if (contentToken) {
+          const { content } = contentToken;
+          const actual = `${markup}${content}${markup}`;
+          const expectedMarkup = (expectedStyle === "asterisk") ? "**" : "__";
+          const expected = `${expectedMarkup}${content}${expectedMarkup}`;
+          rangeAndFixInfo = getRangeAndFixInfoIfFound(
+            params.lines, lineNumber - 1, actual, expected
+          );
+        }
+        addError(
+          onError,
+          lineNumber,
+          `Expected: ${expectedStyle}; Actual: ${markupStyle}`,
+          null,
+          rangeAndFixInfo.range,
+          rangeAndFixInfo.fixInfo
+        );
+      }
+    });
+  }
+};

package/lib/rules.js

@@ -2,9 +2,7 @@
 
 "use strict";
 
-const packageJson = require("../package.json");
-const homepage = packageJson.homepage;
-const version = packageJson.version;
+const { homepage, version } = require("./constants");
 
 const rules = [
   require("./md001"),
@@ -50,7 +48,9 @@ const rules = [
   require("./md045"),
   require("./md046"),
   require("./md047"),
-  require("./md048")
+  require("./md048"),
+  require("./md049"),
+  require("./md050")
 ];
 rules.forEach((rule) => {
   const name = rule.names[0].toLowerCase();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint",
-  "version": "0.24.0",
+  "version": "0.25.0",
   "description": "A Node.js style checker and lint tool for Markdown/CommonMark files.",
   "main": "lib/markdownlint.js",
   "types": "lib/markdownlint.d.ts",
@@ -16,11 +16,10 @@
     "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 --resolveJsonModule lib/markdownlint.js && rimraf 'lib/{c,md,r}*.d.ts' 'helpers/*.d.ts'",
-    "build-demo": "cpy node_modules/markdown-it/dist/markdown-it.min.js demo && cd demo && rimraf markdownlint-browser.* && webpack --no-stats",
+    "build-declaration": "tsc --allowJs --declaration --emitDeclarationOnly --resolveJsonModule lib/markdownlint.js && node scripts delete 'lib/{c,md,r}*.d.ts' 'helpers/*.d.ts'",
+    "build-demo": "node scripts copy node_modules/markdown-it/dist/markdown-it.min.js demo/markdown-it.min.js && cd demo && webpack --no-stats",
     "build-example": "npm install --no-save --ignore-scripts grunt grunt-cli gulp through2",
-    "ci": "npm-run-all --continue-on-error --parallel test-cover lint declaration build-config build-demo && git diff --exit-code",
-    "clean-test-repos": "rimraf test-repos",
+    "ci": "npm-run-all --continue-on-error --parallel build-config lint serial-declaration-demo test-cover && git diff --exit-code",
     "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-eslint-eslint": "cd test-repos && git clone https://github.com/eslint/eslint eslint-eslint --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",
@@ -33,43 +32,46 @@
     "clone-test-repos-large": "npm run clone-test-repos && cd test-repos && npm run clone-test-repos-dotnet-docs && npm run clone-test-repos-v8-v8-dev",
     "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",
     "lint": "eslint --max-warnings 0 .",
     "lint-test-repos": "ava --timeout=5m test/markdownlint-test-repos.js",
-    "test": "ava test/markdownlint-test.js test/markdownlint-test-custom-rules.js test/markdownlint-test-helpers.js test/markdownlint-test-result-object.js test/markdownlint-test-scenarios.js",
+    "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-result-object.js test/markdownlint-test-scenarios.js",
     "test-cover": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 npm test",
     "test-declaration": "cd example/typescript && tsc && node type-check.js",
-    "test-extra": "ava --timeout=5m test/markdownlint-test-extra.js"
+    "test-extra": "ava --timeout=5m test/markdownlint-test-extra-parse.js test/markdownlint-test-extra-type.js",
+    "upgrade": "npx npm-check-updates --upgrade"
   },
   "engines": {
-    "node": ">=10"
+    "node": ">=12"
   },
   "dependencies": {
-    "markdown-it": "12.2.0"
+    "markdown-it": "12.3.0"
   },
   "devDependencies": {
     "ava": "~3.15.0",
-    "c8": "~7.8.0",
-    "cpy-cli": "~3.1.1",
-    "eslint": "~7.32.0",
-    "eslint-plugin-jsdoc": "~36.0.7",
+    "c8": "~7.10.0",
+    "eslint": "~8.5.0",
+    "eslint-plugin-jsdoc": "~37.4.0",
     "eslint-plugin-node": "~11.1.0",
-    "eslint-plugin-unicorn": "~35.0.0",
-    "globby": "~11.0.4",
+    "eslint-plugin-unicorn": "~39.0.0",
+    "globby": "~12.0.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": "~0.9.1",
-    "markdownlint-rule-helpers": "~0.14.0",
+    "markdown-it-texmath": "~0.9.7",
+    "markdownlint-rule-github-internal-links": "~0.1.0",
+    "markdownlint-rule-helpers": "~0.15.0",
     "npm-run-all": "~4.1.5",
-    "rimraf": "~3.0.2",
-    "strip-json-comments": "~3.1.1",
+    "strip-json-comments": "~4.0.0",
     "toml": "~3.0.0",
-    "ts-loader": "~9.2.5",
+    "ts-loader": "~9.2.6",
     "tv4": "~1.3.0",
-    "typescript": "~4.3.5",
-    "webpack": "~5.51.1",
-    "webpack-cli": "~4.8.0"
+    "typescript": "~4.5.4",
+    "webpack": "~5.65.0",
+    "webpack-cli": "~4.9.1"
   },
   "keywords": [
     "markdown",

package/schema/.markdownlint.jsonc

@@ -39,7 +39,9 @@
     // Spaces for indent
     "indent": 2,
     // Whether to indent the first level of the list
-    "start_indented": false
+    "start_indented": false,
+    // Spaces for first level indent (when start_indented is set)
+    "start_indent": 2
   },
 
   // MD009/no-trailing-spaces - Trailing spaces
@@ -248,5 +250,17 @@
   "MD048": {
     // Code fence style
     "style": "consistent"
+  },
+
+  // MD049/emphasis-style - Emphasis style should be consistent
+  "MD049": {
+    // Emphasis style should be consistent
+    "style": "consistent"
+  },
+
+  // MD050/strong-style - Strong style should be consistent
+  "MD050": {
+    // Strong style should be consistent
+    "style": "consistent"
   }
 }

package/schema/.markdownlint.yaml

@@ -36,6 +36,8 @@ MD007:
   indent: 2
   # Whether to indent the first level of the list
   start_indented: false
+  # Spaces for first level indent (when start_indented is set)
+  start_indent: 2
 
 # MD009/no-trailing-spaces - Trailing spaces
 MD009:
@@ -224,4 +226,14 @@ MD047: true
 # MD048/code-fence-style - Code fence style
 MD048:
   # Code fence style
+  style: "consistent"
+
+# MD049/emphasis-style - Emphasis style should be consistent
+MD049:
+  # Emphasis style should be consistent
+  style: "consistent"
+
+# MD050/strong-style - Strong style should be consistent
+MD050:
+  # Strong style should be consistent
   style: "consistent"

package/schema/markdownlint-config-schema.json

@@ -238,6 +238,11 @@
           "description": "Whether to indent the first level of the list",
           "type": "boolean",
           "default": false
+        },
+        "start_indent": {
+          "description": "Spaces for first level indent (when start_indented is set)",
+          "type": "integer",
+          "default": 2
         }
       },
       "additionalProperties": false
@@ -259,6 +264,11 @@
           "description": "Whether to indent the first level of the list",
           "type": "boolean",
           "default": false
+        },
+        "start_indent": {
+          "description": "Spaces for first level indent (when start_indented is set)",
+          "type": "integer",
+          "default": 2
         }
       },
       "additionalProperties": false
@@ -1439,6 +1449,90 @@
       },
       "additionalProperties": false
     },
+    "MD049": {
+      "description": "MD049/emphasis-style - Emphasis style should be consistent",
+      "type": [
+        "boolean",
+        "object"
+      ],
+      "default": true,
+      "properties": {
+        "style": {
+          "description": "Emphasis style should be consistent",
+          "type": "string",
+          "enum": [
+            "consistent",
+            "asterisk",
+            "underscore"
+          ],
+          "default": "consistent"
+        }
+      },
+      "additionalProperties": false
+    },
+    "emphasis-style": {
+      "description": "MD049/emphasis-style - Emphasis style should be consistent",
+      "type": [
+        "boolean",
+        "object"
+      ],
+      "default": true,
+      "properties": {
+        "style": {
+          "description": "Emphasis style should be consistent",
+          "type": "string",
+          "enum": [
+            "consistent",
+            "asterisk",
+            "underscore"
+          ],
+          "default": "consistent"
+        }
+      },
+      "additionalProperties": false
+    },
+    "MD050": {
+      "description": "MD050/strong-style - Strong style should be consistent",
+      "type": [
+        "boolean",
+        "object"
+      ],
+      "default": true,
+      "properties": {
+        "style": {
+          "description": "Strong style should be consistent",
+          "type": "string",
+          "enum": [
+            "consistent",
+            "asterisk",
+            "underscore"
+          ],
+          "default": "consistent"
+        }
+      },
+      "additionalProperties": false
+    },
+    "strong-style": {
+      "description": "MD050/strong-style - Strong style should be consistent",
+      "type": [
+        "boolean",
+        "object"
+      ],
+      "default": true,
+      "properties": {
+        "style": {
+          "description": "Strong style should be consistent",
+          "type": "string",
+          "enum": [
+            "consistent",
+            "asterisk",
+            "underscore"
+          ],
+          "default": "consistent"
+        }
+      },
+      "additionalProperties": false
+    },
     "headings": {
       "description": "headings - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043",
       "type": "boolean",
@@ -1535,7 +1629,7 @@
       "default": true
     },
     "emphasis": {
-      "description": "emphasis - MD036, MD037",
+      "description": "emphasis - MD036, MD037, MD049, MD050",
       "type": "boolean",
       "default": true
     },