markdownlint-cli2 0.4.0 → 0.5.0

package/README.md

@@ -20,8 +20,11 @@ As a development dependency of the current package:
 npm install markdownlint-cli2 --save-dev
 ```
 
-Or [use the container image](#container-image) available on
-[Docker Hub as davidanson/markdownlint-cli2][docker-hub-markdownlint-cli2].
+Or as a Docker container image:
+
+```shell
+docker pull davidanson/markdownlint-cli2
+```
 
 ## Overview
 
@@ -70,10 +73,10 @@ Dot-only glob:
 Configuration via:
 - .markdownlint-cli2.jsonc
 - .markdownlint-cli2.yaml
-- .markdownlint-cli2.cjs
+- .markdownlint-cli2.cjs or .markdownlint-cli2.mjs
 - .markdownlint.jsonc or .markdownlint.json
 - .markdownlint.yaml or .markdownlint.yml
-- .markdownlint.cjs
+- .markdownlint.cjs or .markdownlint.mjs
 
 Cross-platform compatibility:
 - UNIX and Windows shells expand globs according to different rules; quoting arguments is recommended
@@ -87,9 +90,9 @@ $ markdownlint-cli2 "**/*.md" "#node_modules"
 ```
 
 For scenarios where it is preferable to specify glob expressions in a
-configuration file, the `globs` property of `.markdownlint-cli2.jsonc` or
-`.markdownlint-cli2.yaml` or `.markdownlint-cli2.cjs` may be used instead of (or
-in addition to) passing `glob0 ... globN` on the command-line.
+configuration file, the `globs` property of `.markdownlint-cli2.jsonc`, `.yaml`,
+`.cjs`, or `.mjs` may be used instead of (or in addition to) passing
+`glob0 ... globN` on the command-line.
 
 As shown above, a typical command-line for `markdownlint-cli2` looks something
 like:
@@ -116,6 +119,10 @@ accepts a path to any supported configuration file as its first argument:
 markdownlint-cli2-config "config/.markdownlint-cli2.jsonc" "**/*.md" "#node_modules"
 ```
 
+The configuration file name must be (or end with) one of the supported types
+above. For example, `.markdownlint.json` or `example.markdownlint-cli2.jsonc`.
+The specified configuration file will be loaded, parsed, and applied as a base
+configuration for the current directory - which will then be handled normally.
 Otherwise, this command behaves identically to `markdownlint-cli2`.
 
 ### Container Image
@@ -124,7 +131,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.4.0 "**/*.md" "#node_modules"
+docker run -v $PWD:/workdir davidanson/markdownlint-cli2:0.5.0 "**/*.md" "#node_modules"
 ```
 
 Notes:
@@ -141,14 +148,14 @@ 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.4.0 "**/*.md" "#node_modules"
+    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:0.5.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.4.0 "**/*.md" "#node_modules"
+docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/markdownlint-cli2:0.5.0 "**/*.md" "#node_modules"
 ```
 
 ### Exit Codes
@@ -172,11 +179,11 @@ 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
-  configuration for that (top-level) directory applies to the entire tree
+- In general, glob expressions match files under the current directory and the
+  configuration for that directory applies to the entire tree.
   - When glob expressions match files *not* under the current directory,
-    configuration for the current (top-level) directory is applied to the
-    closest common parent directory
+    configuration for the current directory is applied to the closest common
+    parent directory.
 
 ### `.markdownlint-cli2.jsonc`
 
@@ -190,8 +197,6 @@ docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/mark
   - `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
-    - Each `String` is passed as the `id` parameter to Node's
-      [require function][nodejs-require]
     - Relative paths are resolved based on the location of the `JSONC` file
     - Search [`markdownlint-rule` on npm][markdownlint-rule]
   - `fix`: `Boolean` value to enable fixing of linting errors reported by rules
@@ -242,9 +247,16 @@ docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/mark
     - This top-level setting is valid **only** in the directory from which
       `markdownlint-cli2` is run
     - Search [`markdownlint-cli2-formatter` on npm][markdownlint-cli2-formatter]
+- When referencing a module via the `customRules`, `markdownItPlugins`, or
+  `outputFormatters` properties, each `String` identifier is passed to Node's
+  [`require` function][nodejs-require] then (if that failed) its
+  [`import` expression][nodejs-import-expression]
+  - Importing a locally-installed module using a bare specifier (ex:
+    `package-name`) or using a directory name (ex: `./package-dir`) will not
+    work until [`import.meta.resolve`][nodejs-import-meta-resolve] is available
 - Settings in this file apply to the directory it is in and all subdirectories.
 - Settings **merge with** those applied by any versions of this file in a parent
-  directory.
+  directory (up to the current directory).
 - For example: [`.markdownlint-cli2.jsonc`][markdownlint-cli2-jsonc] with all
   properties set
 
@@ -258,17 +270,20 @@ docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/mark
 - For example: [`.markdownlint-cli2.yaml`][markdownlint-cli2-yaml] with all
   properties set
 
-### `.markdownlint-cli2.cjs`
+### `.markdownlint-cli2.cjs` or `.markdownlint-cli2.mjs`
 
-- The format of this file is a [CommonJS module][commonjs-module] that exports
-  the object described above for `.markdownlint-cli2.jsonc`.
+- The format of this file is a [CommonJS module][commonjs-module] (`.cjs`) or
+  [ECMAScript module][ecmascript-module] (`.mjs`) that exports the object
+  described above for `.markdownlint-cli2.jsonc`.
 - Instead of passing a `String` to identify the module name/path to load for
   `customRules`, `markdownItPlugins`, and `outputFormatters`, the corresponding
   `Object` or `Function` can be provided directly.
 - Other details are the same as for `.markdownlint-cli2.jsonc` described above.
 - If a `.markdownlint-cli2.jsonc` or `.markdownlint-cli2.yaml` file is present
-  in the same directory, it takes precedence.
-- For example: [`.markdownlint-cli2.cjs`][markdownlint-cli2-cjs]
+  in the same directory, it takes precedence; `.markdownlint-cli2.cjs` takes
+  precedence over `.markdownlint-cli2.mjs`.
+- For example: [`.markdownlint-cli2.cjs`][markdownlint-cli2-cjs] or
+  [`.markdownlint-cli2.mjs`][markdownlint-cli2-mjs]
 
 ### `.markdownlint.jsonc` or `.markdownlint.json`
 
@@ -276,7 +291,7 @@ docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/mark
   the [`markdownlint` `config` object][markdownlint-config].
 - Settings in this file apply to the directory it is in and all subdirectories
 - Settings **override** those applied by any versions of this file in a parent
-  directory.
+  directory (up to the current directory).
 - If `jsonc` and `json` files are present in the same directory, the `jsonc`
   version takes precedence.
 - To merge the settings of these files or share configuration, use the `extends`
@@ -295,14 +310,17 @@ docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/mark
   precedence.
 - For example: [`.markdownlint.yaml`][markdownlint-yaml]
 
-### `.markdownlint.cjs`
+### `.markdownlint.cjs` or `.markdownlint.mjs`
 
-- The format of this file is a [CommonJS module][commonjs-module] that exports
-  the [`markdownlint` `config` object][markdownlint-config].
+- The format of this file is a [CommonJS module][commonjs-module] (`.cjs`) or
+  [ECMAScript module][ecmascript-module] (`.mjs`) that exports the
+  [`markdownlint` `config` object][markdownlint-config].
 - Other details are the same as for `jsonc`/`json` files described above.
-- If a `jsonc`, `json`, `yaml`, or `yml` file is present in the same directory,
-  it takes precedence.
-- For example: [`.markdownlint.cjs`][markdownlint-cjs]
+- If a `.markdownlint.jsonc`, `.json`, `.yaml`, or `.yml` file is present in the
+  same directory, it takes precedence; `.markdownlint.cjs` takes precedence over
+  `.markdownlint.mjs`.
+- For example: [`.markdownlint.cjs`][markdownlint-cjs] or
+  [`.markdownlint.mjs`][markdownlint-mjs]
 
 ## Compatibility
 
@@ -326,7 +344,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.4.0
+  rev: v0.5.0
   hooks:
   - id: markdownlint-cli2
 ```
@@ -359,11 +377,13 @@ reference to the `repos` list in that project's `.pre-commit-config.yaml` like:
   - 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
 
 <!-- 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-bind-mounts]: https://docs.docker.com/storage/bind-mounts/
 [docker-hub-markdownlint-cli2]: https://hub.docker.com/r/davidanson/markdownlint-cli2
 [front-matter]: https://jekyllrb.com/docs/frontmatter/
@@ -390,14 +410,18 @@ reference to the `repos` list in that project's `.pre-commit-config.yaml` like:
 [markdownlint-cli2-formatter]: https://www.npmjs.com/search?q=keywords:markdownlint-cli2-formatter
 [markdownlint-cli2-cjs]: test/markdownlint-cli2-cjs/.markdownlint-cli2.cjs
 [markdownlint-cli2-jsonc]: test/markdownlint-cli2-jsonc-example/.markdownlint-cli2.jsonc
+[markdownlint-cli2-mjs]: test/markdownlint-cli2-mjs/.markdownlint-cli2.mjs
 [markdownlint-cli2-yaml]: test/markdownlint-cli2-yaml-example/.markdownlint-cli2.yaml
 [markdownlint-cjs]: test/markdownlint-cjs/.markdownlint.cjs
 [markdownlint-jsonc]: https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.jsonc
+[markdownlint-mjs]: test/markdownlint-mjs/.markdownlint.mjs
 [markdownlint-rule]: https://www.npmjs.com/search?q=keywords:markdownlint-rule
 [markdownlint-yaml]: https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
 [nodejs]: https://nodejs.org/
 [nodejs-docker]: https://github.com/nodejs/docker-node
 [nodejs-docker-non-root]: https://github.com/nodejs/docker-node/blob/main/docs/BestPractices.md#non-root-user
+[nodejs-import-expression]: https://nodejs.org/api/esm.html#import-expressions
+[nodejs-import-meta-resolve]: https://nodejs.org/api/esm.html#importmetaresolvespecifier-parent
 [nodejs-require]: https://nodejs.org/api/modules.html#modules_require_id
 [npm-image]: https://img.shields.io/npm/v/markdownlint-cli2.svg
 [npm-url]: https://www.npmjs.com/package/markdownlint-cli2

package/markdownlint-cli2.js

@@ -10,18 +10,19 @@ const dynamicRequire = (typeof __non_webpack_require__ === "undefined") ? requir
 // Capture native require implementation for dynamic loading of modules
 
 // Requires
-const path = require("path");
+const path = require("node:path");
+const { pathToFileURL } = require("node:url");
 const markdownlintLibrary = require("markdownlint");
 const { markdownlint, "readConfig": markdownlintReadConfig } =
   markdownlintLibrary.promises;
-const markdownlintRuleHelpers = require("markdownlint-rule-helpers");
+const markdownlintRuleHelpers = require("markdownlint/helpers");
 const appendToArray = require("./append-to-array");
 const mergeOptions = require("./merge-options");
 const resolveAndRequire = require("./resolve-and-require");
 
 // Variables
 const packageName = "markdownlint-cli2";
-const packageVersion = "0.4.0";
+const packageVersion = "0.5.0";
 const libraryName = "markdownlint";
 const libraryVersion = markdownlintLibrary.getVersion();
 const dotOnlySubstitute = "*.{md,markdown}";
@@ -64,41 +65,59 @@ const readConfig = (fs, dir, name, otherwise) => {
     );
 };
 
-// Require a module ID with the specified directory in the path
-const requireResolve = (dir, id) => {
+// Import or resolve/require a module ID with a custom directory in the path
+const importOrRequireResolve = async (dir, id) => {
   if (typeof id === "string") {
-    return resolveAndRequire(dynamicRequire, id, dir);
+    const expandId =
+      markdownlintRuleHelpers.expandTildePath(id, require("node:os"));
+    const errors = [];
+    try {
+      return resolveAndRequire(dynamicRequire, expandId, dir);
+    } catch (error) {
+      errors.push(error);
+    }
+    try {
+      const fileUrlString =
+        pathToFileURL(path.resolve(dir, expandId)).toString();
+      // eslint-disable-next-line node/no-unsupported-features/es-syntax
+      const module = await import(fileUrlString);
+      return module.default;
+    } catch (error) {
+      errors.push(error);
+    }
+    // Use AggregateError once available in Node 15+
+    throw new Error(errors.map((error) => error.message).join(" / "));
   }
   return id;
 };
 
-// Require an array of modules by ID
-const requireIds = (dir, ids, noRequire) => (
-  noRequire ? [] : ids.map((id) => requireResolve(dir, id))
+// Import or require an array of modules by ID
+const importOrRequireIds = (dir, ids, noRequire) => (
+  Promise.all(noRequire ? [] : ids.map((id) => importOrRequireResolve(dir, id)))
 );
 
-// Require an array of modules by ID (preserving parameters)
-const requireIdsAndParams = (dir, idsAndParams, noRequire) => {
+// Import or require an array of modules by ID (preserving parameters)
+const importOrRequireIdsAndParams = async (dir, idsAndParams, noRequire) => {
   if (noRequire) {
     return [];
   }
   const ids = idsAndParams.map((entry) => entry[0]);
-  const modules = requireIds(dir, ids);
+  const modules = await importOrRequireIds(dir, ids);
   const modulesAndParams = idsAndParams.
     map((entry, i) => [ modules[i], ...entry.slice(1) ]);
   return modulesAndParams;
 };
 
-// Require a JS file and return the exported object
-const requireConfig = (fs, dir, name, noRequire) => (
+// Import or require a JavaScript file and return the exported object
+const importOrRequireConfig = (fs, dir, name, noRequire, otherwise) => (
   () => (noRequire
     // eslint-disable-next-line prefer-promise-reject-errors
     ? Promise.reject()
     : fs.promises.access(path.posix.join(dir, name))
   ).
     then(
-      () => requireResolve(dir, `./${name}`),
-      noop
+      () => importOrRequireResolve(dir, `./${name}`),
+      otherwise
     )
 );
 
@@ -113,8 +132,13 @@ const readOptionsOrConfig = async (configPath, fs, noRequire) => {
     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")) {
-    options = await (requireConfig(fs, dirname, basename, noRequire)());
+  } 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") ||
@@ -124,8 +148,19 @@ const readOptionsOrConfig = async (configPath, fs, noRequire) => {
     const jsoncParse = await getJsoncParse();
     config =
       await markdownlintReadConfig(configPath, [ jsoncParse, yamlParse ], fs);
-  } else if (basename.endsWith(".markdownlint.cjs")) {
-    config = await (requireConfig(fs, dirname, basename, noRequire)());
+  } 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\")."
+    );
   }
   return options || { config };
 };
@@ -188,10 +223,10 @@ Dot-only glob:
 Configuration via:
 - .markdownlint-cli2.jsonc
 - .markdownlint-cli2.yaml
-- .markdownlint-cli2.cjs
+- .markdownlint-cli2.cjs or .markdownlint-cli2.mjs
 - .markdownlint.jsonc or .markdownlint.json
 - .markdownlint.yaml or .markdownlint.yml
-- .markdownlint.cjs
+- .markdownlint.cjs or .markdownlint.mjs
 
 Cross-platform compatibility:
 - UNIX and Windows shells expand globs according to different rules; quoting arguments is recommended
@@ -208,11 +243,12 @@ $ markdownlint-cli2 "**/*.md" "#node_modules"`
 
 // Get (creating if necessary) and process a directory's info object
 const getAndProcessDirInfo =
-(fs, tasks, dirToDirInfo, dir, noRequire, func) => {
+(fs, tasks, dirToDirInfo, dir, relativeDir, noRequire, func) => {
   let dirInfo = dirToDirInfo[dir];
   if (!dirInfo) {
     dirInfo = {
       dir,
+      relativeDir,
       "parent": null,
       "files": [],
       "markdownlintConfig": null,
@@ -239,11 +275,18 @@ const getAndProcessDirInfo =
               () => fs.promises.
                 readFile(markdownlintCli2Yaml, utf8).
                 then(yamlParse),
-              requireConfig(
+              importOrRequireConfig(
                 fs,
                 dir,
                 ".markdownlint-cli2.cjs",
-                noRequire
+                noRequire,
+                importOrRequireConfig(
+                  fs,
+                  dir,
+                  ".markdownlint-cli2.mjs",
+                  noRequire,
+                  noop
+                )
               )
             )
         ).
@@ -270,11 +313,18 @@ const getAndProcessDirInfo =
               fs,
               dir,
               ".markdownlint.yml",
-              requireConfig(
+              importOrRequireConfig(
                 fs,
                 dir,
                 ".markdownlint.cjs",
-                noRequire
+                noRequire,
+                importOrRequireConfig(
+                  fs,
+                  dir,
+                  ".markdownlint.mjs",
+                  noRequire,
+                  noop
+                )
               )
             )
           )
@@ -297,20 +347,28 @@ const getAndProcessDirInfo =
 const getBaseOptions = async (
   fs,
   baseDir,
+  relativeDir,
   globPatterns,
-  optionsDefault,
+  options,
   fixDefault,
   noGlobs,
   noRequire
 ) => {
   const tasks = [];
   const dirToDirInfo = {};
-  getAndProcessDirInfo(fs, tasks, dirToDirInfo, baseDir, noRequire);
+  getAndProcessDirInfo(
+    fs,
+    tasks,
+    dirToDirInfo,
+    baseDir,
+    relativeDir,
+    noRequire
+  );
   await Promise.all(tasks);
   // eslint-disable-next-line no-multi-assign
   const baseMarkdownlintOptions = dirToDirInfo[baseDir].markdownlintOptions =
     mergeOptions(
-      mergeOptions(optionsDefault, { "fix": fixDefault }),
+      mergeOptions(options, { "fix": fixDefault }),
       dirToDirInfo[baseDir].markdownlintOptions
     );
 
@@ -340,6 +398,7 @@ async (fs, baseDirSystem, baseDir, globPatterns, dirToDirInfo, noErrors, noRequi
   const globbyOptions = {
     "absolute": true,
     "cwd": baseDir,
+    "dot": true,
     "expandDirectories": false,
     fs
   };
@@ -400,6 +459,7 @@ async (fs, baseDirSystem, baseDir, globPatterns, dirToDirInfo, noErrors, noRequi
       tasks,
       dirToDirInfo,
       dir,
+      null,
       noRequire,
       (dirInfo) => {
         dirInfo.files.push(file);
@@ -437,6 +497,7 @@ const enumerateParents = async (fs, baseDir, dirToDirInfo, noRequire) => {
           tasks,
           dirToDirInfo,
           dir,
+          null,
           noRequire,
           // eslint-disable-next-line no-loop-func
           (dirInfo) => {
@@ -478,11 +539,13 @@ async (fs, baseDirSystem, baseDir, globPatterns, dirToDirInfo, optionsOverride,
   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)) {
@@ -491,28 +554,34 @@ async (fs, baseDirSystem, baseDir, globPatterns, dirToDirInfo, optionsOverride,
       }
       dirToDirInfo[dir] = null;
     } else {
-      const { markdownlintOptions } = dirInfo;
+      const { markdownlintOptions, relativeDir } = dirInfo;
       if (markdownlintOptions && markdownlintOptions.customRules) {
-        const customRules =
-          requireIds(
-            dir,
+        tasks.push(
+          importOrRequireIds(
+            relativeDir || dir,
             markdownlintOptions.customRules,
             noRequire
-          );
-        // Expand nested arrays (for packages that export multiple rules)
-        markdownlintOptions.customRules = customRules.flat();
+          ).then((customRules) => {
+            // Expand nested arrays (for packages that export multiple rules)
+            markdownlintOptions.customRules = customRules.flat();
+          })
+        );
       }
       if (markdownlintOptions && markdownlintOptions.markdownItPlugins) {
-        markdownlintOptions.markdownItPlugins =
-          requireIdsAndParams(
-            dir,
+        tasks.push(
+          importOrRequireIdsAndParams(
+            relativeDir || dir,
             markdownlintOptions.markdownItPlugins,
             noRequire
-          );
+          ).then((markdownItPlugins) => {
+            markdownlintOptions.markdownItPlugins = markdownItPlugins;
+          })
+        );
       }
       dirInfos.push(dirInfo);
     }
   }
+  await Promise.all(tasks);
   for (const dirInfo of dirInfos) {
     while (dirInfo.parent && !dirToDirInfo[dirInfo.parent.dir]) {
       dirInfo.parent = dirInfo.parent.parent;
@@ -578,7 +647,8 @@ async (fs, baseDirSystem, baseDir, globPatterns, dirToDirInfo, optionsOverride,
 };
 
 // Lint files in groups by shared configuration
-const lintFiles = (fs, dirInfos, fileContents) => {
+const lintFiles = async (fs, dirInfos, fileContents) => {
+  const jsoncParse = await getJsoncParse();
   const tasks = [];
   // For each dirInfo
   for (const dirInfo of dirInfos) {
@@ -607,6 +677,7 @@ const lintFiles = (fs, dirInfos, fileContents) => {
       "files": filteredFiles,
       "strings": filteredStrings,
       "config": markdownlintConfig || markdownlintOptions.config,
+      "configParsers": [ jsoncParse ],
       "customRules": markdownlintOptions.customRules,
       "frontMatter": markdownlintOptions.frontMatter
         ? new RegExp(markdownlintOptions.frontMatter, "u")
@@ -688,26 +759,33 @@ const createSummary = (baseDir, taskResults) => {
 };
 
 // Output summary via formatters
-const outputSummary =
-  async (baseDir, summary, outputFormatters, logMessage, logError) => {
-    const errorsPresent = (summary.length > 0);
-    if (errorsPresent || outputFormatters) {
-      const formatterOptions = {
-        "directory": baseDir,
-        "results": summary,
-        logMessage,
-        logError
-      };
-      const formattersAndParams = outputFormatters
-        ? requireIdsAndParams(baseDir, outputFormatters)
-        : [ [ require("markdownlint-cli2-formatter-default") ] ];
-      await Promise.all(formattersAndParams.map((formatterAndParams) => {
-        const [ formatter, ...formatterParams ] = formatterAndParams;
-        return formatter(formatterOptions, ...formatterParams);
-      }));
-    }
-    return errorsPresent;
-  };
+const outputSummary = async (
+  baseDir,
+  relativeDir,
+  summary,
+  outputFormatters,
+  logMessage,
+  logError
+) => {
+  const errorsPresent = (summary.length > 0);
+  if (errorsPresent || outputFormatters) {
+    const formatterOptions = {
+      "directory": baseDir,
+      "results": summary,
+      logMessage,
+      logError
+    };
+    const dir = relativeDir || baseDir;
+    const formattersAndParams = outputFormatters
+      ? await importOrRequireIdsAndParams(dir, outputFormatters)
+      : [ [ require("markdownlint-cli2-formatter-default") ] ];
+    await Promise.all(formattersAndParams.map((formatterAndParams) => {
+      const [ formatter, ...formatterParams ] = formatterAndParams;
+      return formatter(formatterOptions, ...formatterParams);
+    }));
+  }
+  return errorsPresent;
+};
 
 // Main function
 const main = async (params) => {
@@ -727,7 +805,7 @@ const main = async (params) => {
   } = params;
   const logMessage = params.logMessage || noop;
   const logError = params.logError || noop;
-  const fs = params.fs || require("fs");
+  const fs = params.fs || require("node:fs");
   const baseDirSystem =
     (directory && path.resolve(directory)) ||
     process.cwd();
@@ -739,10 +817,12 @@ const main = async (params) => {
   );
   // Read argv configuration file (if relevant and present)
   let optionsArgv = null;
+  let relativeDir = null;
   const [ configPath ] = (argv || []);
   if ((name === "markdownlint-cli2-config") && configPath) {
     optionsArgv =
       await readOptionsOrConfig(configPath, fs, noRequire);
+    relativeDir = path.dirname(configPath);
   }
   // Process arguments and get base options
   const globPatterns = processArgv(optionsArgv ? argv.slice(1) : argv);
@@ -750,6 +830,7 @@ const main = async (params) => {
     await getBaseOptions(
       fs,
       baseDir,
+      relativeDir,
       globPatterns,
       optionsArgv || optionsDefault,
       fixDefault,
@@ -810,7 +891,7 @@ const main = async (params) => {
     (optionsOverride && optionsOverride.outputFormatters) ||
     baseMarkdownlintOptions.outputFormatters;
   const errorsPresent = await outputSummary(
-    baseDir, summary, outputFormatters, logMessage, logError
+    baseDir, relativeDir, summary, outputFormatters, logMessage, logError
   );
   // Return result
   return errorsPresent ? 1 : 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdownlint-cli2",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the `markdownlint` library",
   "author": {
     "name": "David Anson",
@@ -8,7 +8,7 @@
   },
   "license": "MIT",
   "type": "commonjs",
-  "main": "markdownlint-cli2.js",
+  "exports": "./markdownlint-cli2.js",
   "bin": {
     "markdownlint-cli2": "markdownlint-cli2.js",
     "markdownlint-cli2-config": "markdownlint-cli2-config.js",
@@ -21,24 +21,26 @@
   },
   "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:$VERSION -f docker/Dockerfile .",
+    "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 .",
     "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",
     "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",
-    "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:$VERSION -t davidanson/markdownlint-cli2:latest -f docker/Dockerfile --push .",
+    "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:$VERSION \"*.md\"",
-    "test-docker-hub-image": "VERSION=$(node -e \"process.stdout.write(require('./package.json').version)\") && docker image rm davidanson/markdownlint-cli2:$VERSION davidanson/markdownlint-cli2:latest || true && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2:$VERSION \"*.md\" && docker run --rm -v $PWD:/workdir davidanson/markdownlint-cli2:latest \"*.md\"",
+    "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-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-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",
-    "upgrade": "npx --yes npm-check-updates --upgrade"
+    "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": ">=12"
+    "node": ">=14"
   },
   "files": [
     "append-to-array.js",
@@ -49,31 +51,29 @@
     "resolve-and-require.js"
   ],
   "dependencies": {
-    "globby": "12.1.0",
-    "markdownlint": "0.25.1",
+    "globby": "13.1.2",
+    "markdownlint": "0.26.1",
     "markdownlint-cli2-formatter-default": "0.0.3",
-    "markdownlint-rule-helpers": "0.16.0",
-    "micromatch": "4.0.4",
-    "strip-json-comments": "4.0.0",
-    "yaml": "1.10.2"
+    "micromatch": "4.0.5",
+    "strip-json-comments": "5.0.0",
+    "yaml": "2.1.1"
   },
   "devDependencies": {
     "@iktakahiro/markdown-it-katex": "4.0.1",
-    "ava": "4.0.1",
-    "c8": "7.11.0",
-    "cpy": "8.1.2",
-    "del": "6.0.0",
-    "eslint": "8.6.0",
+    "ava": "4.3.1",
+    "c8": "7.12.0",
+    "cpy": "9.0.1",
+    "del": "7.0.0",
+    "eslint": "8.20.0",
     "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-unicorn": "40.0.0",
-    "execa": "6.0.0",
-    "markdown-it-emoji": "2.0.0",
+    "eslint-plugin-unicorn": "43.0.2",
+    "execa": "6.1.0",
+    "markdown-it-emoji": "2.0.2",
     "markdown-it-for-inline": "0.1.1",
-    "markdownlint-cli2-formatter-json": "0.0.5",
-    "markdownlint-cli2-formatter-junit": "0.0.4",
+    "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-rule-github-internal-links": "0.1.0",
     "markdownlint-rule-titlecase": "0.1.0",
     "npm-run-all": "4.1.5"
   },