markdownlint-cli2 0.5.1 → 0.7.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2022 David Anson
+Copyright (c) David Anson
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -10,22 +10,36 @@
 
 As a global CLI:
 
-```shell
+```bash
 npm install markdownlint-cli2 --global
 ```
 
-As a development dependency of the current package:
+As a development dependency of the current [Node.js][nodejs] package:
 
-```shell
+```bash
 npm install markdownlint-cli2 --save-dev
 ```
 
-Or as a Docker container image:
+As a [Docker][docker] container image:
 
-```shell
+```bash
 docker pull davidanson/markdownlint-cli2
 ```
 
+As a global CLI with [Homebrew][homebrew]:
+
+```bash
+brew install markdownlint-cli2
+```
+
+As a [GitHub Action][github-action] via
+[`markdownlint-cli2-action`][markdownlint-cli2-action]:
+
+```yaml
+- name: markdownlint-cli2-action
+  uses: DavidAnson/markdownlint-cli2-action@v9
+```
+
 ## Overview
 
 - [`markdownlint`][markdownlint] is a library for linting [Markdown][markdown]/
@@ -131,7 +145,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:0.5.1 "**/*.md" "#node_modules"
+docker run -v $PWD:/workdir davidanson/markdownlint-cli2:v0.7.0 "**/*.md" "#node_modules"
 ```
 
 Notes:
@@ -148,16 +162,25 @@ Notes:
   - A custom working directory can be specified with Docker's `-w` flag:
 
     ```bash
-    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:0.5.1 "**/*.md" "#node_modules"
+    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:v0.7.0 "**/*.md" "#node_modules"
     ```
 
 To invoke the `markdownlint-cli2-config` or `markdownlint-cli2-fix` commands
 instead, use Docker's `--entrypoint` flag:
 
 ```bash
-docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/markdownlint-cli2:0.5.1 "**/*.md" "#node_modules"
+docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/markdownlint-cli2:v0.7.0 "**/*.md" "#node_modules"
 ```
 
+For convenience, the container image
+[`davidanson/markdownlint-cli2-rules`][docker-hub-markdownlint-cli2-rules]
+includes the latest versions of custom rules published to npm with the tag
+[`markdownlint-rule`][markdownlint-rule]. These rules are installed globally
+onto the base image `davidanson/markdownlint-cli2`.
+
+**Note**: This container image exists for convenience and is not an endorsement
+of the rules within.
+
 ### Exit Codes
 
 - `0`: Linting was successful and there were no errors
@@ -179,11 +202,20 @@ docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/mark
 - See the [Configuration][markdownlint-configuration] section of the
   `markdownlint` documentation for information about the inline comment syntax
   for enabling and disabling rules with HTML comments.
-- In general, glob expressions match files under the current directory and the
-  configuration for that directory applies to the entire tree.
+- In general, glob expressions should match files under the current directory;
+  the configuration for that directory will apply to the entire tree.
   - When glob expressions match files *not* under the current directory,
     configuration for the current directory is applied to the closest common
     parent directory.
+- There are two kinds of configuration file (both detailed below):
+  - Configuration files like `.markdownlint-cli2.*` allow complete control of
+    `markdownlint-cli2` behavior and are also used by `vscode-markdownlint`.
+  - Configuration files like `.markdownlint.*` allow control over only the
+    `markdownlint` `config` object and tend to be supported more broadly (such
+    as by `markdownlint-cli`).
+- The VS Code extension `vscode-markdownlint` includes a schema definition for
+  the `JSON(C)` configuration files described below. This adds auto-complete and
+  can make it easier to define proper structure.
 
 ### `.markdownlint-cli2.jsonc`
 
@@ -194,6 +226,8 @@ docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/mark
     rules for this part of the directory tree
     - If a `.markdownlint.{jsonc,json,yaml,yml,js}` file (see below) is present
       in the same directory, it overrides the value of this property
+    - If the `config` object contains an `extends` property, it will be resolved
+      the same as `.markdownlint.{jsonc,json,yaml,yml,js}` (see below)
   - `customRules`: `Array` of `String`s (or `Array`s of `String`s) of module
     names/paths of [custom rules][markdownlint-custom-rules] to load and use
     when linting
@@ -344,7 +378,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.5.1
+  rev: v0.7.0
   hooks:
   - id: markdownlint-cli2
 ```
@@ -354,41 +388,21 @@ reference to the `repos` list in that project's `.pre-commit-config.yaml` like:
 
 ## History
 
-- 0.0.2 - Initial release
-- 0.0.3 - Feature parity with `markdownlint-cli`
-- 0.0.4 - Support output formatters and `markdown-it` plugins
-- 0.0.5 - Improve support for ignoring files
-- 0.0.6 - Improve handling of very large directory trees
-- 0.0.7 - Support `.markdownlint-cli2.js` and `.markdownlint.js`
-- 0.0.8 - Support `.markdownlint-cli2.yaml`, add progress
-- 0.0.9 - Improve configuration file handling
-- 0.0.10 - Improve performance and configuration
-- 0.0.11 - Improve performance of `fix`, update banner
-- 0.0.12 - Update dependencies (including `markdownlint`)
-- 0.0.13 - Add `markdownlint-cli2-fix` command
-- 0.0.14 - Update dependencies (including `markdownlint`)
-- 0.0.15 - Improve extensibility
-- 0.1.0 - Simplify use of `require`, increment minor version
-  - 0.1.1 - Restore previous use of `require`
-  - 0.1.2 - Update use of `require` to be more flexible
-  - 0.1.3 - Support rule collections
-- 0.2.0 - Improve handling of Windows paths using backslash
-- 0.3.0 - Add Docker container, update dependencies
-  - 0.3.1 - Extensibility tweaks
-  - 0.3.2 - Extensibility/Windows/consistency improvements
-- 0.4.0 - New rules, async custom rules, explicit config, CJS (breaking)
-- 0.5.0 - New rules, support modules (MJS) everywhere, include dotfiles
-  - 0.5.1 - Update dependencies
+See [CHANGELOG.md](CHANGELOG.md).
 
 <!-- markdownlint-disable line-length -->
 
 [commonmark]: https://commonmark.org/
 [commonjs-module]: https://nodejs.org/api/modules.html#modules_modules_commonjs_modules
 [ecmascript-module]: https://nodejs.org/api/esm.html#modules-ecmascript-modules
+[docker]: https://www.docker.com
 [docker-bind-mounts]: https://docs.docker.com/storage/bind-mounts/
 [docker-hub-markdownlint-cli2]: https://hub.docker.com/r/davidanson/markdownlint-cli2
+[docker-hub-markdownlint-cli2-rules]: https://hub.docker.com/r/davidanson/markdownlint-cli2-rules
 [front-matter]: https://jekyllrb.com/docs/frontmatter/
+[github-action]: https://docs.github.com/actions
 [globby]: https://www.npmjs.com/package/globby
+[homebrew]: https://brew.sh
 [html-comment]: https://developer.mozilla.org/en-US/docs/Learn/HTML/Introduction_to_HTML/Getting_started
 [json]: https://wikipedia.org/wiki/JSON
 [jsonc]: https://code.visualstudio.com/Docs/languages/json#_json-with-comments
@@ -407,6 +421,7 @@ reference to the `repos` list in that project's `.pre-commit-config.yaml` like:
 [markdownlint-rules-tags]: https://github.com/DavidAnson/markdownlint/blob/main/README.md#tags
 [markdownlint-cli]: https://github.com/igorshubovych/markdownlint-cli
 [markdownlint-cli2]: https://github.com/DavidAnson/markdownlint-cli2
+[markdownlint-cli2-action]: https://github.com/marketplace/actions/markdownlint-cli2-action
 [markdownlint-cli2-blog]: https://dlaa.me/blog/post/markdownlintcli2
 [markdownlint-cli2-formatter]: https://www.npmjs.com/search?q=keywords:markdownlint-cli2-formatter
 [markdownlint-cli2-cjs]: test/markdownlint-cli2-cjs/.markdownlint-cli2.cjs

package/export-markdownlint-helpers.js

@@ -0,0 +1,5 @@
+// @ts-check
+
+"use strict";
+
+module.exports = require("markdownlint/helpers");

package/export-markdownlint.js

@@ -0,0 +1,5 @@
+// @ts-check
+
+"use strict";
+
+module.exports = require("markdownlint");

package/markdownlint-cli2.js

@@ -13,8 +13,11 @@ const dynamicRequire = (typeof __non_webpack_require__ === "undefined") ? requir
 const path = require("node:path");
 const { pathToFileURL } = require("node:url");
 const markdownlintLibrary = require("markdownlint");
-const { markdownlint, "readConfig": markdownlintReadConfig } =
-  markdownlintLibrary.promises;
+const {
+  markdownlint,
+  "extendConfig": markdownlintExtendConfig,
+  "readConfig": markdownlintReadConfig
+} = markdownlintLibrary.promises;
 const markdownlintRuleHelpers = require("markdownlint/helpers");
 const appendToArray = require("./append-to-array");
 const mergeOptions = require("./merge-options");
@@ -22,7 +25,7 @@ const resolveAndRequire = require("./resolve-and-require");
 
 // Variables
 const packageName = "markdownlint-cli2";
-const packageVersion = "0.5.1";
+const packageVersion = "0.7.0";
 const libraryName = "markdownlint";
 const libraryVersion = markdownlintLibrary.getVersion();
 const dotOnlySubstitute = "*.{md,markdown}";
@@ -34,8 +37,7 @@ const noop = () => null;
 // Gets a synchronous function to parse JSONC text
 const getJsoncParse = async () => {
   const { "default": stripJsonComments } =
-    // eslint-disable-next-line max-len
-    // eslint-disable-next-line no-inline-comments, node/no-unsupported-features/es-syntax
+    // eslint-disable-next-line no-inline-comments
     await import(/* webpackMode: "eager" */ "strip-json-comments");
   return (text) => JSON.parse(stripJsonComments(text));
 };
@@ -79,8 +81,7 @@ const importOrRequireResolve = async (dir, id) => {
     try {
       const fileUrlString =
         pathToFileURL(path.resolve(dir, expandId)).toString();
-      // eslint-disable-next-line max-len
-      // eslint-disable-next-line no-inline-comments, node/no-unsupported-features/es-syntax
+      // eslint-disable-next-line no-inline-comments
       const module = await import(/* webpackIgnore: true */ fileUrlString);
       return module.default;
     } catch (error) {
@@ -244,105 +245,121 @@ $ markdownlint-cli2 "**/*.md" "#node_modules"`
 
 // Get (creating if necessary) and process a directory's info object
 const getAndProcessDirInfo =
-(fs, tasks, dirToDirInfo, dir, relativeDir, noRequire, func) => {
-  let dirInfo = dirToDirInfo[dir];
-  if (!dirInfo) {
-    dirInfo = {
-      dir,
-      relativeDir,
-      "parent": null,
-      "files": [],
-      "markdownlintConfig": null,
-      "markdownlintOptions": null
-    };
-    dirToDirInfo[dir] = dirInfo;
-
-    // Load markdownlint-cli2 object(s)
-    const markdownlintCli2Jsonc =
-      path.posix.join(dir, ".markdownlint-cli2.jsonc");
-    const markdownlintCli2Yaml =
-      path.posix.join(dir, ".markdownlint-cli2.yaml");
-    tasks.push(
-      fs.promises.access(markdownlintCli2Jsonc).
-        then(
-          () => fs.promises.
-            readFile(markdownlintCli2Jsonc, utf8).
-            then(
-              (content) => getJsoncParse().
-                then((jsoncParse) => jsoncParse(content))
-            ),
-          () => fs.promises.access(markdownlintCli2Yaml).
-            then(
-              () => fs.promises.
-                readFile(markdownlintCli2Yaml, utf8).
-                then(yamlParse),
-              importOrRequireConfig(
-                fs,
-                dir,
-                ".markdownlint-cli2.cjs",
-                noRequire,
+  (fs, tasks, dirToDirInfo, dir, relativeDir, noRequire, func) => {
+    let dirInfo = dirToDirInfo[dir];
+    if (!dirInfo) {
+      dirInfo = {
+        dir,
+        relativeDir,
+        "parent": null,
+        "files": [],
+        "markdownlintConfig": null,
+        "markdownlintOptions": null
+      };
+      dirToDirInfo[dir] = dirInfo;
+
+      // Load markdownlint-cli2 object(s)
+      const markdownlintCli2Jsonc =
+        path.posix.join(dir, ".markdownlint-cli2.jsonc");
+      const markdownlintCli2Yaml =
+        path.posix.join(dir, ".markdownlint-cli2.yaml");
+      tasks.push(
+        fs.promises.access(markdownlintCli2Jsonc).
+          then(
+            () => fs.promises.
+              readFile(markdownlintCli2Jsonc, utf8).
+              then(
+                (content) => getJsoncParse().
+                  then((jsoncParse) => jsoncParse(content))
+              ),
+            () => fs.promises.access(markdownlintCli2Yaml).
+              then(
+                () => fs.promises.
+                  readFile(markdownlintCli2Yaml, utf8).
+                  then(yamlParse),
                 importOrRequireConfig(
                   fs,
                   dir,
-                  ".markdownlint-cli2.mjs",
+                  ".markdownlint-cli2.cjs",
                   noRequire,
-                  noop
+                  importOrRequireConfig(
+                    fs,
+                    dir,
+                    ".markdownlint-cli2.mjs",
+                    noRequire,
+                    noop
+                  )
                 )
               )
-            )
-        ).
-        then((options) => {
-          dirInfo.markdownlintOptions = options;
-        })
-    );
+          ).
+          then((options) => {
+            dirInfo.markdownlintOptions = options;
+            return options &&
+              options.config &&
+              options.config.extends &&
+              getJsoncParse().
+                then(
+                  (jsoncParse) => markdownlintExtendConfig(
+                    options.config,
+                    // Just needs to identify a file in the right directory
+                    markdownlintCli2Jsonc,
+                    [ jsoncParse, yamlParse ],
+                    fs
+                  )
+                ).
+                then((config) => {
+                  options.config = config;
+                });
+          })
+      );
 
-    // Load markdownlint object(s)
-    const readConfigs =
-      readConfig(
-        fs,
-        dir,
-        ".markdownlint.jsonc",
+      // Load markdownlint object(s)
+      const readConfigs =
         readConfig(
           fs,
           dir,
-          ".markdownlint.json",
+          ".markdownlint.jsonc",
           readConfig(
             fs,
             dir,
-            ".markdownlint.yaml",
+            ".markdownlint.json",
             readConfig(
               fs,
               dir,
-              ".markdownlint.yml",
-              importOrRequireConfig(
+              ".markdownlint.yaml",
+              readConfig(
                 fs,
                 dir,
-                ".markdownlint.cjs",
-                noRequire,
+                ".markdownlint.yml",
                 importOrRequireConfig(
                   fs,
                   dir,
-                  ".markdownlint.mjs",
+                  ".markdownlint.cjs",
                   noRequire,
-                  noop
+                  importOrRequireConfig(
+                    fs,
+                    dir,
+                    ".markdownlint.mjs",
+                    noRequire,
+                    noop
+                  )
                 )
               )
             )
           )
-        )
+        );
+      tasks.push(
+        readConfigs().
+          then((config) => {
+            dirInfo.markdownlintConfig = config;
+          })
       );
-    tasks.push(
-      readConfigs().
-        then((config) => {
-          dirInfo.markdownlintConfig = config;
-        })
-    );
-  }
-  if (func) {
-    func(dirInfo);
-  }
-  return dirInfo;
-};
+    }
+    if (func) {
+      func(dirInfo);
+    }
+    return dirInfo;
+  };
 
 // Get base markdownlint-cli2 options object
 const getBaseOptions = async (
@@ -369,7 +386,10 @@ const getBaseOptions = async (
   // eslint-disable-next-line no-multi-assign
   const baseMarkdownlintOptions = dirToDirInfo[baseDir].markdownlintOptions =
     mergeOptions(
-      mergeOptions(options, { "fix": fixDefault }),
+      mergeOptions(
+        { "fix": fixDefault },
+        options
+      ),
       dirToDirInfo[baseDir].markdownlintOptions
     );
 
@@ -393,82 +413,81 @@ const getBaseOptions = async (
 
 // Enumerate files from globs and build directory infos
 const enumerateFiles =
-// eslint-disable-next-line max-len
-async (fs, baseDirSystem, baseDir, globPatterns, dirToDirInfo, noErrors, noRequire) => {
-  const tasks = [];
-  const globbyOptions = {
-    "absolute": true,
-    "cwd": baseDir,
-    "dot": true,
-    "expandDirectories": false,
-    fs
-  };
-  if (noErrors) {
-    globbyOptions.suppressErrors = true;
-  }
-  // Special-case literal files
-  const literalFiles = [];
-  const filteredGlobPatterns = globPatterns.filter(
-    (globPattern) => {
-      if (globPattern.startsWith(":")) {
-        literalFiles.push(
-          posixPath(path.resolve(baseDirSystem, globPattern.slice(1)))
-        );
-        return false;
-      }
-      return true;
-    }
-  ).map((globPattern) => globPattern.replace(/^\\:/u, ":"));
-  const baseMarkdownlintOptions = dirToDirInfo[baseDir].markdownlintOptions;
-  const globsForIgnore =
-    (baseMarkdownlintOptions.globs || []).
-      filter((glob) => glob.startsWith("!"));
-  const filteredLiteralFiles =
-    ((literalFiles.length > 0) && (globsForIgnore.length > 0))
-      ? removeIgnoredFiles(baseDir, literalFiles, globsForIgnore)
-      : literalFiles;
-  // Manually expand directories to avoid globby call to dir-glob.sync
-  const expandedDirectories = await Promise.all(
-    filteredGlobPatterns.map((globPattern) => {
-      const barePattern =
-        globPattern.startsWith("!")
-          ? globPattern.slice(1)
-          : globPattern;
-      const globPath =
-        (path.posix.isAbsolute(barePattern) || path.isAbsolute(barePattern))
-          ? barePattern
-          : path.posix.join(baseDir, barePattern);
-      return fs.promises.stat(globPath).
-        then((stats) => (stats.isDirectory()
-          ? path.posix.join(globPattern, "**")
-          : globPattern)).
-        catch(() => globPattern);
-    })
-  );
-  // Process glob patterns
   // eslint-disable-next-line max-len
-  // eslint-disable-next-line no-inline-comments, node/no-unsupported-features/es-syntax
-  const { globby } = await import(/* webpackMode: "eager" */ "globby");
-  const files = [
-    ...await globby(expandedDirectories, globbyOptions),
-    ...filteredLiteralFiles
-  ];
-  for (const file of files) {
-    const dir = path.posix.dirname(file);
-    getAndProcessDirInfo(
-      fs,
-      tasks,
-      dirToDirInfo,
-      dir,
-      null,
-      noRequire,
-      (dirInfo) => {
-        dirInfo.files.push(file);
+  async (fs, baseDirSystem, baseDir, globPatterns, dirToDirInfo, noErrors, noRequire) => {
+    const tasks = [];
+    const globbyOptions = {
+      "absolute": true,
+      "cwd": baseDir,
+      "dot": true,
+      "expandDirectories": false,
+      fs
+    };
+    if (noErrors) {
+      globbyOptions.suppressErrors = true;
+    }
+    // Special-case literal files
+    const literalFiles = [];
+    const filteredGlobPatterns = globPatterns.filter(
+      (globPattern) => {
+        if (globPattern.startsWith(":")) {
+          literalFiles.push(
+            posixPath(path.resolve(baseDirSystem, globPattern.slice(1)))
+          );
+          return false;
+        }
+        return true;
       }
+    ).map((globPattern) => globPattern.replace(/^\\:/u, ":"));
+    const baseMarkdownlintOptions = dirToDirInfo[baseDir].markdownlintOptions;
+    const globsForIgnore =
+      (baseMarkdownlintOptions.globs || []).
+        filter((glob) => glob.startsWith("!"));
+    const filteredLiteralFiles =
+      ((literalFiles.length > 0) && (globsForIgnore.length > 0))
+        ? removeIgnoredFiles(baseDir, literalFiles, globsForIgnore)
+        : literalFiles;
+    // Manually expand directories to avoid globby call to dir-glob.sync
+    const expandedDirectories = await Promise.all(
+      filteredGlobPatterns.map((globPattern) => {
+        const barePattern =
+          globPattern.startsWith("!")
+            ? globPattern.slice(1)
+            : globPattern;
+        const globPath =
+          (path.posix.isAbsolute(barePattern) || path.isAbsolute(barePattern))
+            ? barePattern
+            : path.posix.join(baseDir, barePattern);
+        return fs.promises.stat(globPath).
+          then((stats) => (stats.isDirectory()
+            ? path.posix.join(globPattern, "**")
+            : globPattern)).
+          catch(() => globPattern);
+      })
     );
-  }
-  await Promise.all(tasks);
-};
+    // Process glob patterns
+    // eslint-disable-next-line no-inline-comments
+    const { globby } = await import(/* webpackMode: "eager" */ "globby");
+    const files = [
+      ...await globby(expandedDirectories, globbyOptions),
+      ...filteredLiteralFiles
+    ];
+    for (const file of files) {
+      const dir = path.posix.dirname(file);
+      getAndProcessDirInfo(
+        fs,
+        tasks,
+        dirToDirInfo,
+        dir,
+        null,
+        noRequire,
+        (dirInfo) => {
+          dirInfo.files.push(file);
+        }
+      );
+    }
+    await Promise.all(tasks);
+  };
 
 // Enumerate (possibly missing) parent directories and update directory infos
 const enumerateParents = async (fs, baseDir, dirToDirInfo, noRequire) => {
@@ -517,135 +536,135 @@ const enumerateParents = async (fs, baseDir, dirToDirInfo, noRequire) => {
 
 // Create directory info objects by enumerating file globs
 const createDirInfos =
-// eslint-disable-next-line max-len
-async (fs, baseDirSystem, baseDir, globPatterns, dirToDirInfo, optionsOverride, noErrors, noRequire) => {
-  await enumerateFiles(
-    fs,
-    baseDirSystem,
-    baseDir,
-    globPatterns,
-    dirToDirInfo,
-    noErrors,
-    noRequire
-  );
-  await enumerateParents(
-    fs,
-    baseDir,
-    dirToDirInfo,
-    noRequire
-  );
-
-  // Merge file lists with identical configuration
-  const dirs = Object.keys(dirToDirInfo);
-  dirs.sort((a, b) => b.length - a.length);
-  const dirInfos = [];
-  const noConfigDirInfo =
-    // eslint-disable-next-line unicorn/consistent-function-scoping
-    (dirInfo) => (
-      dirInfo.parent &&
-      !dirInfo.markdownlintConfig &&
-      !dirInfo.markdownlintOptions
+  // eslint-disable-next-line max-len
+  async (fs, baseDirSystem, baseDir, globPatterns, dirToDirInfo, optionsOverride, noErrors, noRequire) => {
+    await enumerateFiles(
+      fs,
+      baseDirSystem,
+      baseDir,
+      globPatterns,
+      dirToDirInfo,
+      noErrors,
+      noRequire
     );
-  const tasks = [];
-  for (const dir of dirs) {
-    const dirInfo = dirToDirInfo[dir];
-    if (noConfigDirInfo(dirInfo)) {
-      if (dirInfo.parent) {
-        appendToArray(dirInfo.parent.files, dirInfo.files);
-      }
-      dirToDirInfo[dir] = null;
-    } else {
-      const { markdownlintOptions, relativeDir } = dirInfo;
-      if (markdownlintOptions && markdownlintOptions.customRules) {
-        tasks.push(
-          importOrRequireIds(
-            relativeDir || dir,
-            markdownlintOptions.customRules,
-            noRequire
-          ).then((customRules) => {
-            // Expand nested arrays (for packages that export multiple rules)
-            markdownlintOptions.customRules = customRules.flat();
-          })
-        );
-      }
-      if (markdownlintOptions && markdownlintOptions.markdownItPlugins) {
-        tasks.push(
-          importOrRequireIdsAndParams(
-            relativeDir || dir,
-            markdownlintOptions.markdownItPlugins,
-            noRequire
-          ).then((markdownItPlugins) => {
-            markdownlintOptions.markdownItPlugins = markdownItPlugins;
-          })
-        );
+    await enumerateParents(
+      fs,
+      baseDir,
+      dirToDirInfo,
+      noRequire
+    );
+
+    // Merge file lists with identical configuration
+    const dirs = Object.keys(dirToDirInfo);
+    dirs.sort((a, b) => b.length - a.length);
+    const dirInfos = [];
+    const noConfigDirInfo =
+      // eslint-disable-next-line unicorn/consistent-function-scoping
+      (dirInfo) => (
+        dirInfo.parent &&
+        !dirInfo.markdownlintConfig &&
+        !dirInfo.markdownlintOptions
+      );
+    const tasks = [];
+    for (const dir of dirs) {
+      const dirInfo = dirToDirInfo[dir];
+      if (noConfigDirInfo(dirInfo)) {
+        if (dirInfo.parent) {
+          appendToArray(dirInfo.parent.files, dirInfo.files);
+        }
+        dirToDirInfo[dir] = null;
+      } else {
+        const { markdownlintOptions, relativeDir } = dirInfo;
+        if (markdownlintOptions && markdownlintOptions.customRules) {
+          tasks.push(
+            importOrRequireIds(
+              relativeDir || dir,
+              markdownlintOptions.customRules,
+              noRequire
+            ).then((customRules) => {
+              // Expand nested arrays (for packages that export multiple rules)
+              markdownlintOptions.customRules = customRules.flat();
+            })
+          );
+        }
+        if (markdownlintOptions && markdownlintOptions.markdownItPlugins) {
+          tasks.push(
+            importOrRequireIdsAndParams(
+              relativeDir || dir,
+              markdownlintOptions.markdownItPlugins,
+              noRequire
+            ).then((markdownItPlugins) => {
+              markdownlintOptions.markdownItPlugins = markdownItPlugins;
+            })
+          );
+        }
+        dirInfos.push(dirInfo);
       }
-      dirInfos.push(dirInfo);
     }
-  }
-  await Promise.all(tasks);
-  for (const dirInfo of dirInfos) {
-    while (dirInfo.parent && !dirToDirInfo[dirInfo.parent.dir]) {
-      dirInfo.parent = dirInfo.parent.parent;
+    await Promise.all(tasks);
+    for (const dirInfo of dirInfos) {
+      while (dirInfo.parent && !dirToDirInfo[dirInfo.parent.dir]) {
+        dirInfo.parent = dirInfo.parent.parent;
+      }
     }
-  }
 
-  // Verify dirInfos is simplified
-  // if (
-  //   dirInfos.filter(
-  //     (di) => di.parent && !dirInfos.includes(di.parent)
-  //   ).length > 0
-  // ) {
-  //   throw new Error("Extra parent");
-  // }
-  // if (
-  //   dirInfos.filter(
-  //     (di) => !di.parent && (di.dir !== baseDir)
-  //   ).length > 0
-  // ) {
-  //   throw new Error("Missing parent");
-  // }
-  // if (
-  //   dirInfos.filter(
-  //     (di) => di.parent &&
-  //       !((di.markdownlintConfig ? 1 : 0) ^ (di.markdownlintOptions ? 1 : 0))
-  //   ).length > 0
-  // ) {
-  //   throw new Error("Missing object");
-  // }
-  // if (dirInfos.filter((di) => di.dir === "/").length > 0) {
-  //   throw new Error("Includes root");
-  // }
-
-  // Merge configuration by inheritance
-  for (const dirInfo of dirInfos) {
-    let markdownlintOptions = dirInfo.markdownlintOptions || {};
-    let { markdownlintConfig } = dirInfo;
-    let parent = dirInfo;
-    // eslint-disable-next-line prefer-destructuring
-    while ((parent = parent.parent)) {
-      if (parent.markdownlintOptions) {
-        markdownlintOptions = mergeOptions(
-          parent.markdownlintOptions,
-          markdownlintOptions
-        );
-      }
-      if (
-        !markdownlintConfig &&
-        parent.markdownlintConfig &&
-        !markdownlintOptions.config
-      ) {
-        // eslint-disable-next-line prefer-destructuring
-        markdownlintConfig = parent.markdownlintConfig;
+    // Verify dirInfos is simplified
+    // if (
+    //   dirInfos.filter(
+    //     (di) => di.parent && !dirInfos.includes(di.parent)
+    //   ).length > 0
+    // ) {
+    //   throw new Error("Extra parent");
+    // }
+    // if (
+    //   dirInfos.filter(
+    //     (di) => !di.parent && (di.dir !== baseDir)
+    //   ).length > 0
+    // ) {
+    //   throw new Error("Missing parent");
+    // }
+    // if (
+    //   dirInfos.filter(
+    //     (di) => di.parent &&
+    //     !((di.markdownlintConfig ? 1 : 0) ^ (di.markdownlintOptions ? 1 : 0))
+    //   ).length > 0
+    // ) {
+    //   throw new Error("Missing object");
+    // }
+    // if (dirInfos.filter((di) => di.dir === "/").length > 0) {
+    //   throw new Error("Includes root");
+    // }
+
+    // Merge configuration by inheritance
+    for (const dirInfo of dirInfos) {
+      let markdownlintOptions = dirInfo.markdownlintOptions || {};
+      let { markdownlintConfig } = dirInfo;
+      let parent = dirInfo;
+      // eslint-disable-next-line prefer-destructuring
+      while ((parent = parent.parent)) {
+        if (parent.markdownlintOptions) {
+          markdownlintOptions = mergeOptions(
+            parent.markdownlintOptions,
+            markdownlintOptions
+          );
+        }
+        if (
+          !markdownlintConfig &&
+          parent.markdownlintConfig &&
+          !markdownlintOptions.config
+        ) {
+          // eslint-disable-next-line prefer-destructuring
+          markdownlintConfig = parent.markdownlintConfig;
+        }
       }
+      dirInfo.markdownlintOptions = mergeOptions(
+        markdownlintOptions,
+        optionsOverride
+      );
+      dirInfo.markdownlintConfig = markdownlintConfig;
     }
-    dirInfo.markdownlintOptions = mergeOptions(
-      markdownlintOptions,
-      optionsOverride
-    );
-    dirInfo.markdownlintConfig = markdownlintConfig;
-  }
-  return dirInfos;
-};
+    return dirInfos;
+  };
 
 // Lint files in groups by shared configuration
 const lintFiles = async (fs, dirInfos, fileContents) => {
@@ -678,7 +697,7 @@ const lintFiles = async (fs, dirInfos, fileContents) => {
       "files": filteredFiles,
       "strings": filteredStrings,
       "config": markdownlintConfig || markdownlintOptions.config,
-      "configParsers": [ jsoncParse ],
+      "configParsers": [ jsoncParse, yamlParse ],
       "customRules": markdownlintOptions.customRules,
       "frontMatter": markdownlintOptions.frontMatter
         ? new RegExp(markdownlintOptions.frontMatter, "u")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint-cli2",
-  "version": "0.5.1",
+  "version": "0.7.0",
   "description": "A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the `markdownlint` library",
   "author": {
     "name": "David Anson",
@@ -9,7 +9,11 @@
   "license": "MIT",
   "type": "commonjs",
   "main": "./markdownlint-cli2.js",
-  "exports": "./markdownlint-cli2.js",
+  "exports": {
+    ".": "./markdownlint-cli2.js",
+    "./markdownlint": "./export-markdownlint.js",
+    "./markdownlint/helpers": "./export-markdownlint-helpers.js"
+  },
   "bin": {
     "markdownlint-cli2": "markdownlint-cli2.js",
     "markdownlint-cli2-config": "markdownlint-cli2-config.js",
@@ -23,6 +27,7 @@
   "bugs": "https://github.com/DavidAnson/markdownlint-cli2/issues",
   "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",
     "docker-npm-install": "docker run --rm --tty --name npm-install --volume $PWD:/home/workdir --workdir /home/workdir --user node node:16 npm install",
     "docker-npm-run-upgrade": "docker run --rm --tty --name npm-run-upgrade --volume $PWD:/home/workdir --workdir /home/workdir --user node node:16 npm run upgrade",
@@ -32,19 +37,23 @@
     "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 .",
     "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-docker-image": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2:v$VERSION \"*.md\"",
+    "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-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\"",
     "test-cover": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 npm test",
     "test-watch": "git ls-files | entr npm run test",
-    "update-snapshots": "ava --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.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"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=14.18.0"
   },
   "files": [
     "append-to-array.js",
+    "export-markdownlint.js",
+    "export-markdownlint-helpers.js",
     "markdownlint-cli2.js",
     "markdownlint-cli2-config.js",
     "markdownlint-cli2-fix.js",
@@ -52,29 +61,30 @@
     "resolve-and-require.js"
   ],
   "dependencies": {
-    "globby": "13.1.2",
-    "markdownlint": "0.26.2",
-    "markdownlint-cli2-formatter-default": "0.0.3",
+    "globby": "13.1.4",
+    "markdownlint": "0.28.1",
+    "markdownlint-cli2-formatter-default": "0.0.4",
     "micromatch": "4.0.5",
     "strip-json-comments": "5.0.0",
-    "yaml": "2.1.1"
+    "yaml": "2.2.1"
   },
   "devDependencies": {
     "@iktakahiro/markdown-it-katex": "4.0.1",
-    "ava": "4.3.1",
-    "c8": "7.12.0",
+    "ava": "5.2.0",
+    "c8": "7.13.0",
     "cpy": "9.0.1",
     "del": "7.0.0",
-    "eslint": "8.21.0",
-    "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-unicorn": "43.0.2",
-    "execa": "6.1.0",
+    "eslint": "8.38.0",
+    "eslint-plugin-n": "15.7.0",
+    "eslint-plugin-unicorn": "46.0.0",
+    "execa": "7.1.1",
     "markdown-it-emoji": "2.0.2",
     "markdown-it-for-inline": "0.1.1",
-    "markdownlint-cli2-formatter-json": "0.0.6",
-    "markdownlint-cli2-formatter-junit": "0.0.5",
-    "markdownlint-cli2-formatter-pretty": "0.0.3",
-    "markdownlint-cli2-formatter-summarize": "0.0.5",
+    "markdownlint-cli2-formatter-codequality": "0.0.4",
+    "markdownlint-cli2-formatter-json": "0.0.7",
+    "markdownlint-cli2-formatter-junit": "0.0.6",
+    "markdownlint-cli2-formatter-pretty": "0.0.4",
+    "markdownlint-cli2-formatter-summarize": "0.0.6",
     "markdownlint-rule-titlecase": "0.1.0",
     "npm-run-all": "4.1.5"
   },