markdownlint 0.26.1 → 0.27.0

package/lib/md051.js

@@ -2,11 +2,12 @@
 
 "use strict";
 
-const { addError, escapeForRegExp, filterTokens, forEachInlineChild,
-  forEachHeading, htmlElementRe } = require("../helpers");
+const { addError, addErrorDetailIf, escapeForRegExp, filterTokens,
+  forEachInlineChild, forEachHeading, htmlElementRe } = require("../helpers");
 
 // Regular expression for identifying HTML anchor names
-const identifierRe = /(?:id|name)\s*=\s*['"]?([^'"\s>]+)/iu;
+const idRe = /\sid\s*=\s*['"]?([^'"\s>]+)/iu;
+const nameRe = /\sname\s*=\s*['"]?([^'"\s>]+)/iu;
 
 /**
  * Converts a Markdown heading into an HTML fragment according to the rules
@@ -55,11 +56,10 @@ module.exports = {
       let match = null;
       while ((match = htmlElementRe.exec(token.content)) !== null) {
         const [ tag, , element ] = match;
-        if (element.toLowerCase() === "a") {
-          const idMatch = identifierRe.exec(tag);
-          if (idMatch) {
-            fragments.set(`#${idMatch[1]}`, 0);
-          }
+        const anchorMatch = idRe.exec(tag) ||
+            (element.toLowerCase() === "a" && nameRe.exec(tag));
+        if (anchorMatch) {
+          fragments.set(`#${anchorMatch[1]}`, 0);
         }
       }
     };
@@ -73,14 +73,46 @@ module.exports = {
       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[0];
-          range = [ match.index + 1, match[0].length ];
+          [ 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
+          );
         }
-        addError(onError, lineNumber, undefined, context, range);
       }
     });
   }

package/lib/md053.js

@@ -11,7 +11,8 @@ module.exports = {
   "description": "Link and image reference definitions should be needed",
   "tags": [ "images", "links" ],
   "function": function MD053(params, onError) {
-    const { lines } = params;
+    const ignored = new Set(params.config.ignored_definitions || [ "//" ]);
+    const lines = params.lines;
     const { references, shortcuts, definitions, duplicateDefinitions } =
       referenceLinkImageData();
     const singleLineDefinition = (line) => (
@@ -23,7 +24,11 @@ module.exports = {
     // Look for unused link references (unreferenced by any link/image)
     for (const definition of definitions.entries()) {
       const [ label, lineIndex ] = definition;
-      if (!references.has(label) && !shortcuts.has(label)) {
+      if (
+        !ignored.has(label) &&
+        !references.has(label) &&
+        !shortcuts.has(label)
+      ) {
         const line = lines[lineIndex];
         addError(
           onError,
@@ -38,15 +43,17 @@ module.exports = {
     // Look for duplicate link references (defined more than once)
     for (const duplicateDefinition of duplicateDefinitions) {
       const [ label, lineIndex ] = duplicateDefinition;
-      const line = lines[lineIndex];
-      addError(
-        onError,
-        lineIndex + 1,
-        `Duplicate link or image reference definition: "${label}"`,
-        ellipsify(line),
-        [ 1, line.length ],
-        singleLineDefinition(line) ? deleteFixInfo : 0
-      );
+      if (!ignored.has(label)) {
+        const line = lines[lineIndex];
+        addError(
+          onError,
+          lineIndex + 1,
+          `Duplicate link or image reference definition: "${label}"`,
+          ellipsify(line),
+          [ 1, line.length ],
+          singleLineDefinition(line) ? deleteFixInfo : 0
+        );
+      }
     }
   }
 };

package/lib/rules.js

@@ -58,6 +58,6 @@ for (const rule of rules) {
   const name = rule.names[0].toLowerCase();
   // eslint-disable-next-line dot-notation
   rule["information"] =
-    new URL(`${homepage}/blob/v${version}/doc/Rules.md#${name}`);
+    new URL(`${homepage}/blob/v${version}/doc/${name}.md`);
 }
 module.exports = rules;

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "markdownlint",
-  "version": "0.26.1",
+  "version": "0.27.0",
   "description": "A Node.js style checker and lint tool for Markdown/CommonMark files.",
   "type": "commonjs",
   "main": "./lib/markdownlint.js",
   "exports": {
     ".": "./lib/markdownlint.js",
-    "./helpers": "./helpers/helpers.js"
+    "./helpers": "./helpers/helpers.js",
+    "./style/all": "./style/all.json",
+    "./style/cirosantilli": "./style/cirosantilli.json",
+    "./style/prettier": "./style/prettier.json",
+    "./style/relaxed": "./style/relaxed.json"
   },
   "types": "./lib/markdownlint.d.ts",
   "author": "David Anson (https://dlaa.me/)",
@@ -23,24 +27,28 @@
     "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' '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-docs": "node doc-build/build-rules.mjs",
     "build-example": "npm install --no-save --ignore-scripts grunt grunt-cli gulp through2",
-    "ci": "npm-run-all --continue-on-error --parallel build-config lint serial-declaration-demo test-cover && git diff --exit-code",
+    "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-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-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-eslint-eslint && 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-webhintio-hint && npm run clone-test-repos-webpack-webpack-js-org",
-    "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",
+    "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",
-    "lint": "eslint --max-warnings 0 .",
+    "lint": "eslint --ext .js,.mjs --max-warnings 0 .",
     "lint-test-repos": "ava --timeout=5m 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-result-object.js test/markdownlint-test-scenarios.js",
     "test-cover": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 npm test",
@@ -50,35 +58,37 @@
     "upgrade": "npx --yes npm-check-updates --upgrade"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=14.18.0"
   },
   "dependencies": {
     "markdown-it": "13.0.1"
   },
   "devDependencies": {
-    "ava": "4.3.0",
-    "c8": "7.11.3",
-    "eslint": "8.18.0",
+    "ava": "5.1.0",
+    "c8": "7.12.0",
+    "eslint": "8.30.0",
     "eslint-plugin-es": "4.1.0",
-    "eslint-plugin-jsdoc": "39.3.3",
-    "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-unicorn": "42.0.0",
-    "globby": "13.1.2",
+    "eslint-plugin-jsdoc": "39.6.4",
+    "eslint-plugin-n": "15.6.0",
+    "eslint-plugin-regexp": "1.11.0",
+    "eslint-plugin-unicorn": "45.0.2",
+    "globby": "13.1.3",
     "js-yaml": "4.1.0",
+    "markdown-it-footnote": "3.0.3",
     "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-github-internal-links": "0.1.0",
-    "markdownlint-rule-helpers": "0.16.0",
+    "markdownlint-rule-helpers": "0.17.2",
     "npm-run-all": "4.1.5",
-    "strip-json-comments": "4.0.0",
+    "strip-json-comments": "5.0.0",
+    "terser-webpack-plugin": "5.3.6",
     "toml": "3.0.0",
-    "ts-loader": "9.3.0",
+    "ts-loader": "9.4.2",
     "tv4": "1.3.0",
-    "typescript": "4.7.4",
-    "webpack": "5.73.0",
-    "webpack-cli": "4.10.0"
+    "typescript": "4.9.4",
+    "webpack": "5.75.0",
+    "webpack-cli": "5.0.1"
   },
   "keywords": [
     "markdown",

package/schema/.markdownlint.jsonc

@@ -139,7 +139,7 @@
 
   // MD026/no-trailing-punctuation - Trailing punctuation in heading
   "MD026": {
-    // Punctuation characters
+    // Punctuation characters not allowed at end of headings
     "punctuation": ".,;:!。，；：！"
   },
 
@@ -207,7 +207,12 @@
   "MD039": true,
 
   // MD040/fenced-code-language - Fenced code blocks should have a language specified
-  "MD040": true,
+  "MD040": {
+    // List of languages
+    "allowed_languages": [],
+    // Require language only
+    "language_only": false
+  },
 
   // MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading
   "MD041": {
@@ -225,7 +230,9 @@
     // List of headings
     "headings": [],
     // List of headings
-    "headers": []
+    "headers": [],
+    // Match case of headings
+    "match_case": false
   },
 
   // MD044/proper-names - Proper names should have the correct capitalization
@@ -275,5 +282,10 @@
   "MD052": true,
 
   // MD053/link-image-reference-definitions - Link and image reference definitions should be needed
-  "MD053": true
+  "MD053": {
+    // Ignored definitions
+    "ignored_definitions": [
+      "//"
+    ]
+  }
 }

package/schema/.markdownlint.yaml

@@ -127,7 +127,7 @@ MD025:
 
 # MD026/no-trailing-punctuation - Trailing punctuation in heading
 MD026:
-  # Punctuation characters
+  # Punctuation characters not allowed at end of headings
   punctuation: ".,;:!。，；：！"
 
 # MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol
@@ -188,7 +188,11 @@ MD038: true
 MD039: true
 
 # MD040/fenced-code-language - Fenced code blocks should have a language specified
-MD040: true
+MD040:
+  # List of languages
+  allowed_languages: []
+  # Require language only
+  language_only: false
 
 # MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading
 MD041:
@@ -206,6 +210,8 @@ MD043:
   headings: []
   # List of headings
   headers: []
+  # Match case of headings
+  match_case: false
 
 # MD044/proper-names - Proper names should have the correct capitalization
 MD044:
@@ -249,4 +255,8 @@ MD051: true
 MD052: true
 
 # MD053/link-image-reference-definitions - Link and image reference definitions should be needed
-MD053: true
+MD053:
+  # Ignored definitions
+  ignored_definitions: [
+    "//"
+  ]

package/schema/markdownlint-config-schema.json

@@ -456,7 +456,7 @@
       "default": true,
       "properties": {
         "punctuation": {
-          "description": "Punctuation characters",
+          "description": "Punctuation characters not allowed at end of headings",
           "type": "string",
           "default": ".,;:!。，；：！"
         }
@@ -669,8 +669,27 @@
     },
     "MD040": {
       "description": "MD040/fenced-code-language - Fenced code blocks should have a language specified",
-      "type": "boolean",
-      "default": true
+      "type": [
+        "boolean",
+        "object"
+      ],
+      "default": true,
+      "properties": {
+        "allowed_languages": {
+          "description": "List of languages",
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "default": []
+        },
+        "language_only": {
+          "description": "Require language only",
+          "type": "boolean",
+          "default": false
+        }
+      },
+      "additionalProperties": false
     },
     "fenced-code-language": {
       "$ref": "#/properties/MD040"
@@ -737,6 +756,11 @@
             "pattern": "^(\\*|\\+|#{1,6} .*)$"
           },
           "default": []
+        },
+        "match_case": {
+          "description": "Match case of headings",
+          "type": "boolean",
+          "default": false
         }
       },
       "additionalProperties": false
@@ -909,8 +933,24 @@
     },
     "MD053": {
       "description": "MD053/link-image-reference-definitions - Link and image reference definitions should be needed",
-      "type": "boolean",
-      "default": true
+      "type": [
+        "boolean",
+        "object"
+      ],
+      "default": true,
+      "properties": {
+        "ignored_definitions": {
+          "description": "Ignored definitions",
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "default": [
+            "//"
+          ]
+        }
+      },
+      "additionalProperties": false
     },
     "link-image-reference-definitions": {
       "$ref": "#/properties/MD053"

package/style/prettier.json

@@ -0,0 +1,26 @@
+{
+  "comment": "Disables rules that may conflict with Prettier",
+
+  "blanks-around-fences": false,
+  "blanks-around-headings": false,
+  "blanks-around-lists": false,
+  "code-fence-style": false,
+  "emphasis-style": false,
+  "heading-start-left": false,
+  "hr-style": false,
+  "line-length": false,
+  "list-indent": false,
+  "list-marker-space": false,
+  "no-blanks-blockquote": false,
+  "no-hard-tabs": false,
+  "no-missing-space-atx": false,
+  "no-missing-space-closed-atx": false,
+  "no-multiple-blanks": false,
+  "no-multiple-space-atx": false,
+  "no-multiple-space-blockquote": false,
+  "no-multiple-space-closed-atx": false,
+  "no-trailing-spaces": false,
+  "ol-prefix": false,
+  "strong-style": false,
+  "ul-indent": false
+}