Support ESLint plugins with "type": "module" and main in package.json (#598)

y-hsgw · web-flow · commit a88f8cbeb17e · 2024-12-31T12:15:24.000-05:00
* feat: add support for projects with "type": "module" in package.json

* test: add test in package-json
diff --git a/lib/package-json.ts b/lib/package-json.ts
@@ -62,6 +62,10 @@ export async function loadPlugin(path: string): Promise<Plugin> {
       }
     }
 
+    if (pluginPackageJson.type === 'module' && !exports) {
+      pluginEntryPoint = pluginPackageJson.main;
+    }
+
     // If the ESM export doesn't exist, fall back to throwing the CJS error
     // (if the ESM export does exist, we'll validate it next)
     if (!pluginEntryPoint) {
diff --git a/test/lib/generate/package-json-test.ts b/test/lib/generate/package-json-test.ts
@@ -355,6 +355,44 @@ describe('generate (package.json)', function () {
     });
   });
 
+  describe("plugin entry point with type: 'module' and main field specified", function () {
+    beforeEach(function () {
+      mockFs({
+        'package.json': JSON.stringify({
+          name: 'eslint-plugin-test',
+          main: 'index.js',
+          type: 'module',
+        }),
+
+        'index.js': `export default {
+          rules: {
+            'no-foo': {
+              meta: { docs: { description: 'disallow foo.' }, },
+              create(context) {}
+            },
+          },
+        };`,
+
+        'README.md':
+          '<!-- begin auto-generated rules list --><!-- end auto-generated rules list -->',
+
+        'docs/rules/no-foo.md': '',
+
+        // Needed for some of the test infrastructure to work.
+        node_modules: mockFs.load(PATH_NODE_MODULES),
+      });
+    });
+
+    afterEach(function () {
+      mockFs.restore();
+      jest.resetModules();
+    });
+
+    it('finds the entry point', async function () {
+      await expect(generate('.')).resolves.toBeUndefined();
+    });
+  });
+
   describe('passing absolute path for plugin root', function () {
     beforeEach(function () {
       mockFs({

Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,10 @@ export async function loadPlugin(path: string): Promise<Plugin> {`
`62`	`62`	`}`
`63`	`63`	`}`
`64`	`64`
	`65`	`+ if (pluginPackageJson.type === 'module' && !exports) {`
	`66`	`+ pluginEntryPoint = pluginPackageJson.main;`
	`67`	`+ }`
	`68`	`+`
`65`	`69`	`// If the ESM export doesn't exist, fall back to throwing the CJS error`
`66`	`70`	`// (if the ESM export does exist, we'll validate it next)`
`67`	`71`	`if (!pluginEntryPoint) {`