markdownlint 0.23.0 → 0.23.1

package/README.md

@@ -940,6 +940,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
 * 0.23.0 - Add comprehensive example `.markdownlint.jsonc`/`.markdownlint.yaml` files, add fix
            information for MD004/ul-style, improve MD018/MD019/MD020/MD021/MD037/MD041, improve
            HTML comment handling, update test runner and test suite, update dependencies.
+  * 0.23.1 - Work around lack of webpack support for dynamic calls to `require` (`.resolve`).
 
 [npm-image]: https://img.shields.io/npm/v/markdownlint.svg
 [npm-url]: https://www.npmjs.com/package/markdownlint

package/demo/markdownlint-browser.js

@@ -1,4 +1,4 @@
-/*! markdownlint 0.23.0 https://github.com/DavidAnson/markdownlint @license MIT */
+/*! markdownlint 0.23.1 https://github.com/DavidAnson/markdownlint @license MIT */
 var markdownlint;markdownlint =
 /******/ (() => { // webpackBootstrap
 /******/ 	var __webpack_modules__ = ({
@@ -783,6 +783,10 @@ var markdownIt = __webpack_require__(/*! markdown-it */ "markdown-it");
 var rules = __webpack_require__(/*! ./rules */ "../lib/rules.js");
 var helpers = __webpack_require__(/*! ../helpers */ "../helpers/helpers.js");
 var cache = __webpack_require__(/*! ./cache */ "../lib/cache.js");
+// @ts-ignore
+// eslint-disable-next-line camelcase, max-len, no-inline-comments, no-undef
+var dynamicRequire = (typeof require === "undefined") ? __webpack_require__("../lib sync recursive") : /* c8 ignore next */ require;
+// Capture native require implementation for dynamic loading of modules
 var deprecatedRuleNames = ["MD002", "MD006"];
 /**
  * Validate the list of rules for structure and reuse.
@@ -1616,7 +1620,7 @@ function resolveConfigExtends(configFile, referenceId) {
         // If not a file or fs.statSync throws, try require.resolve
     }
     try {
-        return __webpack_require__("../lib sync recursive").resolve(referenceId, { "paths": [configFileDirname] });
+        return dynamicRequire.resolve(referenceId, { "paths": [configFileDirname] });
     }
     catch (_b) {
         // If require.resolve throws, return resolvedExtendsFile
@@ -4015,7 +4019,7 @@ module.exports = rules;
 /***/ ((module) => {
 
 "use strict";
-module.exports = JSON.parse("{\"name\":\"markdownlint\",\"version\":\"0.23.0\",\"description\":\"A Node.js style checker and lint tool for Markdown/CommonMark files.\",\"main\":\"lib/markdownlint.js\",\"types\":\"lib/markdownlint.d.ts\",\"author\":\"David Anson (https://dlaa.me/)\",\"license\":\"MIT\",\"homepage\":\"https://github.com/DavidAnson/markdownlint\",\"repository\":{\"type\":\"git\",\"url\":\"https://github.com/DavidAnson/markdownlint.git\"},\"bugs\":\"https://github.com/DavidAnson/markdownlint/issues\",\"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 --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-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\",\"clone-test-repos\":\"mkdir test-repos && cd test-repos && git clone https://github.com/eslint/eslint eslint-eslint --depth 1 --no-tags --quiet && git clone https://github.com/mkdocs/mkdocs mkdocs-mkdocs --depth 1 --no-tags --quiet && git clone https://github.com/pi-hole/docs pi-hole-docs --depth 1 --no-tags --quiet\",\"clone-test-repos-large\":\"npm run clone-test-repos && cd test-repos && git clone https://github.com/dotnet/docs dotnet-docs --depth 1 --no-tags --quiet\",\"declaration\":\"npm run build-declaration && npm run test-declaration\",\"example\":\"cd example && node standalone.js && grunt markdownlint --force && gulp markdownlint\",\"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\",\"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\"},\"engines\":{\"node\":\">=10\"},\"dependencies\":{\"markdown-it\":\"12.0.4\"},\"devDependencies\":{\"ava\":\"~3.15.0\",\"c8\":\"~7.5.0\",\"cpy-cli\":\"~3.1.1\",\"eslint\":\"~7.19.0\",\"eslint-plugin-jsdoc\":\"~31.6.0\",\"eslint-plugin-node\":\"~11.1.0\",\"eslint-plugin-unicorn\":\"~27.0.0\",\"globby\":\"~11.0.2\",\"js-yaml\":\"~4.0.0\",\"markdown-it-for-inline\":\"~0.1.1\",\"markdown-it-sub\":\"~1.0.0\",\"markdown-it-sup\":\"~1.0.0\",\"markdown-it-texmath\":\"~0.8.0\",\"markdownlint-rule-helpers\":\"~0.13.0\",\"npm-run-all\":\"~4.1.5\",\"rimraf\":\"~3.0.2\",\"strip-json-comments\":\"~3.1.1\",\"toml\":\"~3.0.0\",\"ts-loader\":\"~8.0.15\",\"tv4\":\"~1.3.0\",\"typescript\":\"~4.1.3\",\"webpack\":\"~5.21.1\",\"webpack-cli\":\"~4.5.0\"},\"keywords\":[\"markdown\",\"lint\",\"md\",\"CommonMark\",\"markdownlint\"]}");
+module.exports = JSON.parse("{\"name\":\"markdownlint\",\"version\":\"0.23.1\",\"description\":\"A Node.js style checker and lint tool for Markdown/CommonMark files.\",\"main\":\"lib/markdownlint.js\",\"types\":\"lib/markdownlint.d.ts\",\"author\":\"David Anson (https://dlaa.me/)\",\"license\":\"MIT\",\"homepage\":\"https://github.com/DavidAnson/markdownlint\",\"repository\":{\"type\":\"git\",\"url\":\"https://github.com/DavidAnson/markdownlint.git\"},\"bugs\":\"https://github.com/DavidAnson/markdownlint/issues\",\"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 --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-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\",\"clone-test-repos\":\"mkdir test-repos && cd test-repos && git clone https://github.com/eslint/eslint eslint-eslint --depth 1 --no-tags --quiet && git clone https://github.com/mkdocs/mkdocs mkdocs-mkdocs --depth 1 --no-tags --quiet && git clone https://github.com/pi-hole/docs pi-hole-docs --depth 1 --no-tags --quiet\",\"clone-test-repos-large\":\"npm run clone-test-repos && cd test-repos && git clone https://github.com/dotnet/docs dotnet-docs --depth 1 --no-tags --quiet\",\"declaration\":\"npm run build-declaration && npm run test-declaration\",\"example\":\"cd example && node standalone.js && grunt markdownlint --force && gulp markdownlint\",\"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\",\"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\"},\"engines\":{\"node\":\">=10\"},\"dependencies\":{\"markdown-it\":\"12.0.4\"},\"devDependencies\":{\"ava\":\"~3.15.0\",\"c8\":\"~7.5.0\",\"cpy-cli\":\"~3.1.1\",\"eslint\":\"~7.19.0\",\"eslint-plugin-jsdoc\":\"~31.6.0\",\"eslint-plugin-node\":\"~11.1.0\",\"eslint-plugin-unicorn\":\"~27.0.0\",\"globby\":\"~11.0.2\",\"js-yaml\":\"~4.0.0\",\"markdown-it-for-inline\":\"~0.1.1\",\"markdown-it-sub\":\"~1.0.0\",\"markdown-it-sup\":\"~1.0.0\",\"markdown-it-texmath\":\"~0.8.0\",\"markdownlint-rule-helpers\":\"~0.13.0\",\"npm-run-all\":\"~4.1.5\",\"rimraf\":\"~3.0.2\",\"strip-json-comments\":\"~3.1.1\",\"toml\":\"~3.0.0\",\"ts-loader\":\"~8.0.15\",\"tv4\":\"~1.3.0\",\"typescript\":\"~4.1.3\",\"webpack\":\"~5.21.1\",\"webpack-cli\":\"~4.5.0\"},\"keywords\":[\"markdown\",\"lint\",\"md\",\"CommonMark\",\"markdownlint\"]}");
 
 /***/ }),
 

package/lib/markdownlint.js

@@ -10,6 +10,11 @@ const rules = require("./rules");
 const helpers = require("../helpers");
 const cache = require("./cache");
 
+// @ts-ignore
+// eslint-disable-next-line camelcase, max-len, no-inline-comments, no-undef
+const dynamicRequire = (typeof __non_webpack_require__ === "undefined") ? require : /* c8 ignore next */ __non_webpack_require__;
+// Capture native require implementation for dynamic loading of modules
+
 const deprecatedRuleNames = [ "MD002", "MD006" ];
 
 /**
@@ -936,7 +941,10 @@ function resolveConfigExtends(configFile, referenceId) {
     // If not a file or fs.statSync throws, try require.resolve
   }
   try {
-    return require.resolve(referenceId, { "paths": [ configFileDirname ] });
+    return dynamicRequire.resolve(
+      referenceId,
+      { "paths": [ configFileDirname ] }
+    );
   } catch {
     // If require.resolve throws, return resolvedExtendsFile
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint",
-  "version": "0.23.0",
+  "version": "0.23.1",
   "description": "A Node.js style checker and lint tool for Markdown/CommonMark files.",
   "main": "lib/markdownlint.js",
   "types": "lib/markdownlint.d.ts",

package/schema/build-config-example.js

@@ -1,53 +0,0 @@
-// @ts-check
-
-"use strict";
-
-const fs = require("fs");
-const path = require("path");
-const configSchema = require("./markdownlint-config-schema.json");
-
-const configExample = {};
-for (const rule in configSchema.properties) {
-  if (/^(MD\d{3}|default|extends)$/.test(rule)) {
-    const properties = configSchema.properties[rule];
-    configExample[rule + "-description"] = properties.description;
-    configExample[rule] = properties.default;
-    if (properties.properties) {
-      const ruleExample = {};
-      // eslint-disable-next-line guard-for-in
-      for (const property in properties.properties) {
-        const ruleProperties = properties.properties[property];
-        ruleExample[property + "-sub-description"] = ruleProperties.description;
-        ruleExample[property] = ruleProperties.default;
-      }
-      configExample[rule] = ruleExample;
-    }
-  }
-}
-
-const configStringJson = JSON.stringify(configExample, null, 2)
-  // eslint-disable-next-line max-len
-  .replace(/^\{/, "{\n  // Example markdownlint JSON(C) configuration with all properties set to their default value")
-  .replace(/(\s+)"[^-"]+-description": "(.+)",/g, "\n$1// $2")
-  .replace(/"[^-"]+-sub-description": "(.+)",/g, "// $1");
-fs.writeFileSync(
-  path.join(__dirname, ".markdownlint.jsonc"),
-  configStringJson,
-  "utf8"
-);
-
-const configStringYaml = configStringJson
-  .replace(/JSON\(C\)/, "YAML")
-  .replace(/\n {2}/g, "\n")
-  .replace(/\/\/ /g, "# ")
-  .replace(/(\s*)"([^"]+)":/g, "$1$2:")
-  .replace(/: \{/g, ":")
-  .replace(/\n\}/g, "")
-  .replace(/,\n/g, "\n")
-  .replace(/^\{\n/, "")
-  .replace(/\}$/, "");
-fs.writeFileSync(
-  path.join(__dirname, ".markdownlint.yaml"),
-  configStringYaml,
-  "utf8"
-);

package/schema/build-config-schema.js

@@ -1,420 +0,0 @@
-// @ts-check
-
-"use strict";
-
-const fs = require("fs");
-const path = require("path");
-const rules = require("../lib/rules");
-
-// Schema scaffolding
-const schema = {
-  "title": "Markdownlint configuration schema",
-  "type": "object",
-  "properties": {
-    "default": {
-      "description": "Default state for all rules",
-      "type": "boolean",
-      "default": true
-    },
-    "extends": {
-      "description": "Path to configuration file to extend",
-      "type": [
-        "string",
-        "null"
-      ],
-      "default": null
-    },
-    "$schema": {
-      "description": "JSON Schema URI (used by some editors)",
-      "type": "string",
-      "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint" +
-        "/main/schema/markdownlint-config-schema.json"
-    }
-  },
-  "additionalProperties": {
-    "type:": [
-      "boolean",
-      "object"
-    ]
-  }
-};
-const tags = {};
-
-// Add rules
-rules.forEach(function forRule(rule) {
-  rule.tags.forEach(function forTag(tag) {
-    const tagRules = tags[tag] || [];
-    tagRules.push(rule.names[0]);
-    tags[tag] = tagRules;
-  });
-  const scheme = {
-    "description": rule.names.join("/") + " - " + rule.description,
-    "type": "boolean",
-    "default": true
-  };
-  let custom = true;
-  switch (rule.names[0]) {
-    case "MD002":
-      scheme.properties = {
-        "level": {
-          "description": "Heading level",
-          "type": "integer",
-          "default": 1
-        }
-      };
-      break;
-    case "MD003":
-      scheme.properties = {
-        "style": {
-          "description": "Heading style",
-          "type": "string",
-          "enum": [
-            "consistent",
-            "atx",
-            "atx_closed",
-            "setext",
-            "setext_with_atx",
-            "setext_with_atx_closed"
-          ],
-          "default": "consistent"
-        }
-      };
-      break;
-    case "MD004":
-      scheme.properties = {
-        "style": {
-          "description": "List style",
-          "type": "string",
-          "enum": [
-            "consistent",
-            "asterisk",
-            "plus",
-            "dash",
-            "sublist"
-          ],
-          "default": "consistent"
-        }
-      };
-      break;
-    case "MD007":
-      scheme.properties = {
-        "indent": {
-          "description": "Spaces for indent",
-          "type": "integer",
-          "default": 2
-        },
-        "start_indented": {
-          "description": "Whether to indent the first level of the list",
-          "type": "boolean",
-          "default": false
-        }
-      };
-      break;
-    case "MD009":
-      scheme.properties = {
-        "br_spaces": {
-          "description": "Spaces for line break",
-          "type": "integer",
-          "default": 2
-        },
-        "list_item_empty_lines": {
-          "description": "Allow spaces for empty lines in list items",
-          "type": "boolean",
-          "default": false
-        },
-        "strict": {
-          "description": "Include unnecessary breaks",
-          "type": "boolean",
-          "default": false
-        }
-      };
-      break;
-    case "MD010":
-      scheme.properties = {
-        "code_blocks": {
-          "description": "Include code blocks",
-          "type": "boolean",
-          "default": true
-        }
-      };
-      break;
-    case "MD012":
-      scheme.properties = {
-        "maximum": {
-          "description": "Consecutive blank lines",
-          "type": "integer",
-          "default": 1
-        }
-      };
-      break;
-    case "MD013":
-      scheme.properties = {
-        "line_length": {
-          "description": "Number of characters",
-          "type": "integer",
-          "default": 80
-        },
-        "heading_line_length": {
-          "description": "Number of characters for headings",
-          "type": "integer",
-          "default": 80
-        },
-        "code_block_line_length": {
-          "description": "Number of characters for code blocks",
-          "type": "integer",
-          "default": 80
-        },
-        "code_blocks": {
-          "description": "Include code blocks",
-          "type": "boolean",
-          "default": true
-        },
-        "tables": {
-          "description": "Include tables",
-          "type": "boolean",
-          "default": true
-        },
-        "headings": {
-          "description": "Include headings",
-          "type": "boolean",
-          "default": true
-        },
-        "headers": {
-          "description": "Include headings",
-          "type": "boolean",
-          "default": true
-        },
-        "strict": {
-          "description": "Strict length checking",
-          "type": "boolean",
-          "default": false
-        },
-        "stern": {
-          "description": "Stern length checking",
-          "type": "boolean",
-          "default": false
-        }
-      };
-      break;
-    case "MD022":
-      scheme.properties = {
-        "lines_above": {
-          "description": "Blank lines above heading",
-          "type": "integer",
-          "default": 1
-        },
-        "lines_below": {
-          "description": "Blank lines below heading",
-          "type": "integer",
-          "default": 1
-        }
-      };
-      break;
-    case "MD024":
-      scheme.properties = {
-        "allow_different_nesting": {
-          "description": "Only check sibling headings",
-          "type": "boolean",
-          "default": false
-        },
-        "siblings_only": {
-          "description": "Only check sibling headings",
-          "type": "boolean",
-          "default": false
-        }
-      };
-      break;
-    case "MD026":
-      scheme.properties = {
-        "punctuation": {
-          "description": "Punctuation characters",
-          "type": "string",
-          "default": ".,;:!。，；：！"
-        }
-      };
-      break;
-    case "MD036":
-      scheme.properties = {
-        "punctuation": {
-          "description": "Punctuation characters",
-          "type": "string",
-          "default": ".,;:!?。，；：！？"
-        }
-      };
-      break;
-    case "MD029":
-      scheme.properties = {
-        "style": {
-          "description": "List style",
-          "type": "string",
-          "enum": [
-            "one",
-            "ordered",
-            "one_or_ordered",
-            "zero"
-          ],
-          "default": "one_or_ordered"
-        }
-      };
-      break;
-    case "MD030":
-      scheme.properties = {
-        "ul_single": {
-          "description": "Spaces for single-line unordered list items",
-          "type": "integer",
-          "default": 1
-        },
-        "ol_single": {
-          "description": "Spaces for single-line ordered list items",
-          "type": "integer",
-          "default": 1
-        },
-        "ul_multi": {
-          "description": "Spaces for multi-line unordered list items",
-          "type": "integer",
-          "default": 1
-        },
-        "ol_multi": {
-          "description": "Spaces for multi-line ordered list items",
-          "type": "integer",
-          "default": 1
-        }
-      };
-      break;
-    case "MD031":
-      scheme.properties = {
-        "list_items": {
-          "description": "Include list items",
-          "type": "boolean",
-          "default": true
-        }
-      };
-      break;
-    case "MD033":
-      scheme.properties = {
-        "allowed_elements": {
-          "description": "Allowed elements",
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "default": []
-        }
-      };
-      break;
-    case "MD035":
-      scheme.properties = {
-        "style": {
-          "description": "Horizontal rule style",
-          "type": "string",
-          "default": "consistent"
-        }
-      };
-      break;
-    case "MD025":
-    case "MD041":
-      scheme.properties = {
-        "level": {
-          "description": "Heading level",
-          "type": "integer",
-          "default": 1
-        },
-        "front_matter_title": {
-          "description": "RegExp for matching title in front matter",
-          "type": "string",
-          "default": "^\\s*title\\s*[:=]"
-        }
-      };
-      break;
-    case "MD043":
-      scheme.properties = {
-        "headings": {
-          "description": "List of headings",
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "default": []
-        },
-        "headers": {
-          "description": "List of headings",
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "default": []
-        }
-      };
-      break;
-    case "MD044":
-      scheme.properties = {
-        "names": {
-          "description": "List of proper names",
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "default": []
-        },
-        "code_blocks": {
-          "description": "Include code blocks",
-          "type": "boolean",
-          "default": true
-        }
-      };
-      break;
-    case "MD046":
-      scheme.properties = {
-        "style": {
-          "description": "Block style",
-          "type": "string",
-          "enum": [
-            "consistent",
-            "fenced",
-            "indented"
-          ],
-          "default": "consistent"
-        }
-      };
-      break;
-    case "MD048":
-      scheme.properties = {
-        "style": {
-          "description": "Code fence syle",
-          "type": "string",
-          "enum": [
-            "consistent",
-            "backtick",
-            "tilde"
-          ],
-          "default": "consistent"
-        }
-      };
-      break;
-    default:
-      custom = false;
-      break;
-  }
-  if (custom) {
-    // @ts-ignore
-    scheme.type = [ "boolean", "object" ];
-    scheme.additionalProperties = false;
-  }
-  rule.names.forEach(function forName(name) {
-    schema.properties[name] = scheme;
-  });
-});
-
-// Add tags
-Object.keys(tags).forEach(function forTag(tag) {
-  const scheme = {
-    "description": tag + " - " + tags[tag].join(", "),
-    "type": "boolean",
-    "default": true
-  };
-  schema.properties[tag] = scheme;
-});
-
-// Write schema
-const schemaFile = path.join(__dirname, "markdownlint-config-schema.json");
-fs.writeFileSync(schemaFile, JSON.stringify(schema, null, "  "));