markdownlint-cli2 0.16.0 → 0.17.0

package/{markdownlint-cli2.js → markdownlint-cli2.mjs}

@@ -1,38 +1,30 @@
-#!/usr/bin/env node
-
-// @ts-check
-
-"use strict";
-
 // @ts-ignore
-// eslint-disable-next-line camelcase, no-inline-comments, no-undef
-const dynamicRequire = (typeof __non_webpack_require__ === "undefined") ? require : /* c8 ignore next */ __non_webpack_require__;
-// Capture native require implementation for dynamic loading of modules
 
-// Requires
-const pathDefault = require("node:path");
+// Imports
+import fsNode from "node:fs";
+import { createRequire } from "node:module";
+const dynamicRequire = createRequire(import.meta.url);
+import os from "node:os";
+import pathDefault from "node:path";
 const pathPosix = pathDefault.posix;
-const { pathToFileURL } = require("node:url");
-const markdownlintLibrary = require("markdownlint");
-const {
-  applyFixes,
-  "getVersion": getLibraryVersion,
-  "promises": markdownlintPromises
-} = markdownlintLibrary;
-const {
-  markdownlint,
-  "extendConfig": markdownlintExtendConfig,
-  "readConfig": markdownlintReadConfig
-} = markdownlintPromises;
-const appendToArray = require("./append-to-array");
-const mergeOptions = require("./merge-options");
-const resolveAndRequire = require("./resolve-and-require");
+import { pathToFileURL } from "node:url";
+import { globby } from "globby";
+import micromatch from "micromatch";
+import { applyFixes, getVersion } from "markdownlint";
+import { lint, extendConfig, readConfig } from "markdownlint/promise";
+import { expandTildePath } from "markdownlint/helpers";
+import appendToArray from "./append-to-array.mjs";
+import mergeOptions from "./merge-options.mjs";
+import resolveModule from "./resolve-module.mjs";
+import parsers from "./parsers/parsers.mjs";
+import jsoncParse from "./parsers/jsonc-parse.mjs";
+import yamlParse from "./parsers/yaml-parse.mjs";
 
 // Variables
 const packageName = "markdownlint-cli2";
-const packageVersion = "0.16.0";
+const packageVersion = "0.17.0";
 const libraryName = "markdownlint";
-const libraryVersion = getLibraryVersion();
+const libraryVersion = getVersion();
 const bannerMessage = `${packageName} v${packageVersion} (${libraryName} v${libraryVersion})`;
 const dotOnlySubstitute = "*.{md,markdown}";
 const utf8 = "utf8";
@@ -40,15 +32,6 @@ const utf8 = "utf8";
 // No-op function
 const noop = () => null;
 
-// Gets a JSONC parser
-const getJsoncParse = () => require("./parsers/jsonc-parse.js");
-
-// Gets a YAML parser
-const getYamlParse = () => require("./parsers/yaml-parse.js");
-
-// Gets an ordered array of parsers
-const getParsers = () => require("./parsers/parsers.js");
-
 // Negates a glob
 const negateGlob = (glob) => `!${glob}`;
 
@@ -63,98 +46,84 @@ const throwForConfigurationFile = (file, error) => {
 // Return a posix path (even on Windows)
 const posixPath = (p) => p.split(pathDefault.sep).join(pathPosix.sep);
 
-// Expands a path with a tilde to an absolute path
-const expandTildePath = (id) => {
-  const markdownlintRuleHelpers = require("markdownlint/helpers");
-  return markdownlintRuleHelpers.expandTildePath(id, require("node:os"));
-};
-
 // Resolves module paths relative to the specified directory
 const resolveModulePaths = (dir, modulePaths) => (
-  modulePaths.map((path) => pathDefault.resolve(dir, expandTildePath(path)))
+  modulePaths.map((path) => pathDefault.resolve(dir, expandTildePath(path, os)))
 );
 
 // Read a JSON(C) or YAML file and return the object
-const readConfig = (fs, dir, name, otherwise) => () => {
+const readConfigFile = (fs, dir, name, otherwise) => () => {
   const file = pathPosix.join(dir, name);
   return fs.promises.access(file).
     then(
-      () => markdownlintReadConfig(
+      () => readConfig(
         file,
-        getParsers(),
+        parsers,
         fs
       ),
       otherwise
     );
 };
 
-// Import or resolve/require a module ID with a custom directory in the path
-const importOrRequireResolve = async (dirOrDirs, id, noRequire) => {
-  if (typeof id === "string") {
-    if (noRequire) {
-      return null;
-    }
-    const dirs = Array.isArray(dirOrDirs) ? dirOrDirs : [ dirOrDirs ];
-    const expandId = expandTildePath(id);
-    const errors = [];
-    // Try to load via require(...)
-    try {
-      const isModule = /\.mjs$/iu.test(expandId);
-      if (!isModule) {
-        // Try not to use require for modules due to breaking change in Node 22.12:
-        // https://github.com/nodejs/node/releases/tag/v22.12.0
-        return resolveAndRequire(dynamicRequire, expandId, dirs);
-      }
-    } catch (error) {
-      errors.push(error);
-    }
-    // Try to load via import(...)
+// Import a module ID with a custom directory in the path
+const importModule = async (dirOrDirs, id, noImport) => {
+  if (typeof id !== "string") {
+    return id;
+  } else if (noImport) {
+    return null;
+  }
+  const dirs = Array.isArray(dirOrDirs) ? dirOrDirs : [ dirOrDirs ];
+  const expandId = expandTildePath(id, os);
+  const errors = [];
+  let moduleName = null;
+  try {
     try {
-      // eslint-disable-next-line n/no-unsupported-features/node-builtins
-      const isURL = !pathDefault.isAbsolute(expandId) && URL.canParse(expandId);
-      const urlString = (
-        isURL ? new URL(expandId) : pathToFileURL(pathDefault.resolve(dirs[0], expandId))
-      ).toString();
-      // eslint-disable-next-line no-inline-comments
-      const module = await import(/* webpackIgnore: true */ urlString);
-      return module.default;
+      moduleName = pathToFileURL(resolveModule(dynamicRequire, expandId, dirs));
     } catch (error) {
       errors.push(error);
+      moduleName =
+        // eslint-disable-next-line n/no-unsupported-features/node-builtins
+        (!pathDefault.isAbsolute(expandId) && URL.canParse(expandId))
+          ? new URL(expandId)
+          : pathToFileURL(pathDefault.resolve(dirs[0], expandId));
     }
-    // Give up
+    // eslint-disable-next-line no-inline-comments
+    const module = await import(/* webpackIgnore: true */ moduleName);
+    return module.default;
+  } catch (error) {
+    errors.push(error);
     throw new AggregateError(
       errors,
-      `Unable to require or import module '${id}'.`
+      `Unable to import module '${id}'.`
     );
   }
-  return id;
 };
 
-// Import or require an array of modules by ID
-const importOrRequireIds = (dirs, ids, noRequire) => (
+// Import an array of modules by ID
+const importModuleIds = (dirs, ids, noImport) => (
   Promise.all(
     ids.map(
-      (id) => importOrRequireResolve(dirs, id, noRequire)
+      (id) => importModule(dirs, id, noImport)
     )
   ).then((results) => results.filter(Boolean))
 );
 
-// Import or require an array of modules by ID (preserving parameters)
-const importOrRequireIdsAndParams = (dirs, idsAndParams, noRequire) => (
+// Import an array of modules by ID (preserving parameters)
+const importModuleIdsAndParams = (dirs, idsAndParams, noImport) => (
   Promise.all(
     idsAndParams.map(
-      (idAndParams) => importOrRequireResolve(dirs, idAndParams[0], noRequire).
+      (idAndParams) => importModule(dirs, idAndParams[0], noImport).
         then((module) => module && [ module, ...idAndParams.slice(1) ])
     )
   ).then((results) => results.filter(Boolean))
 );
 
-// Import or require a JavaScript file and return the exported object
-const importOrRequireConfig = (fs, dir, name, noRequire, otherwise) => () => {
+// Import a JavaScript file and return the exported object
+const importConfig = (fs, dir, name, noImport, otherwise) => () => {
   const file = pathPosix.join(dir, name);
   return fs.promises.access(file).
     then(
-      () => importOrRequireResolve(dir, name, noRequire),
+      () => importModule(dir, name, noImport),
       otherwise
     );
 };
@@ -162,10 +131,10 @@ const importOrRequireConfig = (fs, dir, name, noRequire, otherwise) => () => {
 // Extend a config object if it has 'extends' property
 const getExtendedConfig = (config, configPath, fs) => {
   if (config.extends) {
-    return markdownlintExtendConfig(
+    return extendConfig(
       config,
       configPath,
-      getParsers(),
+      parsers,
       fs
     );
   }
@@ -174,37 +143,38 @@ const getExtendedConfig = (config, configPath, fs) => {
 };
 
 // Read an options or config file in any format and return the object
-const readOptionsOrConfig = async (configPath, fs, noRequire) => {
+const readOptionsOrConfig = async (configPath, fs, noImport) => {
   const basename = pathPosix.basename(configPath);
   const dirname = pathPosix.dirname(configPath);
   let options = null;
   let config = null;
   try {
     if (basename.endsWith(".markdownlint-cli2.jsonc")) {
-      options = getJsoncParse()(await fs.promises.readFile(configPath, utf8));
+      options = jsoncParse(await fs.promises.readFile(configPath, utf8));
     } else if (basename.endsWith(".markdownlint-cli2.yaml")) {
-      options = getYamlParse()(await fs.promises.readFile(configPath, utf8));
+      options = yamlParse(await fs.promises.readFile(configPath, utf8));
     } else if (
       basename.endsWith(".markdownlint-cli2.cjs") ||
       basename.endsWith(".markdownlint-cli2.mjs")
     ) {
-      options = await importOrRequireResolve(dirname, basename, noRequire);
+      options = await importModule(dirname, basename, noImport);
     } else if (
       basename.endsWith(".markdownlint.jsonc") ||
       basename.endsWith(".markdownlint.json") ||
       basename.endsWith(".markdownlint.yaml") ||
       basename.endsWith(".markdownlint.yml")
     ) {
-      config = await markdownlintReadConfig(configPath, getParsers(), fs);
+      config = await readConfig(configPath, parsers, fs);
     } else if (
       basename.endsWith(".markdownlint.cjs") ||
       basename.endsWith(".markdownlint.mjs")
     ) {
-      config = await importOrRequireResolve(dirname, basename, noRequire);
+      config = await importModule(dirname, basename, noImport);
     } else {
       throw new Error(
-        "File name should be (or end with) one of the supported types " +
-        "(e.g., '.markdownlint.json' or 'example.markdownlint-cli2.jsonc')."
+        "Configuration file should be one of the supported names " +
+        "(e.g., '.markdownlint-cli2.jsonc') or a prefix with a supported name " +
+        "(e.g., 'example.markdownlint-cli2.jsonc')."
       );
     }
   } catch (error) {
@@ -221,13 +191,12 @@ const readOptionsOrConfig = async (configPath, fs, noRequire) => {
 };
 
 // Filter a list of files to ignore by glob
-const removeIgnoredFiles = (dir, files, ignores) => {
-  const micromatch = require("micromatch");
-  return micromatch(
+const removeIgnoredFiles = (dir, files, ignores) => (
+  micromatch(
     files.map((file) => pathPosix.relative(dir, file)),
     ignores
-  ).map((file) => pathPosix.join(dir, file));
-};
+  ).map((file) => pathPosix.join(dir, file))
+);
 
 // Process/normalize command-line arguments and return glob patterns
 const processArgv = (argv) => {
@@ -312,7 +281,7 @@ const getAndProcessDirInfo = (
   dirToDirInfo,
   dir,
   relativeDir,
-  noRequire,
+  noImport,
   allowPackageJson
 ) => {
   // Create dirInfo
@@ -340,16 +309,16 @@ const getAndProcessDirInfo = (
     tasks.push(
       fs.promises.access(captureFile(markdownlintCli2Jsonc)).
         then(
-          () => fs.promises.readFile(file, utf8).then(getJsoncParse()),
+          () => fs.promises.readFile(file, utf8).then(jsoncParse),
           () => fs.promises.access(captureFile(markdownlintCli2Yaml)).
             then(
-              () => fs.promises.readFile(file, utf8).then(getYamlParse()),
+              () => fs.promises.readFile(file, utf8).then(yamlParse),
               () => fs.promises.access(captureFile(markdownlintCli2Cjs)).
                 then(
-                  () => importOrRequireResolve(dir, file, noRequire),
+                  () => importModule(dir, file, noImport),
                   () => fs.promises.access(captureFile(markdownlintCli2Mjs)).
                     then(
-                      () => importOrRequireResolve(dir, file, noRequire),
+                      () => importModule(dir, file, noImport),
                       () => (allowPackageJson
                         ? fs.promises.access(captureFile(packageJson))
                         // eslint-disable-next-line prefer-promise-reject-errors
@@ -358,7 +327,7 @@ const getAndProcessDirInfo = (
                         then(
                           () => fs.promises.
                             readFile(file, utf8).
-                            then(getJsoncParse()).
+                            then(jsoncParse).
                             then((obj) => obj[packageName]),
                           noop
                         )
@@ -387,32 +356,32 @@ const getAndProcessDirInfo = (
 
     // Load markdownlint object(s)
     const readConfigs =
-      readConfig(
+      readConfigFile(
         fs,
         dir,
         ".markdownlint.jsonc",
-        readConfig(
+        readConfigFile(
           fs,
           dir,
           ".markdownlint.json",
-          readConfig(
+          readConfigFile(
             fs,
             dir,
             ".markdownlint.yaml",
-            readConfig(
+            readConfigFile(
               fs,
               dir,
               ".markdownlint.yml",
-              importOrRequireConfig(
+              importConfig(
                 fs,
                 dir,
                 ".markdownlint.cjs",
-                noRequire,
-                importOrRequireConfig(
+                noImport,
+                importConfig(
                   fs,
                   dir,
                   ".markdownlint.mjs",
-                  noRequire,
+                  noImport,
                   noop
                 )
               )
@@ -441,7 +410,7 @@ const getBaseOptions = async (
   options,
   fixDefault,
   noGlobs,
-  noRequire
+  noImport
 ) => {
   const tasks = [];
   const dirToDirInfo = {};
@@ -451,7 +420,7 @@ const getBaseOptions = async (
     dirToDirInfo,
     baseDir,
     relativeDir,
-    noRequire,
+    noImport,
     true
   );
   await Promise.all(tasks);
@@ -492,7 +461,7 @@ const enumerateFiles = async (
   dirToDirInfo,
   gitignore,
   ignoreFiles,
-  noRequire
+  noImport
 ) => {
   const tasks = [];
   /** @type {import("globby").Options} */
@@ -548,8 +517,6 @@ const enumerateFiles = async (
     })
   );
   // Process glob patterns
-  // eslint-disable-next-line no-inline-comments
-  const { globby } = await import(/* webpackMode: "eager" */ "globby");
   const files = [
     ...await globby(expandedDirectories, globbyOptions),
     ...filteredLiteralFiles
@@ -562,7 +529,7 @@ const enumerateFiles = async (
       dirToDirInfo,
       dir,
       null,
-      noRequire,
+      noImport,
       false
     );
     dirInfo.files.push(file);
@@ -575,7 +542,7 @@ const enumerateParents = async (
   fs,
   baseDir,
   dirToDirInfo,
-  noRequire
+  noImport
 ) => {
   const tasks = [];
 
@@ -604,7 +571,7 @@ const enumerateParents = async (
           dirToDirInfo,
           dir,
           null,
-          noRequire,
+          noImport,
           false
         );
       lastDirInfo.parent = dirInfo;
@@ -629,7 +596,7 @@ const createDirInfos = async (
   optionsOverride,
   gitignore,
   ignoreFiles,
-  noRequire
+  noImport
 ) => {
   await enumerateFiles(
     fs,
@@ -639,13 +606,13 @@ const createDirInfos = async (
     dirToDirInfo,
     gitignore,
     ignoreFiles,
-    noRequire
+    noImport
   );
   await enumerateParents(
     fs,
     baseDir,
     dirToDirInfo,
-    noRequire
+    noImport
   );
 
   // Merge file lists with identical configuration
@@ -676,10 +643,10 @@ const createDirInfos = async (
       );
       if (markdownlintOptions && markdownlintOptions.customRules) {
         tasks.push(
-          importOrRequireIds(
+          importModuleIds(
             [ effectiveDir, ...effectiveModulePaths ],
             markdownlintOptions.customRules,
-            noRequire
+            noImport
           ).then((customRules) => {
             // Expand nested arrays (for packages that export multiple rules)
             markdownlintOptions.customRules = customRules.flat();
@@ -688,10 +655,10 @@ const createDirInfos = async (
       }
       if (markdownlintOptions && markdownlintOptions.markdownItPlugins) {
         tasks.push(
-          importOrRequireIdsAndParams(
+          importModuleIdsAndParams(
             [ effectiveDir, ...effectiveModulePaths ],
             markdownlintOptions.markdownItPlugins,
-            noRequire
+            noImport
           ).then((markdownItPlugins) => {
             markdownlintOptions.markdownItPlugins = markdownItPlugins;
           })
@@ -797,7 +764,7 @@ const lintFiles = (fs, dirInfos, fileContents) => {
       "files": filteredFiles,
       "strings": filteredStrings,
       "config": markdownlintConfig || markdownlintOptions.config,
-      "configParsers": getParsers(),
+      "configParsers": parsers,
       "customRules": markdownlintOptions.customRules,
       "frontMatter": markdownlintOptions.frontMatter
         ? new RegExp(markdownlintOptions.frontMatter, "u")
@@ -805,11 +772,10 @@ const lintFiles = (fs, dirInfos, fileContents) => {
       "handleRuleFailures": true,
       "markdownItPlugins": markdownlintOptions.markdownItPlugins,
       "noInlineConfig": Boolean(markdownlintOptions.noInlineConfig),
-      "resultVersion": 3,
       fs
     };
     // Invoke markdownlint
-    let task = markdownlint(options);
+    let task = lint(options);
     // For any fixable errors, read file, apply fixes, and write it back
     if (markdownlintOptions.fix) {
       task = task.then((results) => {
@@ -832,7 +798,7 @@ const lintFiles = (fs, dirInfos, fileContents) => {
           }
         }
         return Promise.all(subTasks).
-          then(() => markdownlint(options)).
+          then(() => lint(options)).
           then((fixResults) => ({
             ...results,
             ...fixResults
@@ -885,7 +851,7 @@ const outputSummary = async (
   modulePaths,
   logMessage,
   logError,
-  noRequire
+  noImport
 ) => {
   const errorsPresent = (summary.length > 0);
   if (errorsPresent || outputFormatters) {
@@ -898,8 +864,9 @@ const outputSummary = async (
     const dir = relativeDir || baseDir;
     const dirs = [ dir, ...modulePaths ];
     const formattersAndParams = outputFormatters
-      ? await importOrRequireIdsAndParams(dirs, outputFormatters, noRequire)
-      : [ [ require("markdownlint-cli2-formatter-default") ] ];
+      ? await importModuleIdsAndParams(dirs, outputFormatters, noImport)
+      // eslint-disable-next-line no-inline-comments, unicorn/no-await-expression-member
+      : [ [ (await import(/* webpackMode: "eager" */ "markdownlint-cli2-formatter-default")).default ] ];
     await Promise.all(formattersAndParams.map((formatterAndParams) => {
       const [ formatter, ...formatterParams ] = formatterAndParams;
       return formatter(formatterOptions, ...formatterParams);
@@ -909,7 +876,7 @@ const outputSummary = async (
 };
 
 // Main function
-const main = async (params) => {
+export const main = async (params) => {
   // Capture parameters
   const {
     directory,
@@ -917,7 +884,7 @@ const main = async (params) => {
     optionsDefault,
     optionsOverride,
     fileContents,
-    noRequire,
+    noImport,
     allowStdin
   } = params;
   let {
@@ -926,7 +893,7 @@ const main = async (params) => {
   } = params;
   const logMessage = params.logMessage || noop;
   const logError = params.logError || noop;
-  const fs = params.fs || require("node:fs");
+  const fs = params.fs || fsNode;
   const baseDirSystem =
     (directory && pathDefault.resolve(directory)) ||
     process.cwd();
@@ -974,7 +941,7 @@ const main = async (params) => {
       const resolvedConfigPath =
         posixPath(pathDefault.resolve(baseDirSystem, configPath));
       optionsArgv =
-        await readOptionsOrConfig(resolvedConfigPath, fs, noRequire);
+        await readOptionsOrConfig(resolvedConfigPath, fs, noImport);
       relativeDir = pathPosix.dirname(resolvedConfigPath);
     }
     // Process arguments and get base options
@@ -987,7 +954,7 @@ const main = async (params) => {
       optionsArgv || optionsDefault,
       fixDefault,
       noGlobs,
-      noRequire
+      noImport
     );
   } finally {
     if (!baseOptions?.baseMarkdownlintOptions.noBanner) {
@@ -1003,7 +970,7 @@ const main = async (params) => {
   // Add stdin as a non-file input if necessary
   if (useStdin) {
     const key = pathPosix.join(baseDir, "stdin");
-    const { text } = require("node:stream/consumers");
+    const { text } = await import("node:stream/consumers");
     nonFileContents = {
       ...nonFileContents,
       [key]: await text(process.stdin)
@@ -1046,7 +1013,7 @@ const main = async (params) => {
       optionsOverride,
       gitignore,
       ignoreFiles,
-      noRequire
+      noImport
     );
   // Output linting status
   if (showProgress) {
@@ -1084,32 +1051,8 @@ const main = async (params) => {
     modulePaths,
     logMessage,
     logError,
-    noRequire
+    noImport
   );
   // Return result
   return errorsPresent ? 1 : 0;
 };
-
-// Export functions
-module.exports = {
-  main
-};
-
-// Run if invoked as a CLI
-if (require.main === module) {
-  const params = {
-    "argv": process.argv.slice(2),
-    "logMessage": console.log,
-    "logError": console.error,
-    "allowStdin": true
-  };
-  main(params).
-    then((exitCode) => {
-      process.exitCode = exitCode;
-    }).
-    // eslint-disable-next-line unicorn/prefer-top-level-await
-    catch((error) => {
-      console.error(error);
-      process.exitCode = 2;
-    });
-}

package/{merge-options.js → merge-options.mjs}

@@ -1,7 +1,5 @@
 // @ts-check
 
-"use strict";
-
 /**
  * Merges two options objects by combining config and replacing properties.
  * @param {object} first First options object.
@@ -24,4 +22,4 @@ const mergeOptions = (first, second) => {
   return merged;
 };
 
-module.exports = mergeOptions;
+export default mergeOptions;