markdownlint-cli2 0.12.1 → 0.13.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.13.0
+
+- Add `noBanner` and `gitignore` configuration options
+- Reduce install size by switching to `js-yaml` package
+- Add more detail to some error messages
+- Export JSONC/YAML parsers for reuse
+- Update dependencies (including `markdownlint`)
+
 ## 0.12.1
 
 - Update JSONC parsing to handle trailing commas

package/README.md

@@ -147,7 +147,7 @@ A container image [`davidanson/markdownlint-cli2`][docker-hub-markdownlint-cli2]
 can also be used (e.g., as part of a CI pipeline):
 
 ```bash
-docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.12.1 "**/*.md" "#node_modules"
+docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.13.0 "**/*.md" "#node_modules"
 ```
 
 Notes:
@@ -164,7 +164,7 @@ Notes:
   - A custom working directory can be specified with Docker's `-w` flag:
 
     ```bash
-    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:v0.12.1 "**/*.md" "#node_modules"
+    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:v0.13.0 "**/*.md" "#node_modules"
     ```
 
 For convenience, the container image
@@ -256,6 +256,10 @@ of the rules within.
     - The `String` is passed as the `pattern` parameter to the
       [`RegExp` constructor][regexp-constructor]
     - For example: `(^---\s*$[^]*?^---\s*$)(\r\n|\r|\n|$)`
+  - `gitignore`: `Boolean` value to ignore files referenced by `.gitignore` when
+    linting
+    - This top-level setting is valid **only** in the directory from which
+      `markdownlint-cli2` is run
   - `globs`: `Array` of `String`s defining glob expressions to append to the
     command-line arguments
     - This setting can be used instead of (or in addition to) passing globs on
@@ -285,6 +289,10 @@ of the rules within.
     - Search [`markdown-it-plugins` on npm][markdown-it-plugins]
   - `modulePaths`: `Array` of `String`s providing additional paths to use when
     resolving module references (e.g., alternate locations for `node_modules`)
+  - `noBanner`: `Boolean` value to disable the display of the banner message and
+    version numbers on `stdout`
+    - This top-level setting is valid **only** in the directory from which
+      `markdownlint-cli2` is run
   - `noInlineConfig`: `Boolean` value to disable the support of
     [HTML comments][html-comment] within Markdown content
     - For example: `<!-- markdownlint-disable some-rule -->`
@@ -396,7 +404,7 @@ reference to the `repos` list in that project's `.pre-commit-config.yaml` like:
 
 ```yaml
 - repo: https://github.com/DavidAnson/markdownlint-cli2
-  rev: v0.12.1
+  rev: v0.13.0
   hooks:
   - id: markdownlint-cli2
 ```

package/append-to-array.js

@@ -6,9 +6,9 @@ const sliceSize = 1000;
 
 /**
  * Efficiently appends the source array to the destination array.
- * @param {Object[]} destination Destination Array.
- * @param {Object[]} source Source Array.
- * @returns void
+ * @param {object[]} destination Destination Array.
+ * @param {object[]} source Source Array.
+ * @returns {void}
  */
 const appendToArray = (destination, source) => {
   // NOTE: destination.push(...source) throws "RangeError: Maximum call stack

package/markdownlint-cli2.js

@@ -26,35 +26,37 @@ const resolveAndRequire = require("./resolve-and-require");
 
 // Variables
 const packageName = "markdownlint-cli2";
-const packageVersion = "0.12.1";
+const packageVersion = "0.13.0";
 const libraryName = "markdownlint";
 const libraryVersion = markdownlintLibrary.getVersion();
+const bannerMessage = `${packageName} v${packageVersion} (${libraryName} v${libraryVersion})`;
 const dotOnlySubstitute = "*.{md,markdown}";
 const utf8 = "utf8";
 
 // No-op function
 const noop = () => null;
 
-// Synchronous function to parse JSONC text
-const jsoncParse = (text) => {
-  const { parse, printParseErrorCode } = require("jsonc-parser");
-  const errors = [];
-  const result = parse(text, errors, { "allowTrailingComma": true });
-  if (errors.length > 0) {
-    const aggregate = errors.map(
-      (err) => `${printParseErrorCode(err.error)} (offset ${err.offset}, length ${err.length})`
-    ).join(", ");
-    throw new Error(`Unable to parse JSON(C) content, ${aggregate}`);
-  }
-  return result;
-};
+// Gets a JSONC parser
+const getJsoncParse = () => require("./parsers/jsonc-parse.js");
+
+// Gets a YAML parser
+const getYamlParse = () => require("./parsers/yaml-parse.js");
 
-// Synchronous function to parse YAML text
-const yamlParse = (text) => require("yaml").parse(text);
+// Gets an ordered array of parsers
+const getParsers = () => require("./parsers/parsers.js");
 
-// Negate a glob
+// Negates a glob
 const negateGlob = (glob) => `!${glob}`;
 
+// Throws a meaningful exception for an unusable configuration file
+const throwForConfigurationFile = (file, error) => {
+  throw new Error(
+    `Unable to use configuration file '${file}'; ${error?.message}`,
+    // @ts-ignore
+    { "cause": error }
+  );
+};
+
 // Return a posix path (even on Windows)
 const posixPath = (p) => p.split(pathDefault.sep).join(pathPosix.sep);
 
@@ -69,13 +71,13 @@ const resolveModulePaths = (dir, modulePaths) => (
 );
 
 // Read a JSON(C) or YAML file and return the object
-const readConfig = (fs, dir, name, otherwise) => {
+const readConfig = (fs, dir, name, otherwise) => () => {
   const file = pathPosix.join(dir, name);
-  return () => fs.promises.access(file).
+  return fs.promises.access(file).
     then(
       () => markdownlintReadConfig(
         file,
-        [ jsoncParse, yamlParse ],
+        getParsers(),
         fs
       ),
       otherwise
@@ -83,11 +85,12 @@ const readConfig = (fs, dir, name, otherwise) => {
 };
 
 // Import or resolve/require a module ID with a custom directory in the path
-const importOrRequireResolve = async (dirs, id, noRequire) => {
+const importOrRequireResolve = async (dirOrDirs, id, noRequire) => {
   if (typeof id === "string") {
     if (noRequire) {
       return null;
     }
+    const dirs = Array.isArray(dirOrDirs) ? dirOrDirs : [ dirOrDirs ];
     const expandId = expandTildePath(id);
     const errors = [];
     try {
@@ -96,10 +99,12 @@ const importOrRequireResolve = async (dirs, id, noRequire) => {
       errors.push(error);
     }
     try {
-      const fileUrlString =
-        pathToFileURL(pathDefault.resolve(dirs[0], expandId)).toString();
+      const isURL = !pathDefault.isAbsolute(expandId) && URL.canParse(expandId);
+      const urlString = (
+        isURL ? new URL(expandId) : pathToFileURL(pathDefault.resolve(dirs[0], expandId))
+      ).toString();
       // eslint-disable-next-line no-inline-comments
-      const module = await import(/* webpackIgnore: true */ fileUrlString);
+      const module = await import(/* webpackIgnore: true */ urlString);
       return module.default;
     } catch (error) {
       errors.push(error);
@@ -133,11 +138,11 @@ const importOrRequireIdsAndParams = (dirs, idsAndParams, noRequire) => (
 );
 
 // Import or require a JavaScript file and return the exported object
-const importOrRequireConfig = (fs, dir, name, noRequire, otherwise) => {
-  const id = pathPosix.join(dir, name);
-  return () => fs.promises.access(id).
+const importOrRequireConfig = (fs, dir, name, noRequire, otherwise) => () => {
+  const file = pathPosix.join(dir, name);
+  return fs.promises.access(file).
     then(
-      () => (noRequire ? {} : importOrRequireResolve([ dir ], id)),
+      () => importOrRequireResolve(dir, name, noRequire),
       otherwise
     );
 };
@@ -148,7 +153,7 @@ const getExtendedConfig = (config, configPath, fs) => {
     return markdownlintExtendConfig(
       config,
       configPath,
-      [ jsoncParse, yamlParse ],
+      getParsers(),
       fs
     );
   }
@@ -162,47 +167,43 @@ const readOptionsOrConfig = async (configPath, fs, noRequire) => {
   const dirname = pathPosix.dirname(configPath);
   let options = null;
   let config = null;
-  if (basename.endsWith(".markdownlint-cli2.jsonc")) {
-    options = jsoncParse(await fs.promises.readFile(configPath, utf8));
-  } else if (basename.endsWith(".markdownlint-cli2.yaml")) {
-    options = yamlParse(await fs.promises.readFile(configPath, utf8));
-  } else if (
-    basename.endsWith(".markdownlint-cli2.cjs") ||
-    basename.endsWith(".markdownlint-cli2.mjs")
-  ) {
-    options = await (
-      importOrRequireConfig(fs, dirname, basename, noRequire, noop)()
-    );
-  } else if (
-    basename.endsWith(".markdownlint.jsonc") ||
-    basename.endsWith(".markdownlint.json") ||
-    basename.endsWith(".markdownlint.yaml") ||
-    basename.endsWith(".markdownlint.yml")
-  ) {
-    config =
-      await markdownlintReadConfig(configPath, [ jsoncParse, yamlParse ], fs);
-  } else if (
-    basename.endsWith(".markdownlint.cjs") ||
-    basename.endsWith(".markdownlint.mjs")
-  ) {
-    config = await (
-      importOrRequireConfig(fs, dirname, basename, noRequire, noop)()
-    );
-  } else {
-    throw new Error(
-      `Configuration file "${configPath}" is unrecognized; ` +
-      "its name should be (or end with) one of the supported types " +
-      "(e.g., \".markdownlint.json\" or \"example.markdownlint-cli2.jsonc\")."
-    );
+  try {
+    if (basename.endsWith(".markdownlint-cli2.jsonc")) {
+      options = getJsoncParse()(await fs.promises.readFile(configPath, utf8));
+    } else if (basename.endsWith(".markdownlint-cli2.yaml")) {
+      options = getYamlParse()(await fs.promises.readFile(configPath, utf8));
+    } else if (
+      basename.endsWith(".markdownlint-cli2.cjs") ||
+      basename.endsWith(".markdownlint-cli2.mjs")
+    ) {
+      options = await importOrRequireResolve(dirname, basename, noRequire);
+    } else if (
+      basename.endsWith(".markdownlint.jsonc") ||
+      basename.endsWith(".markdownlint.json") ||
+      basename.endsWith(".markdownlint.yaml") ||
+      basename.endsWith(".markdownlint.yml")
+    ) {
+      config = await markdownlintReadConfig(configPath, getParsers(), fs);
+    } else if (
+      basename.endsWith(".markdownlint.cjs") ||
+      basename.endsWith(".markdownlint.mjs")
+    ) {
+      config = await importOrRequireResolve(dirname, basename, noRequire);
+    } else {
+      throw new Error(
+        "File name should be (or end with) one of the supported types " +
+        "(e.g., '.markdownlint.json' or 'example.markdownlint-cli2.jsonc')."
+      );
+    }
+  } catch (error) {
+    throwForConfigurationFile(configPath, error);
   }
-
   if (options) {
     if (options.config) {
       options.config = await getExtendedConfig(options.config, configPath, fs);
     }
     return options;
   }
-
   config = await getExtendedConfig(config, configPath, fs);
   return { config };
 };
@@ -241,7 +242,10 @@ const processArgv = (argv) => {
 };
 
 // Show help if missing arguments
-const showHelp = (logMessage) => {
+const showHelp = (logMessage, showBanner) => {
+  if (showBanner) {
+    logMessage(bannerMessage);
+  }
   logMessage(`https://github.com/DavidAnson/markdownlint-cli2
 
 Syntax: markdownlint-cli2 glob0 [glob1] [...] [globN] [--config file] [--fix] [--help]
@@ -297,6 +301,7 @@ const getAndProcessDirInfo = (
   noRequire,
   allowPackageJson
 ) => {
+  // Create dirInfo
   let dirInfo = dirToDirInfo[dir];
   if (!dirInfo) {
     dirInfo = {
@@ -310,46 +315,41 @@ const getAndProcessDirInfo = (
     dirToDirInfo[dir] = dirInfo;
 
     // Load markdownlint-cli2 object(s)
-    const markdownlintCli2Jsonc =
-      pathPosix.join(dir, ".markdownlint-cli2.jsonc");
-    const markdownlintCli2Yaml =
-      pathPosix.join(dir, ".markdownlint-cli2.yaml");
+    const markdownlintCli2Jsonc = pathPosix.join(dir, ".markdownlint-cli2.jsonc");
+    const markdownlintCli2Yaml = pathPosix.join(dir, ".markdownlint-cli2.yaml");
+    const markdownlintCli2Cjs =  pathPosix.join(dir, ".markdownlint-cli2.cjs");
+    const markdownlintCli2Mjs = pathPosix.join(dir, ".markdownlint-cli2.mjs");
     const packageJson = pathPosix.join(dir, "package.json");
+    let file = "[UNKNOWN]";
+    // eslint-disable-next-line no-return-assign
+    const captureFile = (f) => file = f;
     tasks.push(
-      fs.promises.access(markdownlintCli2Jsonc).
+      fs.promises.access(captureFile(markdownlintCli2Jsonc)).
         then(
-          () => fs.promises.
-            readFile(markdownlintCli2Jsonc, utf8).
-            then(jsoncParse),
-          () => fs.promises.access(markdownlintCli2Yaml).
+          () => fs.promises.readFile(file, utf8).then(getJsoncParse()),
+          () => fs.promises.access(captureFile(markdownlintCli2Yaml)).
             then(
-              () => fs.promises.
-                readFile(markdownlintCli2Yaml, utf8).
-                then(yamlParse),
-              importOrRequireConfig(
-                fs,
-                dir,
-                ".markdownlint-cli2.cjs",
-                noRequire,
-                importOrRequireConfig(
-                  fs,
-                  dir,
-                  ".markdownlint-cli2.mjs",
-                  noRequire,
-                  () => (allowPackageJson
-                    ? fs.promises.access(packageJson)
-                    // eslint-disable-next-line prefer-promise-reject-errors
-                    : Promise.reject()
-                  ).
+              () => fs.promises.readFile(file, utf8).then(getYamlParse()),
+              () => fs.promises.access(captureFile(markdownlintCli2Cjs)).
+                then(
+                  () => importOrRequireResolve(dir, file, noRequire),
+                  () => fs.promises.access(captureFile(markdownlintCli2Mjs)).
                     then(
-                      () => fs.promises.
-                        readFile(packageJson, utf8).
-                        then(jsoncParse).
-                        then((obj) => obj[packageName]),
-                      noop
+                      () => importOrRequireResolve(dir, file, noRequire),
+                      () => (allowPackageJson
+                        ? fs.promises.access(captureFile(packageJson))
+                        // eslint-disable-next-line prefer-promise-reject-errors
+                        : Promise.reject()
+                      ).
+                        then(
+                          () => fs.promises.
+                            readFile(file, utf8).
+                            then(getJsoncParse()).
+                            then((obj) => obj[packageName]),
+                          noop
+                        )
                     )
                 )
-              )
             )
         ).
         then((options) => {
@@ -358,7 +358,7 @@ const getAndProcessDirInfo = (
             options.config &&
             getExtendedConfig(
               options.config,
-              // Just needs to identify a file in the right directory
+              // Just need to identify a file in the right directory
               markdownlintCli2Jsonc,
               fs
             ).
@@ -366,6 +366,9 @@ const getAndProcessDirInfo = (
                 options.config = config;
               });
         })
+        .catch((error) => {
+          throwForConfigurationFile(file, error);
+        })
     );
 
     // Load markdownlint object(s)
@@ -410,6 +413,8 @@ const getAndProcessDirInfo = (
         })
     );
   }
+
+  // Return dirInfo
   return dirInfo;
 };
 
@@ -471,14 +476,17 @@ const enumerateFiles = async (
   baseDir,
   globPatterns,
   dirToDirInfo,
+  gitignore,
   noRequire
 ) => {
   const tasks = [];
+  /** @type {import("globby").Options} */
   const globbyOptions = {
     "absolute": true,
     "cwd": baseDir,
     "dot": true,
     "expandDirectories": false,
+    gitignore,
     "suppressErrors": true,
     fs
   };
@@ -603,6 +611,7 @@ const createDirInfos = async (
   globPatterns,
   dirToDirInfo,
   optionsOverride,
+  gitignore,
   noRequire
 ) => {
   await enumerateFiles(
@@ -611,6 +620,7 @@ const createDirInfos = async (
     baseDir,
     globPatterns,
     dirToDirInfo,
+    gitignore,
     noRequire
   );
   await enumerateParents(
@@ -767,7 +777,7 @@ const lintFiles = (fs, dirInfos, fileContents) => {
       "files": filteredFiles,
       "strings": filteredStrings,
       "config": markdownlintConfig || markdownlintOptions.config,
-      "configParsers": [ jsoncParse, yamlParse ],
+      "configParsers": getParsers(),
       "customRules": markdownlintOptions.customRules,
       "frontMatter": markdownlintOptions.frontMatter
         ? new RegExp(markdownlintOptions.frontMatter, "u")
@@ -902,10 +912,6 @@ const main = async (params) => {
     (directory && pathDefault.resolve(directory)) ||
     process.cwd();
   const baseDir = posixPath(baseDirSystem);
-  // Output banner
-  logMessage(
-    `${packageName} v${packageVersion} (${libraryName} v${libraryVersion})`
-  );
   // Merge and process args/argv
   let fixDefault = false;
   // eslint-disable-next-line unicorn/no-useless-undefined
@@ -932,22 +938,24 @@ const main = async (params) => {
     return true;
   });
   if (shouldShowHelp) {
-    return showHelp(logMessage);
+    return showHelp(logMessage, true);
   }
   // Read argv configuration file (if relevant and present)
   let optionsArgv = null;
   let relativeDir = null;
-  if (configPath) {
-    const resolvedConfigPath =
-      posixPath(pathDefault.resolve(baseDirSystem, configPath));
-    optionsArgv =
-      await readOptionsOrConfig(resolvedConfigPath, fs, noRequire);
-    relativeDir = pathPosix.dirname(resolvedConfigPath);
-  }
-  // Process arguments and get base options
-  const globPatterns = processArgv(argvFiltered);
-  const { baseMarkdownlintOptions, dirToDirInfo } =
-    await getBaseOptions(
+  let globPatterns = null;
+  let baseOptions = null;
+  try {
+    if (configPath) {
+      const resolvedConfigPath =
+        posixPath(pathDefault.resolve(baseDirSystem, configPath));
+      optionsArgv =
+        await readOptionsOrConfig(resolvedConfigPath, fs, noRequire);
+      relativeDir = pathPosix.dirname(resolvedConfigPath);
+    }
+    // Process arguments and get base options
+    globPatterns = processArgv(argvFiltered);
+    baseOptions = await getBaseOptions(
       fs,
       baseDir,
       relativeDir,
@@ -957,13 +965,19 @@ const main = async (params) => {
       noGlobs,
       noRequire
     );
+  } finally {
+    if (!baseOptions?.baseMarkdownlintOptions.noBanner) {
+      logMessage(bannerMessage);
+    }
+  }
   if (
     ((globPatterns.length === 0) && !nonFileContents) ||
     (configPath === null)
   ) {
-    return showHelp(logMessage);
+    return showHelp(logMessage, false);
   }
   // Include any file overrides or non-file content
+  const { baseMarkdownlintOptions, dirToDirInfo } = baseOptions;
   const resolvedFileContents = {};
   for (const file in fileContents) {
     const resolvedFile = posixPath(pathDefault.resolve(baseDirSystem, file));
@@ -991,6 +1005,8 @@ const main = async (params) => {
       globPatterns,
       dirToDirInfo,
       optionsOverride,
+      // https://github.com/sindresorhus/globby/issues/265
+      !params.fs && Boolean(baseMarkdownlintOptions.gitignore),
       noRequire
     );
   // Output linting status

package/merge-options.js

@@ -4,9 +4,9 @@
 
 /**
  * Merges two options objects by combining config and replacing properties.
- * @param {Object} first First options object.
- * @param {Object} second Second options object.
- * @returns {Object} Merged options object.
+ * @param {object} first First options object.
+ * @param {object} second Second options object.
+ * @returns {object} Merged options object.
  */
 const mergeOptions = (first, second) => {
   const merged = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint-cli2",
-  "version": "0.12.1",
+  "version": "0.13.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"
@@ -32,7 +35,7 @@
     "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/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,30 +68,31 @@
     "schema/ValidatingConfiguration.md"
   ],
   "dependencies": {
-    "globby": "14.0.0",
-    "jsonc-parser": "3.2.0",
-    "markdownlint": "0.33.0",
+    "globby": "14.0.1",
+    "js-yaml": "4.1.0",
+    "jsonc-parser": "3.2.1",
+    "markdownlint": "0.34.0",
     "markdownlint-cli2-formatter-default": "0.0.4",
-    "micromatch": "4.0.5",
-    "yaml": "2.3.4"
+    "micromatch": "4.0.5"
   },
   "devDependencies": {
     "@iktakahiro/markdown-it-katex": "4.0.1",
     "ajv": "8.12.0",
-    "ava": "6.0.1",
+    "ava": "6.1.2",
     "c8": "9.1.0",
-    "cpy": "11.0.0",
+    "cpy": "11.0.1",
     "cpy-cli": "5.0.0",
     "del": "7.1.0",
-    "eslint": "8.56.0",
+    "eslint": "8.57.0",
+    "eslint-plugin-jsdoc": "48.2.2",
     "eslint-plugin-n": "16.6.2",
-    "eslint-plugin-unicorn": "50.0.1",
+    "eslint-plugin-unicorn": "51.0.1",
     "execa": "8.0.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-junit": "0.0.9",
     "markdownlint-cli2-formatter-pretty": "0.0.5",
     "markdownlint-cli2-formatter-sarif": "0.0.1",
     "markdownlint-cli2-formatter-summarize": "0.0.6",

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;