Fix ESM support in Node 22+ when the package includes the main property (#648)

marcalexiei · web-flow · commit 82bf823ad0c5 · 2025-03-10T13:11:28.000-04:00
* fix(package-json): loadPlugin - check if `require` returns a ESM module

* chore(package-json): loadPlugin - add `istanbul ignore next` to avoid coverage error
diff --git a/lib/package-json.ts b/lib/package-json.ts
@@ -35,8 +35,20 @@ async function loadPackageJson(path: string): Promise<PackageJson> {
 export async function loadPlugin(path: string): Promise<Plugin> {
   const pluginRoot = getPluginRoot(path);
   try {
-    // Try require first which should work for CJS plugins.
-    return require(pluginRoot) as Plugin; // eslint-disable-line import/no-dynamic-require
+    /**
+     * Try require first which should work for CJS plugins.
+     * From Node 22 requiring on ESM module returns the module object
+     * @see https://github.com/bmish/eslint-doc-generator/issues/615
+     */
+    type cjsOrEsmPlugin = Plugin | { __esModule: boolean; default: Plugin };
+    // eslint-disable-next-line import/no-dynamic-require
+    const _plugin = require(pluginRoot) as cjsOrEsmPlugin;
+
+    /* istanbul ignore next */
+    if ('__esModule' in _plugin && _plugin.__esModule && _plugin.default) {
+      return _plugin.default;
+    }
+    return _plugin as Plugin;
   } catch (error) {
     // Otherwise, for ESM plugins, we'll have to try to resolve the exact plugin entry point and import it.
     const pluginPackageJson = await loadPackageJson(path);
diff --git a/test/lib/generate/cjs-test.ts b/test/lib/generate/cjs-test.ts
@@ -62,11 +62,7 @@ describe('generate (cjs)', function () {
 
   describe('package.json `main` field points to non-existent file', function () {
     it('throws an error', async function () {
-      const FIXTURE_PATH = join(
-        'test',
-        'fixtures',
-        'cjs-main-file-does-not-exist',
-      );
+      const FIXTURE_PATH = join(FIXTURE_ROOT, 'cjs-main-file-does-not-exist');
       await expect(generate(FIXTURE_PATH)).rejects.toThrow(
         /Cannot find module/u,
       );
