markdownlint-cli2 0.3.2 → 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

@@ -51,13 +51,16 @@ 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
@@ -67,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
@@ -79,31 +82,41 @@ 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
 
@@ -111,7 +124,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.3.2 "**/*.md" "#node_modules"
+docker run -v $PWD:/workdir davidanson/markdownlint-cli2:0.4.0 "**/*.md" "#node_modules"
 ```
 
 Notes:
@@ -123,19 +136,19 @@ Notes:
   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]
+  *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.3.2 "**/*.md" "#node_modules"
+    docker run -w /myfolder -v $PWD:/myfolder davidanson/markdownlint-cli2:0.4.0 "**/*.md" "#node_modules"
     ```
 
-To invoke the `markdownlint-cli2-fix` command instead, specify it via Docker's
-`--entrypoint` flag:
+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.3.2 "**/*.md" "#node_modules"
+docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/markdownlint-cli2:0.4.0 "**/*.md" "#node_modules"
 ```
 
 ### Exit Codes
@@ -245,7 +258,7 @@ 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.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`.
@@ -255,7 +268,7 @@ docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/mark
 - 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`
 
@@ -282,14 +295,14 @@ docker run -v $PWD:/workdir --entrypoint="markdownlint-cli2-fix" davidanson/mark
   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
 
@@ -313,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.3.2
+  rev: v0.4.0
   hooks:
   - id: markdownlint-cli2
 ```
@@ -345,6 +358,7 @@ reference to the `repos` list in that project's `.pre-commit-config.yaml` like:
 - 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 -->
 
@@ -374,10 +388,10 @@ 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

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

@@ -11,7 +11,6 @@ const dynamicRequire = (typeof __non_webpack_require__ === "undefined") ? requir
 
 // Requires
 const path = require("path");
-const globby = require("globby");
 const markdownlintLibrary = require("markdownlint");
 const { markdownlint, "readConfig": markdownlintReadConfig } =
   markdownlintLibrary.promises;
@@ -22,7 +21,7 @@ const resolveAndRequire = require("./resolve-and-require");
 
 // Variables
 const packageName = "markdownlint-cli2";
-const packageVersion = "0.3.2";
+const packageVersion = "0.4.0";
 const libraryName = "markdownlint";
 const libraryVersion = markdownlintLibrary.getVersion();
 const dotOnlySubstitute = "*.{md,markdown}";
@@ -31,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
@@ -48,8 +53,13 @@ const readConfig = (fs, dir, name, otherwise) => {
   const file = path.posix.join(dir, name);
   return () => fs.promises.access(file).
     then(
-      // @ts-ignore
-      () => markdownlintReadConfig(file, [ jsoncParse, yamlParse ], fs),
+      () => getJsoncParse().then(
+        (jsoncParse) => markdownlintReadConfig(
+          file,
+          [ jsoncParse, yamlParse ],
+          fs
+        )
+      ),
       otherwise
     );
 };
@@ -92,10 +102,59 @@ const requireConfig = (fs, dir, name, noRequire) => (
     )
 );
 
-// Process command-line arguments and return glob patterns
+// 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/normalize command-line arguments and return glob patterns
 const processArgv = (argv) => {
   const globPatterns = (argv || []).map(
-    (glob) => glob.replace(/^#/u, "!").replace(/\\(?![$()*+?[\]^])/gu, "/")
+    (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
@@ -106,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
@@ -139,8 +200,8 @@ 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 */
 };
@@ -169,7 +230,10 @@ const getAndProcessDirInfo =
         then(
           () => fs.promises.
             readFile(markdownlintCli2Jsonc, utf8).
-            then(jsoncParse),
+            then(
+              (content) => getJsoncParse().
+                then((jsoncParse) => jsoncParse(content))
+            ),
           () => fs.promises.access(markdownlintCli2Yaml).
             then(
               () => fs.promises.
@@ -178,7 +242,7 @@ const getAndProcessDirInfo =
               requireConfig(
                 fs,
                 dir,
-                ".markdownlint-cli2.js",
+                ".markdownlint-cli2.cjs",
                 noRequire
               )
             )
@@ -209,7 +273,7 @@ const getAndProcessDirInfo =
               requireConfig(
                 fs,
                 dir,
-                ".markdownlint.js",
+                ".markdownlint.cjs",
                 noRequire
               )
             )
@@ -270,7 +334,8 @@ const getBaseOptions = async (
 
 // Enumerate files from globs and build directory infos
 const enumerateFiles =
-async (fs, baseDir, globPatterns, dirToDirInfo, noErrors, noRequire) => {
+// eslint-disable-next-line max-len
+async (fs, baseDirSystem, baseDir, globPatterns, dirToDirInfo, noErrors, noRequire) => {
   const tasks = [];
   const globbyOptions = {
     "absolute": true,
@@ -281,13 +346,38 @@ async (fs, baseDir, globPatterns, dirToDirInfo, noErrors, noRequire) => {
   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(
-    globPatterns.map((globPattern) => {
-      const globPath = path.posix.join(
-        baseDir,
-        globPattern[0] === "!" ? globPattern.slice(1) : globPattern
-      );
+    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, "**")
@@ -296,7 +386,13 @@ async (fs, baseDir, globPatterns, dirToDirInfo, noErrors, noRequire) => {
     })
   );
   // Process glob patterns
-  const files = await globby(expandedDirectories, globbyOptions);
+  // 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(
@@ -360,9 +456,10 @@ 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, baseDir, globPatterns, dirToDirInfo, optionsOverride, noErrors, noRequire) => {
+async (fs, baseDirSystem, baseDir, globPatterns, dirToDirInfo, optionsOverride, noErrors, noRequire) => {
   await enumerateFiles(
     fs,
+    baseDirSystem,
     baseDir,
     globPatterns,
     dirToDirInfo,
@@ -494,11 +591,7 @@ const lintFiles = (fs, dirInfos, fileContents) => {
     ) {
       // eslint-disable-next-line unicorn/no-array-callback-reference
       const ignores = markdownlintOptions.ignores.map(negateGlob);
-      const micromatch = require("micromatch");
-      filesAfterIgnores = micromatch(
-        files.map((file) => path.posix.relative(dir, file)),
-        ignores
-      ).map((file) => path.posix.join(dir, file));
+      filesAfterIgnores = removeIgnoredFiles(dir, files, ignores);
     }
     const filteredFiles = filesAfterIgnores.filter(
       (file) => fileContents[file] === undefined
@@ -629,7 +722,8 @@ const main = async (params) => {
     nonFileContents,
     noErrors,
     noGlobs,
-    noRequire
+    noRequire,
+    name
   } = params;
   const logMessage = params.logMessage || noop;
   const logError = params.logError || noop;
@@ -640,16 +734,24 @@ const main = async (params) => {
   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
@@ -681,6 +783,7 @@ const main = async (params) => {
   const dirInfos =
     await createDirInfos(
       fs,
+      baseDirSystem,
       baseDir,
       globPatterns,
       dirToDirInfo,

package/package.json

@@ -1,15 +1,17 @@
 {
   "name": "markdownlint-cli2",
-  "version": "0.3.2",
+  "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",
@@ -21,15 +23,19 @@
   "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",
     "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 test/append-to-array-test.js test/fs-mock-test.js test/markdownlint-cli2-test.js test/markdownlint-cli2-test-exec.js test/markdownlint-cli2-test-fs.js test/markdownlint-cli2-test-main.js test/merge-options-test.js test/resolve-and-require-test.js",
+    "test": "ava --timeout=1m test/append-to-array-test.js test/fs-mock-test.js test/markdownlint-cli2-test.js test/markdownlint-cli2-test-exec.js test/markdownlint-cli2-test-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"
@@ -37,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.24.0",
-    "markdownlint-cli2-formatter-default": "^0.0.2",
-    "markdownlint-rule-helpers": "~0.15.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.8.0",
-    "cpy": "~8.1.2",
-    "del": "~6.0.0",
-    "eslint": "~7.32.0",
-    "eslint-plugin-node": "~11.1.0",
-    "eslint-plugin-unicorn": "~35.0.0",
-    "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) => {