markdownlint-cli2 0.15.0 → 0.17.0

package/package.json

@@ -1,24 +1,24 @@
 {
   "name": "markdownlint-cli2",
-  "version": "0.15.0",
+  "version": "0.17.0",
   "description": "A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the `markdownlint` library",
   "author": {
     "name": "David Anson",
     "url": "https://dlaa.me/"
   },
   "license": "MIT",
-  "type": "commonjs",
-  "main": "./markdownlint-cli2.js",
+  "type": "module",
   "exports": {
-    ".": "./markdownlint-cli2.js",
-    "./markdownlint": "./export-markdownlint.js",
-    "./markdownlint/helpers": "./export-markdownlint-helpers.js",
-    "./parsers": "./parsers/parsers.js",
-    "./parsers/jsonc": "./parsers/jsonc-parse.js",
-    "./parsers/yaml": "./parsers/yaml-parse.js"
+    ".": "./markdownlint-cli2.mjs",
+    "./markdownlint": "./export-markdownlint.mjs",
+    "./markdownlint/helpers": "./export-markdownlint-helpers.mjs",
+    "./markdownlint/promise": "./export-markdownlint-promise.mjs",
+    "./parsers": "./parsers/parsers.mjs",
+    "./parsers/jsonc": "./parsers/jsonc-parse.mjs",
+    "./parsers/yaml": "./parsers/yaml-parse.mjs"
   },
   "bin": {
-    "markdownlint-cli2": "markdownlint-cli2.js"
+    "markdownlint-cli2": "markdownlint-cli2-bin.mjs"
   },
   "homepage": "https://github.com/DavidAnson/markdownlint-cli2",
   "repository": {
@@ -35,11 +35,11 @@
     "lint-dockerfile": "docker run --rm -i hadolint/hadolint:latest-alpine < docker/Dockerfile",
     "lint-watch": "git ls-files | entr npm run lint",
     "playwright-install-bare": "npm run playwright-install-npm && playwright install",
-    "playwright-install-npm": "npm install --no-save playwright@1.48.2",
+    "playwright-install-npm": "npm install --no-save playwright@1.49.1",
     "playwright-test": "playwright test --config ./webworker/playwright.config.mjs",
-    "playwright-test-docker": "docker run --rm --volume $PWD:/home/workdir --workdir /home/workdir --ipc=host mcr.microsoft.com/playwright:v1.48.2 npm run playwright-test",
+    "playwright-test-docker": "docker run --rm --volume $PWD:/home/workdir --workdir /home/workdir --ipc=host mcr.microsoft.com/playwright:v1.49.1 npm run playwright-test",
     "schema": "cpy ./node_modules/markdownlint/schema/markdownlint-config-schema.json ./schema --flat",
-    "test": "ava --timeout=1m test/append-to-array-test.js test/fs-mock-test.js test/fs-virtual-test.js test/markdownlint-cli2-test.js test/markdownlint-cli2-test-exec.js test/markdownlint-cli2-test-exports.js test/markdownlint-cli2-test-fs.js test/markdownlint-cli2-test-main.js test/merge-options-test.js test/resolve-and-require-test.js",
+    "test": "ava --timeout=1m test/append-to-array-test.mjs test/fs-mock-test.mjs test/fs-virtual-test.mjs test/markdownlint-cli2-test.mjs test/markdownlint-cli2-test-exec.mjs test/markdownlint-cli2-test-exports.mjs test/markdownlint-cli2-test-fs.mjs test/markdownlint-cli2-test-main.mjs test/merge-options-test.mjs test/resolve-module-test.mjs",
     "test-cover": "c8 --100 npm test",
     "test-docker-hub-image": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker image rm davidanson/markdownlint-cli2:v$VERSION davidanson/markdownlint-cli2:latest || true && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2:v$VERSION \"*.md\" && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2:latest \"*.md\"",
     "test-docker-hub-image-rules": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker image rm davidanson/markdownlint-cli2-rules:v$VERSION davidanson/markdownlint-cli2-rules:latest || true && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2-rules:v$VERSION \"*.md\" && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2-rules:latest \"*.md\"",
@@ -47,26 +47,28 @@
     "test-docker-image-rules": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2-rules:v$VERSION \"*.md\"",
     "test-invoke-as-cli": "markdownlint-cli2 CHANGELOG.md",
     "test-watch": "git ls-files | entr npm run test",
-    "update-snapshots": "ava --timeout=1m --update-snapshots test/markdownlint-cli2-test-exec.js test/markdownlint-cli2-test-fs.js test/markdownlint-cli2-test-main.js",
+    "update-snapshots": "ava --timeout=1m --update-snapshots test/markdownlint-cli2-test-exec.mjs test/markdownlint-cli2-test-fs.mjs test/markdownlint-cli2-test-main.mjs",
     "webworker": "cd webworker && webpack --mode none",
-    "webworker-install": "npm install --no-package-lock --no-save path-browserify setimmediate stream-browserify util webpack-cli && cpy ./node_modules/setimmediate/setImmediate.js ./webworker --flat"
+    "webworker-install": "npm install --no-package-lock --no-save path-browserify setimmediate stream-browserify util webpack-cli && cpy ./node_modules/setimmediate/setImmediate.js ./webworker --flat --rename=setImmediate.cjs"
   },
   "engines": {
     "node": ">=18"
   },
   "files": [
-    "append-to-array.js",
+    "append-to-array.mjs",
     "CHANGELOG.md",
-    "export-markdownlint.js",
-    "export-markdownlint-helpers.js",
+    "export-markdownlint.mjs",
+    "export-markdownlint-helpers.mjs",
+    "export-markdownlint-promise.mjs",
     "LICENSE",
-    "markdownlint-cli2.js",
-    "merge-options.js",
-    "parsers/parsers.js",
-    "parsers/jsonc-parse.js",
-    "parsers/yaml-parse.js",
+    "markdownlint-cli2.mjs",
+    "markdownlint-cli2-bin.mjs",
+    "merge-options.mjs",
+    "parsers/parsers.mjs",
+    "parsers/jsonc-parse.mjs",
+    "parsers/yaml-parse.mjs",
     "README.md",
-    "resolve-and-require.js",
+    "resolve-module.mjs",
     "schema/markdownlint-cli2-config-schema.json",
     "schema/markdownlint-config-schema.json",
     "schema/ValidatingConfiguration.md"
@@ -75,36 +77,36 @@
     "globby": "14.0.2",
     "js-yaml": "4.1.0",
     "jsonc-parser": "3.3.1",
-    "markdownlint": "0.36.1",
+    "markdownlint": "0.37.2",
     "markdownlint-cli2-formatter-default": "0.0.5",
     "micromatch": "4.0.8"
   },
   "devDependencies": {
-    "@eslint/js": "9.14.0",
+    "@eslint/js": "9.17.0",
     "@iktakahiro/markdown-it-katex": "4.0.1",
-    "@playwright/test": "1.48.2",
-    "@stylistic/eslint-plugin": "2.10.1",
+    "@playwright/test": "1.49.1",
+    "@stylistic/eslint-plugin": "2.12.1",
     "ajv": "8.17.1",
     "ava": "6.2.0",
-    "c8": "10.1.2",
+    "c8": "10.1.3",
     "cpy": "11.1.0",
     "cpy-cli": "5.0.0",
     "del": "8.0.0",
-    "eslint": "9.14.0",
-    "eslint-plugin-jsdoc": "50.4.3",
-    "eslint-plugin-n": "17.13.1",
-    "eslint-plugin-unicorn": "56.0.0",
-    "nano-spawn": "0.2.0",
+    "eslint": "9.17.0",
+    "eslint-plugin-jsdoc": "50.6.1",
+    "eslint-plugin-n": "17.15.1",
+    "eslint-plugin-unicorn": "56.0.1",
     "markdown-it-emoji": "3.0.0",
     "markdown-it-for-inline": "2.0.1",
     "markdownlint-cli2-formatter-codequality": "0.0.5",
     "markdownlint-cli2-formatter-json": "0.0.8",
     "markdownlint-cli2-formatter-junit": "0.0.12",
     "markdownlint-cli2-formatter-pretty": "0.0.7",
-    "markdownlint-cli2-formatter-sarif": "0.0.2",
+    "markdownlint-cli2-formatter-sarif": "0.0.3",
     "markdownlint-cli2-formatter-summarize": "0.0.7",
     "markdownlint-cli2-formatter-template": "0.0.2",
     "markdownlint-rule-extended-ascii": "0.1.0",
+    "nano-spawn": "0.2.0",
     "npm-run-all": "4.1.5"
   },
   "keywords": [

package/parsers/{jsonc-parse.js → jsonc-parse.mjs}

@@ -1,8 +1,6 @@
 // @ts-check
 
-"use strict";
-
-const { parse, printParseErrorCode } = require("jsonc-parser");
+import { parse, printParseErrorCode } from "jsonc-parser";
 
 /**
  * Parses a JSONC string, returning the corresponding object.
@@ -21,4 +19,4 @@ const jsoncParse = (text) => {
   return result;
 };
 
-module.exports = jsoncParse;
+export default jsoncParse;

package/parsers/parsers.mjs

@@ -0,0 +1,14 @@
+// @ts-check
+
+import jsoncParse from "./jsonc-parse.mjs";
+import yamlParse from "./yaml-parse.mjs";
+
+/**
+ * Array of parser objects ordered by priority.
+ */
+const parsers = [
+  jsoncParse,
+  yamlParse
+];
+
+export default parsers;

package/parsers/{yaml-parse.js → yaml-parse.mjs}

@@ -1,8 +1,6 @@
 // @ts-check
 
-"use strict";
-
-const yaml = require("js-yaml");
+import yaml from "js-yaml";
 
 /**
  * Parses a YAML string, returning the corresponding object.
@@ -11,4 +9,4 @@ const yaml = require("js-yaml");
  */
 const yamlParse = (text) => yaml.load(text);
 
-module.exports = yamlParse;
+export default yamlParse;

package/resolve-module.mjs

@@ -0,0 +1,16 @@
+// @ts-check
+
+/**
+ * Wrapper for calling Node's require.resolve with additional paths.
+ * @param {object} require Node's require implementation (or equivalent).
+ * @param {string} request Module path to require.
+ * @param {string[]} paths Paths to resolve module location from.
+ * @returns {string} Resolved file name.
+ */
+const resolveModule = (require, request, paths) => {
+  const resolvePaths = require.resolve.paths ? require.resolve.paths("") : [];
+  const allPaths = [ ...paths, ...resolvePaths ];
+  return require.resolve(request, { "paths": allPaths });
+};
+
+export default resolveModule;

package/schema/markdownlint-cli2-config-schema.json

@@ -1,21 +1,21 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.15.0/schema/markdownlint-cli2-config-schema.json",
+  "$id": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.17.0/schema/markdownlint-cli2-config-schema.json",
   "title": "markdownlint-cli2 configuration schema",
   "type": "object",
   "properties": {
     "$schema": {
       "description": "JSON Schema URI (expected by some editors)",
       "type": "string",
-      "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.15.0/schema/markdownlint-cli2-config-schema.json"
+      "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.17.0/schema/markdownlint-cli2-config-schema.json"
     },
     "config": {
-      "description": "markdownlint configuration schema : https://github.com/DavidAnson/markdownlint/blob/v0.36.1/schema/.markdownlint.jsonc",
-      "$ref": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.36.1/schema/markdownlint-config-schema.json",
+      "description": "markdownlint configuration schema : https://github.com/DavidAnson/markdownlint/blob/v0.37.2/schema/.markdownlint.jsonc",
+      "$ref": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.37.2/schema/markdownlint-config-schema.json",
       "default": {}
     },
     "customRules": {
-      "description": "Module names or paths of custom rules to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
+      "description": "Module names or paths of custom rules to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.17.0/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -25,18 +25,18 @@
       }
     },
     "fix": {
-      "description": "Whether to enable fixing of linting errors reported by rules that emit fix information : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
+      "description": "Whether to enable fixing of linting errors reported by rules that emit fix information : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.17.0/README.md#markdownlint-cli2jsonc",
       "type": "boolean",
       "default": false
     },
     "frontMatter": {
-      "description": "Regular expression used to match and ignore any front matter at the beginning of a document : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
+      "description": "Regular expression used to match and ignore any front matter at the beginning of a document : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.17.0/README.md#markdownlint-cli2jsonc",
       "type": "string",
       "minLength": 1,
       "default": ""
     },
     "gitignore": {
-      "description": "Whether to ignore files referenced by .gitignore (or glob expression) (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
+      "description": "Whether to ignore files referenced by .gitignore (or glob expression) (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.17.0/README.md#markdownlint-cli2jsonc",
       "type": [
         "boolean",
         "string"
@@ -44,7 +44,7 @@
       "default": false
     },
     "globs": {
-      "description": "Glob expressions to include when linting (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
+      "description": "Glob expressions to include when linting (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.17.0/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -54,7 +54,7 @@
       }
     },
     "ignores": {
-      "description": "Glob expressions to ignore when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
+      "description": "Glob expressions to ignore when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.17.0/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -64,7 +64,7 @@
       }
     },
     "markdownItPlugins": {
-      "description": "markdown-it plugins to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
+      "description": "markdown-it plugins to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.17.0/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -84,7 +84,7 @@
       }
     },
     "modulePaths": {
-      "description": "Additional paths to resolve module locations from : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
+      "description": "Additional paths to resolve module locations from : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.17.0/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -94,22 +94,22 @@
       }
     },
     "noBanner": {
-      "description": "Whether to disable the display of the banner message and version numbers on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
+      "description": "Whether to disable the display of the banner message and version numbers on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.17.0/README.md#markdownlint-cli2jsonc",
       "type": "boolean",
       "default": false
     },
     "noInlineConfig": {
-      "description": "Whether to disable support of HTML comments within Markdown content : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
+      "description": "Whether to disable support of HTML comments within Markdown content : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.17.0/README.md#markdownlint-cli2jsonc",
       "type": "boolean",
       "default": false
     },
     "noProgress": {
-      "description": "Whether to disable the display of progress on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
+      "description": "Whether to disable the display of progress on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.17.0/README.md#markdownlint-cli2jsonc",
       "type": "boolean",
       "default": false
     },
     "outputFormatters": {
-      "description": "Output formatters to load and use to customize markdownlint-cli2 output (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
+      "description": "Output formatters to load and use to customize markdownlint-cli2 output (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.17.0/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -129,7 +129,7 @@
       }
     },
     "showFound": {
-      "description": "Whether to show the list of found files on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.15.0/README.md#markdownlint-cli2jsonc",
+      "description": "Whether to show the list of found files on stdout (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.17.0/README.md#markdownlint-cli2jsonc",
       "type": "boolean",
       "default": false
     }