markdownlint-cli2 0.12.1 → 0.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint-cli2",
-  "version": "0.12.1",
+  "version": "0.14.0",
   "description": "A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the `markdownlint` library",
   "author": {
     "name": "David Anson",
@@ -12,7 +12,10 @@
   "exports": {
     ".": "./markdownlint-cli2.js",
     "./markdownlint": "./export-markdownlint.js",
-    "./markdownlint/helpers": "./export-markdownlint-helpers.js"
+    "./markdownlint/helpers": "./export-markdownlint-helpers.js",
+    "./parsers": "./parsers/parsers.js",
+    "./parsers/jsonc": "./parsers/jsonc-parse.js",
+    "./parsers/yaml": "./parsers/yaml-parse.js"
   },
   "bin": {
     "markdownlint-cli2": "markdownlint-cli2.js"
@@ -28,11 +31,11 @@
     "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 && git diff --exit-code",
-    "lint": "eslint --max-warnings 0 --no-eslintrc --config .eslintrc.json .",
+    "lint": "eslint --max-warnings 0",
     "lint-dockerfile": "docker run --rm -i hadolint/hadolint:latest-alpine < docker/Dockerfile",
     "lint-watch": "git ls-files | entr npm run lint",
     "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": "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-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\"",
@@ -55,6 +58,9 @@
     "LICENSE",
     "markdownlint-cli2.js",
     "merge-options.js",
+    "parsers/parsers.js",
+    "parsers/jsonc-parse.js",
+    "parsers/yaml-parse.js",
     "README.md",
     "resolve-and-require.js",
     "schema/markdownlint-cli2-config-schema.json",
@@ -62,34 +68,37 @@
     "schema/ValidatingConfiguration.md"
   ],
   "dependencies": {
-    "globby": "14.0.0",
-    "jsonc-parser": "3.2.0",
-    "markdownlint": "0.33.0",
-    "markdownlint-cli2-formatter-default": "0.0.4",
-    "micromatch": "4.0.5",
-    "yaml": "2.3.4"
+    "globby": "14.0.2",
+    "js-yaml": "4.1.0",
+    "jsonc-parser": "3.3.1",
+    "markdownlint": "0.35.0",
+    "markdownlint-cli2-formatter-default": "0.0.5",
+    "micromatch": "4.0.8"
   },
   "devDependencies": {
+    "@eslint/js": "9.9.1",
     "@iktakahiro/markdown-it-katex": "4.0.1",
-    "ajv": "8.12.0",
-    "ava": "6.0.1",
-    "c8": "9.1.0",
-    "cpy": "11.0.0",
+    "@stylistic/eslint-plugin": "2.7.2",
+    "ajv": "8.17.1",
+    "ava": "6.1.3",
+    "c8": "10.1.2",
+    "cpy": "11.1.0",
     "cpy-cli": "5.0.0",
     "del": "7.1.0",
-    "eslint": "8.56.0",
-    "eslint-plugin-n": "16.6.2",
-    "eslint-plugin-unicorn": "50.0.1",
-    "execa": "8.0.1",
+    "eslint": "9.9.1",
+    "eslint-plugin-jsdoc": "50.2.2",
+    "eslint-plugin-n": "17.10.2",
+    "eslint-plugin-unicorn": "55.0.0",
+    "execa": "9.3.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.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",
+    "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-summarize": "0.0.7",
+    "markdownlint-rule-extended-ascii": "0.1.0",
     "npm-run-all": "4.1.5"
   },
   "keywords": [

package/parsers/jsonc-parse.js

@@ -0,0 +1,24 @@
+// @ts-check
+
+"use strict";
+
+const { parse, printParseErrorCode } = require("jsonc-parser");
+
+/**
+ * Parses a JSONC string, returning the corresponding object.
+ * @param {string} text String to parse as JSONC.
+ * @returns {object} Corresponding object.
+ */
+const jsoncParse = (text) => {
+  const errors = [];
+  const result = parse(text, errors, { "allowTrailingComma": true });
+  if (errors.length > 0) {
+    const aggregate = errors.map(
+      (error) => `${printParseErrorCode(error.error)} (offset ${error.offset}, length ${error.length})`
+    ).join(", ");
+    throw new Error(`Unable to parse JSONC content, ${aggregate}`);
+  }
+  return result;
+};
+
+module.exports = jsoncParse;

package/parsers/parsers.js

@@ -0,0 +1,16 @@
+// @ts-check
+
+"use strict";
+
+const jsoncParse = require("./jsonc-parse");
+const yamlParse = require("./yaml-parse");
+
+/**
+ * Array of parser objects ordered by priority.
+ */
+const parsers = [
+  jsoncParse,
+  yamlParse
+];
+
+module.exports = parsers;

package/parsers/yaml-parse.js

@@ -0,0 +1,14 @@
+// @ts-check
+
+"use strict";
+
+const yaml = require("js-yaml");
+
+/**
+ * Parses a YAML string, returning the corresponding object.
+ * @param {string} text String to parse as YAML.
+ * @returns {object} Corresponding object.
+ */
+const yamlParse = (text) => yaml.load(text);
+
+module.exports = yamlParse;

package/resolve-and-require.js

@@ -4,10 +4,10 @@
 
 /**
  * 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[]} dirs Directories to include when resolving paths.
- * @returns {Object} Exported module content.
+ * @param {object} req Node's require implementation (or equivalent).
+ * @param {string} id Package identifier to require.
+ * @param {string[]} dirs Directories to include when resolving paths.
+ * @returns {object} Exported module content.
  */
 const resolveAndRequire = (req, id, dirs) => {
   const resolvePaths = req.resolve.paths ? req.resolve.paths("") : [];

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.12.1/schema/markdownlint-cli2-config-schema.json",
+  "$id": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.14.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.12.1/schema/markdownlint-cli2-config-schema.json"
+      "default": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/v0.14.0/schema/markdownlint-cli2-config-schema.json"
     },
     "config": {
-      "description": "markdownlint configuration schema : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/schema/.markdownlint.jsonc",
-      "$ref": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.33.0/schema/markdownlint-config-schema.json",
+      "description": "markdownlint configuration schema : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/schema/.markdownlint.jsonc",
+      "$ref": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.35.0/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.12.1/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.14.0/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -25,18 +25,26 @@
       }
     },
     "fix": {
-      "description": "Whether to enable fixing of linting errors reported by rules that emit fix information : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.12.1/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.14.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.12.1/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.14.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.14.0/README.md#markdownlint-cli2jsonc",
+      "type": [
+        "boolean",
+        "string"
+      ],
+      "default": false
+    },
     "globs": {
-      "description": "Glob expressions to include when linting (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.12.1/README.md#markdownlint-cli2jsonc",
+      "description": "Glob expressions to include when linting (only valid at the root) : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.14.0/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -46,7 +54,7 @@
       }
     },
     "ignores": {
-      "description": "Glob expressions to ignore when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.12.1/README.md#markdownlint-cli2jsonc",
+      "description": "Glob expressions to ignore when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.14.0/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -56,7 +64,7 @@
       }
     },
     "markdownItPlugins": {
-      "description": "markdown-it plugins to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.12.1/README.md#markdownlint-cli2jsonc",
+      "description": "markdown-it plugins to load and use when linting : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.14.0/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -76,7 +84,7 @@
       }
     },
     "modulePaths": {
-      "description": "Additional paths to resolve module locations from : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.12.1/README.md#markdownlint-cli2jsonc",
+      "description": "Additional paths to resolve module locations from : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.14.0/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -85,18 +93,23 @@
         "minLength": 1
       }
     },
+    "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.14.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.12.1/README.md#markdownlint-cli2jsonc",
+      "description": "Whether to disable support of HTML comments within Markdown content : https://github.com/DavidAnson/markdownlint-cli2/blob/v0.14.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.12.1/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.14.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.12.1/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.14.0/README.md#markdownlint-cli2jsonc",
       "type": "array",
       "default": [],
       "items": {
@@ -116,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.12.1/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.14.0/README.md#markdownlint-cli2jsonc",
       "type": "boolean",
       "default": false
     }