markdownlint-cli2 0.2.0 → 0.4.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2021 David Anson
+Copyright (c) 2020-2022 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

@@ -20,6 +20,9 @@ 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].
+
 ## Overview
 
 - [`markdownlint`][markdownlint] is a library for linting [Markdown][markdown]/
@@ -41,18 +44,23 @@ npm install markdownlint-cli2 --save-dev
 
 ## Use
 
+### Command Line
+
 ```text
 markdownlint-cli2 vX.Y.Z (markdownlint vX.Y.Z)
 https://github.com/DavidAnson/markdownlint-cli2
 
 Syntax: markdownlint-cli2 glob0 [glob1] [...] [globN]
+        markdownlint-cli2-fix glob0 [glob1] [...] [globN]
+        markdownlint-cli2-config config-file glob0 [glob1] [...] [globN]
 
 Glob expressions (from the globby library):
 - * matches any number of characters, but not /
 - ? matches a single character, but not /
-- ** matches any number of characters, including / (when it's the only thing in a path part)
+- ** matches any number of characters, including /
 - {} allows for a comma-separated list of "or" expressions
 - ! or # at the beginning of a pattern negate the match
+- : at the beginning identifies a literal file path
 
 Dot-only glob:
 - The command "markdownlint-cli2 ." would lint every file in the current directory tree which is probably not intended
@@ -62,10 +70,10 @@ Dot-only glob:
 Configuration via:
 - .markdownlint-cli2.jsonc
 - .markdownlint-cli2.yaml
-- .markdownlint-cli2.js
+- .markdownlint-cli2.cjs
 - .markdownlint.jsonc or .markdownlint.json
 - .markdownlint.yaml or .markdownlint.yml
-- .markdownlint.js
+- .markdownlint.cjs
 
 Cross-platform compatibility:
 - UNIX and Windows shells expand globs according to different rules; quoting arguments is recommended
@@ -74,31 +82,74 @@ Cross-platform compatibility:
 - Some UNIX shells parse exclamation (!) in double-quotes; hashtag (#) is recommended in these cases
 - The path separator is forward slash (/) on all platforms; backslash (\) is automatically converted
 
-Therefore, the most compatible glob syntax for cross-platform support:
+The most compatible syntax for cross-platform support:
 $ 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.js` may be used instead of (or
+`.markdownlint-cli2.yaml` or `.markdownlint-cli2.cjs` may be used instead of (or
 in addition to) passing `glob0 ... globN` on the command-line.
 
-As shown above, the default command-line for `markdownlint-cli2` looks something
+As shown above, a typical command-line for `markdownlint-cli2` looks something
 like:
 
 ```bash
 markdownlint-cli2 "**/*.md" "#node_modules"
 ```
 
-However, because sharing configuration between "normal" and "fix" modes is so
+Because sharing the same configuration between "normal" and "fix" modes is
 common, the following command defaults the `fix` property (see below) to `true`:
 
 ```bash
 markdownlint-cli2-fix "**/*.md" "#node_modules"
 ```
 
-Other than the default behavior of the `fix` property (which can be overridden
-in both cases), these two commands behave identically.
+Other than the default behavior of the `fix` property (which can be overridden),
+these two commands behave identically.
+
+In cases where it is not convenient to store a configuration file in the root
+of a project, the `markdownlint-cli2-config` command can be used. This command
+accepts a path to any supported configuration file as its first argument:
+
+```bash
+markdownlint-cli2-config "config/.markdownlint-cli2.jsonc" "**/*.md" "#node_modules"
+```
+
+Otherwise, this command behaves identically to `markdownlint-cli2`.
+
+### Container Image
+
+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"
+```
+
+Notes:
+
+- As when using the [command line](#command-line), glob patterns are passed as
+  arguments.
+- This image is built on the official [Node.js Docker image][nodejs-docker].
+  Per security best practices, the [default user `node`][nodejs-docker-non-root]
+  runs with restricted permissions. If it is necessary to run as `root`, pass
+  the `-u root` option when invoking `docker`.
+- By default, `markdownlint-cli2` will execute within the `/workdir` directory
+  *inside the container*. So, as shown above, [bind mount][docker-bind-mounts]
+  the project's directory there.
+  - 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"
+    ```
+
+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"
+```
 
 ### Exit Codes
 
@@ -207,7 +258,7 @@ in both cases), these two commands behave identically.
 - For example: [`.markdownlint-cli2.yaml`][markdownlint-cli2-yaml] with all
   properties set
 
-### `.markdownlint-cli2.js`
+### `.markdownlint-cli2.cjs`
 
 - The format of this file is a [CommonJS module][commonjs-module] that exports
   the object described above for `.markdownlint-cli2.jsonc`.
@@ -217,7 +268,7 @@ in both cases), these two commands behave identically.
 - 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.js`][markdownlint-cli2-js]
+- For example: [`.markdownlint-cli2.cjs`][markdownlint-cli2-cjs]
 
 ### `.markdownlint.jsonc` or `.markdownlint.json`
 
@@ -244,14 +295,14 @@ in both cases), these two commands behave identically.
   precedence.
 - For example: [`.markdownlint.yaml`][markdownlint-yaml]
 
-### `.markdownlint.js`
+### `.markdownlint.cjs`
 
 - The format of this file is a [CommonJS module][commonjs-module] 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.js`][markdownlint-js]
+- For example: [`.markdownlint.cjs`][markdownlint-cjs]
 
 ## Compatibility
 
@@ -275,7 +326,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.2.0
+  rev: v0.4.0
   hooks:
   - id: markdownlint-cli2
 ```
@@ -304,11 +355,17 @@ reference to the `repos` list in that project's `.pre-commit-config.yaml` like:
   - 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)
 
 <!-- markdownlint-disable line-length -->
 
 [commonmark]: https://commonmark.org/
 [commonjs-module]: https://nodejs.org/api/modules.html#modules_modules_commonjs_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/
 [globby]: https://www.npmjs.com/package/globby
 [html-comment]: https://developer.mozilla.org/en-US/docs/Learn/HTML/Introduction_to_HTML/Getting_started
@@ -331,14 +388,16 @@ reference to the `repos` list in that project's `.pre-commit-config.yaml` like:
 [markdownlint-cli2]: https://github.com/DavidAnson/markdownlint-cli2
 [markdownlint-cli2-blog]: https://dlaa.me/blog/post/markdownlintcli2
 [markdownlint-cli2-formatter]: https://www.npmjs.com/search?q=keywords:markdownlint-cli2-formatter
-[markdownlint-cli2-js]: test/markdownlint-cli2-js/.markdownlint-cli2.js
+[markdownlint-cli2-cjs]: test/markdownlint-cli2-cjs/.markdownlint-cli2.cjs
 [markdownlint-cli2-jsonc]: test/markdownlint-cli2-jsonc-example/.markdownlint-cli2.jsonc
 [markdownlint-cli2-yaml]: test/markdownlint-cli2-yaml-example/.markdownlint-cli2.yaml
-[markdownlint-js]: test/markdownlint-js/.markdownlint.js
+[markdownlint-cjs]: test/markdownlint-cjs/.markdownlint.cjs
 [markdownlint-jsonc]: https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.jsonc
 [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-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-config.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+
+// @ts-check
+
+"use strict";
+
+const { run } = require("./markdownlint-cli2");
+
+run({
+  "name": "markdownlint-cli2-config"
+});

package/markdownlint-cli2-fix.js

@@ -7,5 +7,6 @@
 const { run } = require("./markdownlint-cli2");
 
 run({
-  "fixDefault": true
+  "fixDefault": true,
+  "name": "markdownlint-cli2-fix"
 });

package/markdownlint-cli2.js

@@ -10,9 +10,7 @@ const dynamicRequire = (typeof __non_webpack_require__ === "undefined") ? requir
 // Capture native require implementation for dynamic loading of modules
 
 // Requires
-const fs = require("fs").promises;
 const path = require("path");
-const globby = require("globby");
 const markdownlintLibrary = require("markdownlint");
 const { markdownlint, "readConfig": markdownlintReadConfig } =
   markdownlintLibrary.promises;
@@ -23,7 +21,7 @@ const resolveAndRequire = require("./resolve-and-require");
 
 // Variables
 const packageName = "markdownlint-cli2";
-const packageVersion = "0.2.0";
+const packageVersion = "0.4.0";
 const libraryName = "markdownlint";
 const libraryVersion = markdownlintLibrary.getVersion();
 const dotOnlySubstitute = "*.{md,markdown}";
@@ -32,10 +30,16 @@ const utf8 = "utf8";
 // No-op function
 const noop = () => null;
 
-// Parse JSONC text
-const jsoncParse = (text) => JSON.parse(require("strip-json-comments")(text));
+// 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
+    await import(/* webpackMode: "eager" */ "strip-json-comments");
+  return (text) => JSON.parse(stripJsonComments(text));
+};
 
-// Parse YAML text
+// Synchronous function to parse YAML text
 const yamlParse = (text) => require("yaml").parse(text);
 
 // Negate a glob
@@ -45,12 +49,17 @@ const negateGlob = (glob) => `!${glob}`;
 const posixPath = (p) => p.split(path.sep).join(path.posix.sep);
 
 // Read a JSON(C) or YAML file and return the object
-const readConfig = (dir, name, otherwise) => {
+const readConfig = (fs, dir, name, otherwise) => {
   const file = path.posix.join(dir, name);
-  return () => fs.access(file).
+  return () => fs.promises.access(file).
     then(
-      // @ts-ignore
-      () => markdownlintReadConfig(file, [ jsoncParse, yamlParse ]),
+      () => getJsoncParse().then(
+        (jsoncParse) => markdownlintReadConfig(
+          file,
+          [ jsoncParse, yamlParse ],
+          fs
+        )
+      ),
       otherwise
     );
 };
@@ -81,20 +90,71 @@ const requireIdsAndParams = (dir, idsAndParams, noRequire) => {
 };
 
 // Require a JS file and return the exported object
-const requireConfig = (dir, name, noRequire) => {
-  const file = path.posix.join(dir, name);
-  // eslint-disable-next-line prefer-promise-reject-errors
-  return () => (noRequire ? Promise.reject() : fs.access(file)).
+const requireConfig = (fs, dir, name, noRequire) => (
+  () => (noRequire
+    // eslint-disable-next-line prefer-promise-reject-errors
+    ? Promise.reject()
+    : fs.promises.access(path.posix.join(dir, name))
+  ).
     then(
       () => requireResolve(dir, `./${name}`),
       noop
-    );
+    )
+);
+
+// Read an options or config file in any format and return the object
+const readOptionsOrConfig = async (configPath, fs, noRequire) => {
+  const basename = path.basename(configPath);
+  const dirname = path.dirname(configPath);
+  let options = null;
+  let config = null;
+  if (basename.endsWith(".markdownlint-cli2.jsonc")) {
+    const jsoncParse = await getJsoncParse();
+    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.jsonc") ||
+    basename.endsWith(".markdownlint.json") ||
+    basename.endsWith(".markdownlint.yaml") ||
+    basename.endsWith(".markdownlint.yml")
+  ) {
+    const jsoncParse = await getJsoncParse();
+    config =
+      await markdownlintReadConfig(configPath, [ jsoncParse, yamlParse ], fs);
+  } else if (basename.endsWith(".markdownlint.cjs")) {
+    config = await (requireConfig(fs, dirname, basename, noRequire)());
+  }
+  return options || { config };
+};
+
+// Filter a list of files to ignore by glob
+const removeIgnoredFiles = (dir, files, ignores) => {
+  const micromatch = require("micromatch");
+  return micromatch(
+    files.map((file) => path.posix.relative(dir, file)),
+    ignores
+  ).map((file) => path.posix.join(dir, file));
 };
 
-// Process command-line arguments and return glob patterns
+// Process/normalize command-line arguments and return glob patterns
 const processArgv = (argv) => {
-  const globPatterns = argv.map(
-    (glob) => glob.replace(/^#/u, "!").replace(/\\(?![$()*+?[\]^])/gu, "/")
+  const globPatterns = (argv || []).map(
+    (glob) => {
+      if (glob.startsWith(":")) {
+        return glob;
+      }
+      // Escape RegExp special characters recognized by fast-glob
+      // https://github.com/mrmlnc/fast-glob#advanced-syntax
+      const specialCharacters = /\\(?![$()*+?[\]^])/gu;
+      if (glob.startsWith("\\:")) {
+        return `\\:${glob.slice(2).replace(specialCharacters, "/")}`;
+      }
+      return (glob.startsWith("#") ? `!${glob.slice(1)}` : glob).
+        replace(specialCharacters, "/");
+    }
   );
   if ((globPatterns.length === 1) && (globPatterns[0] === ".")) {
     // Substitute a more reasonable pattern
@@ -105,31 +165,33 @@ const processArgv = (argv) => {
 
 // Show help if missing arguments
 const showHelp = (logMessage) => {
-  const { name, homepage } = require("./package.json");
   /* eslint-disable max-len */
-  logMessage(`${homepage}
+  logMessage(`https://github.com/DavidAnson/markdownlint-cli2
 
-Syntax: ${name} glob0 [glob1] [...] [globN]
+Syntax: markdownlint-cli2 glob0 [glob1] [...] [globN]
+        markdownlint-cli2-fix glob0 [glob1] [...] [globN]
+        markdownlint-cli2-config config-file glob0 [glob1] [...] [globN]
 
 Glob expressions (from the globby library):
 - * matches any number of characters, but not /
 - ? matches a single character, but not /
-- ** matches any number of characters, including / (when it's the only thing in a path part)
+- ** matches any number of characters, including /
 - {} allows for a comma-separated list of "or" expressions
 - ! or # at the beginning of a pattern negate the match
+- : at the beginning identifies a literal file path
 
 Dot-only glob:
-- The command "${name} ." would lint every file in the current directory tree which is probably not intended
-- Instead, it is mapped to "${name} ${dotOnlySubstitute}" which lints all Markdown files in the current directory
-- To lint every file in the current directory tree, the command "${name} **" can be used instead
+- The command "markdownlint-cli2 ." would lint every file in the current directory tree which is probably not intended
+- Instead, it is mapped to "markdownlint-cli2 ${dotOnlySubstitute}" which lints all Markdown files in the current directory
+- To lint every file in the current directory tree, the command "markdownlint-cli2 **" can be used instead
 
 Configuration via:
 - .markdownlint-cli2.jsonc
 - .markdownlint-cli2.yaml
-- .markdownlint-cli2.js
+- .markdownlint-cli2.cjs
 - .markdownlint.jsonc or .markdownlint.json
 - .markdownlint.yaml or .markdownlint.yml
-- .markdownlint.js
+- .markdownlint.cjs
 
 Cross-platform compatibility:
 - UNIX and Windows shells expand globs according to different rules; quoting arguments is recommended
@@ -138,14 +200,15 @@ Cross-platform compatibility:
 - Some UNIX shells parse exclamation (!) in double-quotes; hashtag (#) is recommended in these cases
 - The path separator is forward slash (/) on all platforms; backslash (\\) is automatically converted
 
-Therefore, the most compatible glob syntax for cross-platform support:
-$ ${name} "**/*.md" "#node_modules"`
+The most compatible syntax for cross-platform support:
+$ markdownlint-cli2 "**/*.md" "#node_modules"`
   );
   /* eslint-enable max-len */
 };
 
 // Get (creating if necessary) and process a directory's info object
-const getAndProcessDirInfo = (tasks, dirToDirInfo, dir, noRequire, func) => {
+const getAndProcessDirInfo =
+(fs, tasks, dirToDirInfo, dir, noRequire, func) => {
   let dirInfo = dirToDirInfo[dir];
   if (!dirInfo) {
     dirInfo = {
@@ -163,15 +226,23 @@ const getAndProcessDirInfo = (tasks, dirToDirInfo, dir, noRequire, func) => {
     const markdownlintCli2Yaml =
       path.posix.join(dir, ".markdownlint-cli2.yaml");
     tasks.push(
-      fs.access(markdownlintCli2Jsonc).
+      fs.promises.access(markdownlintCli2Jsonc).
         then(
-          () => fs.readFile(markdownlintCli2Jsonc, utf8).then(jsoncParse),
-          () => fs.access(markdownlintCli2Yaml).
+          () => fs.promises.
+            readFile(markdownlintCli2Jsonc, utf8).
+            then(
+              (content) => getJsoncParse().
+                then((jsoncParse) => jsoncParse(content))
+            ),
+          () => fs.promises.access(markdownlintCli2Yaml).
             then(
-              () => fs.readFile(markdownlintCli2Yaml, utf8).then(yamlParse),
+              () => fs.promises.
+                readFile(markdownlintCli2Yaml, utf8).
+                then(yamlParse),
               requireConfig(
+                fs,
                 dir,
-                ".markdownlint-cli2.js",
+                ".markdownlint-cli2.cjs",
                 noRequire
               )
             )
@@ -184,20 +255,25 @@ const getAndProcessDirInfo = (tasks, dirToDirInfo, dir, noRequire, func) => {
     // Load markdownlint object(s)
     const readConfigs =
       readConfig(
+        fs,
         dir,
         ".markdownlint.jsonc",
         readConfig(
+          fs,
           dir,
           ".markdownlint.json",
           readConfig(
+            fs,
             dir,
             ".markdownlint.yaml",
             readConfig(
+              fs,
               dir,
               ".markdownlint.yml",
               requireConfig(
+                fs,
                 dir,
-                ".markdownlint.js",
+                ".markdownlint.cjs",
                 noRequire
               )
             )
@@ -218,11 +294,18 @@ const getAndProcessDirInfo = (tasks, dirToDirInfo, dir, noRequire, func) => {
 };
 
 // Get base markdownlint-cli2 options object
-const getBaseOptions =
-async (baseDir, globPatterns, optionsDefault, fixDefault, noRequire) => {
+const getBaseOptions = async (
+  fs,
+  baseDir,
+  globPatterns,
+  optionsDefault,
+  fixDefault,
+  noGlobs,
+  noRequire
+) => {
   const tasks = [];
   const dirToDirInfo = {};
-  getAndProcessDirInfo(tasks, dirToDirInfo, baseDir, noRequire);
+  getAndProcessDirInfo(fs, tasks, dirToDirInfo, baseDir, noRequire);
   await Promise.all(tasks);
   // eslint-disable-next-line no-multi-assign
   const baseMarkdownlintOptions = dirToDirInfo[baseDir].markdownlintOptions =
@@ -231,16 +314,17 @@ async (baseDir, globPatterns, optionsDefault, fixDefault, noRequire) => {
       dirToDirInfo[baseDir].markdownlintOptions
     );
 
-  // Append any globs specified in markdownlint-cli2 configuration
-  const globs = baseMarkdownlintOptions.globs || [];
-  appendToArray(globPatterns, globs);
+  if (!noGlobs) {
+    // Append any globs specified in markdownlint-cli2 configuration
+    const globs = baseMarkdownlintOptions.globs || [];
+    appendToArray(globPatterns, globs);
+  }
 
   // Pass base ignore globs as globby patterns (best performance)
   const ignorePatterns =
     // eslint-disable-next-line unicorn/no-array-callback-reference
     (baseMarkdownlintOptions.ignores || []).map(negateGlob);
   appendToArray(globPatterns, ignorePatterns);
-  delete baseMarkdownlintOptions.ignores;
 
   return {
     baseMarkdownlintOptions,
@@ -250,24 +334,83 @@ async (baseDir, globPatterns, optionsDefault, fixDefault, noRequire) => {
 
 // Enumerate files from globs and build directory infos
 const enumerateFiles =
-async (baseDir, globPatterns, dirToDirInfo, noRequire) => {
+// eslint-disable-next-line max-len
+async (fs, baseDirSystem, baseDir, globPatterns, dirToDirInfo, noErrors, noRequire) => {
   const tasks = [];
   const globbyOptions = {
     "absolute": true,
-    "cwd": baseDir
+    "cwd": baseDir,
+    "expandDirectories": false,
+    fs
   };
-  for await (const file of globby.stream(globPatterns, globbyOptions)) {
-    // @ts-ignore
+  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(tasks, dirToDirInfo, dir, noRequire, (dirInfo) => {
-      dirInfo.files.push(file);
-    });
+    getAndProcessDirInfo(
+      fs,
+      tasks,
+      dirToDirInfo,
+      dir,
+      noRequire,
+      (dirInfo) => {
+        dirInfo.files.push(file);
+      }
+    );
   }
   await Promise.all(tasks);
 };
 
 // Enumerate (possibly missing) parent directories and update directory infos
-const enumerateParents = async (baseDir, dirToDirInfo, noRequire) => {
+const enumerateParents = async (fs, baseDir, dirToDirInfo, noRequire) => {
   const tasks = [];
 
   // Create a lookup of baseDir and parents
@@ -289,10 +432,17 @@ const enumerateParents = async (baseDir, dirToDirInfo, noRequire) => {
     ) {
       lastDir = dir;
       lastDirInfo =
-        // eslint-disable-next-line no-loop-func
-        getAndProcessDirInfo(tasks, dirToDirInfo, dir, noRequire, (dirInfo) => {
-          lastDirInfo.parent = dirInfo;
-        });
+        getAndProcessDirInfo(
+          fs,
+          tasks,
+          dirToDirInfo,
+          dir,
+          noRequire,
+          // eslint-disable-next-line no-loop-func
+          (dirInfo) => {
+            lastDirInfo.parent = dirInfo;
+          }
+        );
     }
 
     // If dir not under baseDir, inject it as parent for configuration
@@ -305,9 +455,23 @@ const enumerateParents = async (baseDir, dirToDirInfo, noRequire) => {
 
 // Create directory info objects by enumerating file globs
 const createDirInfos =
-async (baseDir, globPatterns, dirToDirInfo, optionsOverride, noRequire) => {
-  await enumerateFiles(baseDir, globPatterns, dirToDirInfo, noRequire);
-  await enumerateParents(baseDir, dirToDirInfo, noRequire);
+// 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);
@@ -414,34 +578,34 @@ async (baseDir, globPatterns, dirToDirInfo, optionsOverride, noRequire) => {
 };
 
 // Lint files in groups by shared configuration
-const lintFiles = (dirInfos, fileContents) => {
+const lintFiles = (fs, dirInfos, fileContents) => {
   const tasks = [];
   // For each dirInfo
   for (const dirInfo of dirInfos) {
     const { dir, files, markdownlintConfig, markdownlintOptions } = dirInfo;
     // Filter file/string inputs to only those in the dirInfo
-    const filteredFileContents = {};
-    for (const file in fileContents) {
-      if (files.includes(file)) {
-        filteredFileContents[file] = fileContents[file];
-      }
+    let filesAfterIgnores = files;
+    if (
+      markdownlintOptions.ignores &&
+      (markdownlintOptions.ignores.length > 0)
+    ) {
+      // eslint-disable-next-line unicorn/no-array-callback-reference
+      const ignores = markdownlintOptions.ignores.map(negateGlob);
+      filesAfterIgnores = removeIgnoredFiles(dir, files, ignores);
     }
-    let filteredFiles = files.filter(
+    const filteredFiles = filesAfterIgnores.filter(
       (file) => fileContents[file] === undefined
     );
-    if (markdownlintOptions.ignores) {
-      // eslint-disable-next-line unicorn/no-array-callback-reference
-      const ignores = markdownlintOptions.ignores.map(negateGlob);
-      const micromatch = require("micromatch");
-      filteredFiles = micromatch(
-        files.map((file) => path.posix.relative(dir, file)),
-        ignores
-      ).map((file) => path.posix.join(dir, file));
+    const filteredStrings = {};
+    for (const file of filesAfterIgnores) {
+      if (fileContents[file] !== undefined) {
+        filteredStrings[file] = fileContents[file];
+      }
     }
     // Create markdownlint options object
     const options = {
       "files": filteredFiles,
-      "strings": filteredFileContents,
+      "strings": filteredStrings,
       "config": markdownlintConfig || markdownlintOptions.config,
       "customRules": markdownlintOptions.customRules,
       "frontMatter": markdownlintOptions.frontMatter
@@ -450,7 +614,8 @@ const lintFiles = (dirInfos, fileContents) => {
       "handleRuleFailures": true,
       "markdownItPlugins": markdownlintOptions.markdownItPlugins,
       "noInlineConfig": Boolean(markdownlintOptions.noInlineConfig),
-      "resultVersion": 3
+      "resultVersion": 3,
+      fs
     };
     // Invoke markdownlint
     // @ts-ignore
@@ -467,11 +632,11 @@ const lintFiles = (dirInfos, fileContents) => {
           if (errorInfos.length > 0) {
             delete results[fileName];
             options.files.push(fileName);
-            subTasks.push(fs.readFile(fileName, utf8).
+            subTasks.push(fs.promises.readFile(fileName, utf8).
               then((original) => {
                 const fixed = markdownlintRuleHelpers.
                   applyFixes(original, errorInfos);
-                return fs.writeFile(fileName, fixed, utf8);
+                return fs.promises.writeFile(fileName, fixed, utf8);
               })
             );
           }
@@ -555,26 +720,40 @@ const main = async (params) => {
     fixDefault,
     fileContents,
     nonFileContents,
-    noRequire
+    noErrors,
+    noGlobs,
+    noRequire,
+    name
   } = params;
   const logMessage = params.logMessage || noop;
   const logError = params.logError || noop;
+  const fs = params.fs || require("fs");
   const baseDirSystem =
     (directory && path.resolve(directory)) ||
     process.cwd();
   const baseDir = posixPath(baseDirSystem);
   // Output banner
   logMessage(
-    `${packageName} v${packageVersion} (${libraryName} v${libraryVersion})`
+    // eslint-disable-next-line max-len
+    `${name || packageName} v${packageVersion} (${libraryName} v${libraryVersion})`
   );
+  // Read argv configuration file (if relevant and present)
+  let optionsArgv = null;
+  const [ configPath ] = (argv || []);
+  if ((name === "markdownlint-cli2-config") && configPath) {
+    optionsArgv =
+      await readOptionsOrConfig(configPath, fs, noRequire);
+  }
   // Process arguments and get base options
-  const globPatterns = processArgv(argv);
+  const globPatterns = processArgv(optionsArgv ? argv.slice(1) : argv);
   const { baseMarkdownlintOptions, dirToDirInfo } =
     await getBaseOptions(
+      fs,
       baseDir,
       globPatterns,
-      optionsDefault,
+      optionsArgv || optionsDefault,
       fixDefault,
+      noGlobs,
       noRequire
     );
   if ((globPatterns.length === 0) && !nonFileContents) {
@@ -603,10 +782,13 @@ const main = async (params) => {
   // Create linting tasks
   const dirInfos =
     await createDirInfos(
+      fs,
+      baseDirSystem,
       baseDir,
       globPatterns,
       dirToDirInfo,
       optionsOverride,
+      noErrors,
       noRequire
     );
   // Output linting status
@@ -618,7 +800,7 @@ const main = async (params) => {
     logMessage(`Linting: ${fileCount} file(s)`);
   }
   // Lint files
-  const lintResults = await lintFiles(dirInfos, resolvedFileContents);
+  const lintResults = await lintFiles(fs, dirInfos, resolvedFileContents);
   // Output summary
   const summary = createSummary(baseDir, lintResults);
   if (showProgress) {

package/package.json

@@ -1,15 +1,17 @@
 {
   "name": "markdownlint-cli2",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the `markdownlint` library",
   "author": {
     "name": "David Anson",
     "url": "https://dlaa.me/"
   },
   "license": "MIT",
+  "type": "commonjs",
   "main": "markdownlint-cli2.js",
   "bin": {
     "markdownlint-cli2": "markdownlint-cli2.js",
+    "markdownlint-cli2-config": "markdownlint-cli2-config.js",
     "markdownlint-cli2-fix": "markdownlint-cli2-fix.js"
   },
   "homepage": "https://github.com/DavidAnson/markdownlint-cli2",
@@ -19,12 +21,21 @@
   },
   "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 .",
     "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",
-    "test": "ava test/append-to-array-test.js test/markdownlint-cli2-test.js test/markdownlint-cli2-test-exec.js test/markdownlint-cli2-test-main.js test/merge-options-test.js test/resolve-and-require-test.js",
+    "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 .",
+    "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-cover": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 npm test",
-    "test-watch": "git ls-files | entr npm run 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"
   },
   "engines": {
     "node": ">=12"
@@ -32,37 +43,39 @@
   "files": [
     "append-to-array.js",
     "markdownlint-cli2.js",
+    "markdownlint-cli2-config.js",
     "markdownlint-cli2-fix.js",
     "merge-options.js",
     "resolve-and-require.js"
   ],
   "dependencies": {
-    "globby": "~11.0.4",
-    "markdownlint": "~0.23.1",
-    "markdownlint-cli2-formatter-default": "^0.0.2",
-    "markdownlint-rule-helpers": "~0.14.0",
-    "micromatch": "~4.0.4",
-    "strip-json-comments": "~3.1.1",
-    "yaml": "~1.10.2"
+    "globby": "12.1.0",
+    "markdownlint": "0.25.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"
   },
   "devDependencies": {
-    "@iktakahiro/markdown-it-katex": "~4.0.1",
-    "ava": "~3.15.0",
-    "c8": "~7.7.3",
-    "cpy": "~8.1.2",
-    "del": "~6.0.0",
-    "eslint": "~7.31.0",
-    "eslint-plugin-node": "~11.1.0",
-    "eslint-plugin-unicorn": "~34.0.1",
-    "execa": "~5.1.1",
-    "markdown-it-emoji": "~2.0.0",
-    "markdown-it-for-inline": "~0.1.1",
-    "markdownlint-cli2-formatter-json": "^0.0.4",
-    "markdownlint-cli2-formatter-junit": "^0.0.3",
-    "markdownlint-cli2-formatter-pretty": "^0.0.2",
-    "markdownlint-cli2-formatter-summarize": "^0.0.3",
-    "markdownlint-rule-titlecase": "~0.1.0",
-    "npm-run-all": "~4.1.5"
+    "@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",
+    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-unicorn": "40.0.0",
+    "execa": "6.0.0",
+    "markdown-it-emoji": "2.0.0",
+    "markdown-it-for-inline": "0.1.1",
+    "markdownlint-cli2-formatter-json": "0.0.5",
+    "markdownlint-cli2-formatter-junit": "0.0.4",
+    "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"
   },
   "keywords": [
     "markdown",

package/resolve-and-require.js

@@ -4,10 +4,9 @@
 
 /**
  * Wrapper for calling Node's require.resolve/require with an additional path.
- *
- * @param {Object} req Node's require function (or equivalent).
- * @param {*} id Package identifier to require.
- * @param {*} dir Directory to include when resolving paths.
+ * @param {Object} req Node's require implementation (or equivalent).
+ * @param {String} id Package identifier to require.
+ * @param {String} dir Directory to include when resolving paths.
  * @returns {Object} Exported module content.
  */
 const resolveAndRequire = (req, id, dir) => {