markdownlint-cli2 0.10.0 → 0.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint-cli2",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the `markdownlint` library",
   "author": {
     "name": "David Anson",
@@ -15,9 +15,7 @@
     "./markdownlint/helpers": "./export-markdownlint-helpers.js"
   },
   "bin": {
-    "markdownlint-cli2": "markdownlint-cli2.js",
-    "markdownlint-cli2-config": "markdownlint-cli2-config.js",
-    "markdownlint-cli2-fix": "markdownlint-cli2-fix.js"
+    "markdownlint-cli2": "markdownlint-cli2.js"
   },
   "homepage": "https://github.com/DavidAnson/markdownlint-cli2",
   "repository": {
@@ -25,16 +23,14 @@
     "url": "git+https://github.com/DavidAnson/markdownlint-cli2.git"
   },
   "bugs": "https://github.com/DavidAnson/markdownlint-cli2/issues",
+  "funding": "https://github.com/sponsors/DavidAnson",
   "scripts": {
     "build-docker-image": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker build -t davidanson/markdownlint-cli2:v$VERSION -f docker/Dockerfile --label org.opencontainers.image.version=v$VERSION .",
     "build-docker-image-rules": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker build -t davidanson/markdownlint-cli2-rules:v$VERSION -f docker/Dockerfile-rules --build-arg VERSION=v$VERSION --label org.opencontainers.image.version=v$VERSION .",
-    "ci": "npm-run-all --continue-on-error --parallel test-cover lint schema",
-    "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",
+    "ci": "npm-run-all --continue-on-error --parallel test-cover lint schema && git diff --exit-code",
     "lint": "eslint --max-warnings 0 --no-eslintrc --config .eslintrc.json .",
     "lint-dockerfile": "docker run --rm -i hadolint/hadolint:latest-alpine < docker/Dockerfile",
     "lint-watch": "git ls-files | entr npm run lint",
-    "publish-docker-image": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker buildx build --platform linux/arm64,linux/amd64 -t davidanson/markdownlint-cli2:v$VERSION -t davidanson/markdownlint-cli2:latest -f docker/Dockerfile --push .",
     "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/markdownlint-cli2-test.js test/markdownlint-cli2-test-exec.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-cover": "c8 --100 npm test -- --concurrency=1",
@@ -45,12 +41,11 @@
     "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",
-    "upgrade": "npx --yes npm-check-updates --upgrade",
     "webworker": "cd webworker && webpack --mode none",
-    "webworker-install": "npm run docker-npm-install -- --no-save path-browserify process setimmediate stream-browserify url util webpack-cli"
+    "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"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "files": [
     "append-to-array.js",
@@ -59,44 +54,43 @@
     "export-markdownlint-helpers.js",
     "LICENSE",
     "markdownlint-cli2.js",
-    "markdownlint-cli2-config.js",
-    "markdownlint-cli2-fix.js",
     "merge-options.js",
     "README.md",
     "resolve-and-require.js",
     "schema/markdownlint-cli2-config-schema.json",
-    "schema/markdownlint-config-schema.json"
+    "schema/markdownlint-config-schema.json",
+    "schema/ValidatingConfiguration.md"
   ],
   "dependencies": {
-    "globby": "13.2.2",
-    "markdownlint": "0.31.1",
+    "globby": "14.0.0",
+    "markdownlint": "0.33.0",
     "markdownlint-cli2-formatter-default": "0.0.4",
     "micromatch": "4.0.5",
     "strip-json-comments": "5.0.1",
-    "yaml": "2.3.2"
+    "yaml": "2.3.4"
   },
   "devDependencies": {
     "@iktakahiro/markdown-it-katex": "4.0.1",
-    "ava": "5.3.1",
-    "c8": "8.0.1",
-    "cpy": "10.1.0",
+    "ajv": "8.12.0",
+    "ava": "6.0.1",
+    "c8": "9.0.0",
+    "cpy": "11.0.0",
     "cpy-cli": "5.0.0",
     "del": "7.1.0",
-    "eslint": "8.49.0",
-    "eslint-plugin-n": "16.1.0",
-    "eslint-plugin-unicorn": "48.0.1",
+    "eslint": "8.56.0",
+    "eslint-plugin-n": "16.6.2",
+    "eslint-plugin-unicorn": "50.0.1",
     "execa": "8.0.1",
-    "markdown-it-emoji": "2.0.2",
-    "markdown-it-for-inline": "0.1.1",
+    "markdown-it-emoji": "3.0.0",
+    "markdown-it-for-inline": "2.0.1",
     "markdownlint-cli2-formatter-codequality": "0.0.4",
     "markdownlint-cli2-formatter-json": "0.0.7",
-    "markdownlint-cli2-formatter-junit": "0.0.7",
+    "markdownlint-cli2-formatter-junit": "0.0.8",
     "markdownlint-cli2-formatter-pretty": "0.0.5",
     "markdownlint-cli2-formatter-sarif": "0.0.1",
     "markdownlint-cli2-formatter-summarize": "0.0.6",
     "markdownlint-rule-titlecase": "0.1.0",
-    "npm-run-all": "4.1.5",
-    "tv4": "1.3.0"
+    "npm-run-all": "4.1.5"
   },
   "keywords": [
     "markdown",

package/resolve-and-require.js

@@ -6,12 +6,12 @@
  * Wrapper for calling Node's require.resolve/require with an additional path.
  * @param {Object} req Node's require implementation (or equivalent).
  * @param {String} id Package identifier to require.
- * @param {String} dir Directory to include when resolving paths.
+ * @param {String[]} dirs Directories to include when resolving paths.
  * @returns {Object} Exported module content.
  */
-const resolveAndRequire = (req, id, dir) => {
+const resolveAndRequire = (req, id, dirs) => {
   const resolvePaths = req.resolve.paths ? req.resolve.paths("") : [];
-  const paths = [ dir, ...resolvePaths ];
+  const paths = [ ...dirs, ...resolvePaths ];
   const resolved = req.resolve(id, { paths });
   return req(resolved);
 };

package/schema/ValidatingConfiguration.md

@@ -0,0 +1,24 @@
+# Validating Configuration
+
+A [JSON Schema][json-schema] is provided to enable validating options objects:
+[`markdownlint-cli2-config-schema.json`][markdownlint-cli2-config-schema]
+
+Some editors automatically use a JSON Schema with files that reference it. For
+example, a `.markdownlint-cli2.jsonc` file with:
+
+```json
+"$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/main/schema/markdownlint-cli2-config-schema.json"
+```
+
+A JSON Schema validator can be used to check configuration files like so:
+
+```bash
+npx ajv-cli validate -s ./markdownlint-cli2/schema/markdownlint-cli2-config-schema.json -r ./markdownlint-cli2/schema/markdownlint-config-schema.json -d "**/.markdownlint-cli2.{jsonc,yaml}" --strict=false
+```
+
+A similar process is documented for validating `markdownlint` configuration
+objects: [Validating Configuration][validating-configuration].
+
+[json-schema]: https://json-schema.org
+[markdownlint-cli2-config-schema]: markdownlint-cli2-config-schema.json
+[validating-configuration]: https://github.com/DavidAnson/markdownlint/blob/main/schema/ValidatingConfiguration.md

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

@@ -1,16 +1,17 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.12.0/schema/markdownlint-cli2-config-schema.json",
   "title": "markdownlint-cli2 configuration schema",
   "type": "object",
   "properties": {
     "$schema": {
-      "description": "JSON Schema URI (used by some editors)",
+      "description": "JSON Schema URI (expected by some editors)",
       "type": "string",
-      "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/main/schema/markdownlint-cli2-config-schema.json"
+      "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.12.0/schema/markdownlint-cli2-config-schema.json"
     },
     "config": {
       "description": "markdownlint-cli2 configuration schema",
-      "$ref": "./markdownlint-config-schema.json",
+      "$ref": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.33.0/schema/markdownlint-config-schema.json",
       "default": {}
     },
     "customRules": {
@@ -74,6 +75,16 @@
         "minItems": 1
       }
     },
+    "modulePaths": {
+      "description": "Additional paths to resolve module locations from",
+      "type": "array",
+      "default": [],
+      "items": {
+        "description": "Path to resolve module locations from",
+        "type": "string",
+        "minLength": 1
+      }
+    },
     "noInlineConfig": {
       "description": "Whether to disable support of HTML comments within Markdown content",
       "type": "boolean",