fix: support async Babel plugin in eslint-parser (#17348)

NullVoxPopuli · liuxingbaoyu · web-flow · commit 76f3c8588c92 · 2025-06-02T11:06:40.000-04:00
* Attempt to fix #17331 * Split maybeParse * Apparently the async version of createConfigItem doesn't exist? * Add to mini-babel-core, and rename maybeParse to maybeParseSync and asyncMaybeParse to maybeParse * Use createConfigItemAsync * Hope this is sufficient for a test * Don't need an import * ope * review --------- Co-authored-by: Babel Bot <30521560+liuxingbaoyu@users.noreply.github.com>
diff --git a/eslint/babel-eslint-parser/src/worker/babel-core.cts b/eslint/babel-eslint-parser/src/worker/babel-core.cts
@@ -9,8 +9,11 @@ function initialize(babel: typeof import("@babel/core")) {
   exports.types = babel.types;
   exports.tokTypes = babel.tokTypes;
   exports.parseSync = babel.parseSync;
+  exports.parseAsync = babel.parseAsync;
   exports.loadPartialConfigSync = babel.loadPartialConfigSync;
   exports.loadPartialConfigAsync = babel.loadPartialConfigAsync;
+  exports.createConfigItemAsync = babel.createConfigItemAsync;
+
   if (process.env.BABEL_8_BREAKING) {
     exports.createConfigItemSync = babel.createConfigItemSync;
   } else {
diff --git a/eslint/babel-eslint-parser/src/worker/handle-message.cts b/eslint/babel-eslint-parser/src/worker/handle-message.cts
@@ -1,5 +1,6 @@
 import babel = require("./babel-core.cts");
 import maybeParse = require("./maybeParse.cts");
+import maybeParseSync = require("./maybeParseSync.cts");
 import astInfo = require("./ast-info.cts");
 import config = require("./configuration.cts");
 
@@ -25,7 +26,7 @@ export = function handleMessage(action: ACTIONS, payload: any) {
         .then(options => maybeParse(payload.code, options));
     case ACTIONS.MAYBE_PARSE_SYNC:
       if (!USE_ESM) {
-        return maybeParse(
+        return maybeParseSync(
           payload.code,
           config.normalizeBabelParseConfigSync(payload.options),
         );
diff --git a/eslint/babel-eslint-parser/src/worker/maybeParse.cts b/eslint/babel-eslint-parser/src/worker/maybeParse.cts
@@ -13,15 +13,15 @@ let extractParserOptionsConfigItem: ConfigItem<any>;
 
 const MULTIPLE_OVERRIDES = /More than one plugin attempted to override parsing/;
 
-export = function maybeParse(
+export = async function asyncMaybeParse(
   code: string,
   options: InputOptions,
-): {
+): Promise<{
   ast: AST.Program | null;
   parserOptions: ParseResult | null;
-} {
+}> {
   if (!extractParserOptionsConfigItem) {
-    extractParserOptionsConfigItem = babel.createConfigItemSync(
+    extractParserOptionsConfigItem = await babel.createConfigItemAsync(
       [extractParserOptionsPlugin, ref],
       { dirname: __dirname, type: "plugin" },
     );
@@ -33,7 +33,7 @@ export = function maybeParse(
 
   try {
     return {
-      parserOptions: babel.parseSync(code, options),
+      parserOptions: await babel.parseAsync(code, options),
       ast: null,
     };
   } catch (err) {
@@ -46,7 +46,7 @@ export = function maybeParse(
   options.plugins = plugins;
 
   try {
-    ast = babel.parseSync(code, options);
+    ast = await babel.parseAsync(code, options);
   } catch (err) {
     throw convert.convertError(err);
   }
diff --git a/eslint/babel-eslint-parser/src/worker/maybeParseSync.cts b/eslint/babel-eslint-parser/src/worker/maybeParseSync.cts
@@ -0,0 +1,58 @@
+import babel = require("./babel-core.cts");
+import convert = require("../convert/index.cts");
+import astInfo = require("./ast-info.cts");
+import extractParserOptionsPlugin = require("./extract-parser-options-plugin.cjs");
+
+import type { InputOptions, ConfigItem } from "@babel/core";
+import type { AST, ParseResult } from "../types.cts";
+
+const { getVisitorKeys, getTokLabels } = astInfo;
+
+const ref = {};
+let extractParserOptionsConfigItem: ConfigItem<any>;
+
+const MULTIPLE_OVERRIDES = /More than one plugin attempted to override parsing/;
+
+export = function maybeParseSync(
+  code: string,
+  options: InputOptions,
+): {
+  ast: AST.Program | null;
+  parserOptions: ParseResult | null;
+} {
+  if (!extractParserOptionsConfigItem) {
+    extractParserOptionsConfigItem = babel.createConfigItemSync(
+      [extractParserOptionsPlugin, ref],
+      { dirname: __dirname, type: "plugin" },
+    );
+  }
+  const { plugins } = options;
+  options.plugins = plugins.concat(extractParserOptionsConfigItem);
+
+  let ast;
+
+  try {
+    return {
+      parserOptions: babel.parseSync(code, options),
+      ast: null,
+    };
+  } catch (err) {
+    if (!MULTIPLE_OVERRIDES.test(err.message)) {
+      throw err;
+    }
+  }
+
+  // There was already a parserOverride, so remove our plugin.
+  options.plugins = plugins;
+
+  try {
+    ast = babel.parseSync(code, options);
+  } catch (err) {
+    throw convert.convertError(err);
+  }
+
+  return {
+    ast: convert.convertFile(ast, code, getTokLabels(), getVisitorKeys()),
+    parserOptions: null,
+  };
+};
diff --git a/eslint/babel-eslint-tests/test/fixtures/mjs-babel-plugin-eslint-8/.eslintrc.js b/eslint/babel-eslint-tests/test/fixtures/mjs-babel-plugin-eslint-8/.eslintrc.js
@@ -0,0 +1,13 @@
+module.exports = {
+  root: true,
+  parser: "@babel/eslint-parser/experimental-worker",
+  parserOptions: {
+    babelOptions: {
+      configFile: __dirname + "/babel.config.json",
+      sourceType: "module",
+    },
+  },
+  rules: {
+    "template-curly-spacing": "error",
+  },
+};
diff --git a/eslint/babel-eslint-tests/test/fixtures/mjs-babel-plugin-eslint-8/a.js b/eslint/babel-eslint-tests/test/fixtures/mjs-babel-plugin-eslint-8/a.js
@@ -0,0 +1,3 @@
+export default function foo() {
+  return "bar";
+}
diff --git a/eslint/babel-eslint-tests/test/fixtures/mjs-babel-plugin-eslint-8/babel.config.json b/eslint/babel-eslint-tests/test/fixtures/mjs-babel-plugin-eslint-8/babel.config.json
@@ -0,0 +1,3 @@
+{
+  "plugins": ["module:./plugin.mjs"]
+}
diff --git a/eslint/babel-eslint-tests/test/fixtures/mjs-babel-plugin-eslint-8/plugin.mjs b/eslint/babel-eslint-tests/test/fixtures/mjs-babel-plugin-eslint-8/plugin.mjs
@@ -0,0 +1,11 @@
+export default async function () {
+  await Promise.resolve();
+
+  return {
+    visitor: {
+      StringLiteral(path) {
+        path.replaceWithSourceString("foo");
+      }
+    }
+  };
+};
diff --git a/eslint/babel-eslint-tests/test/fixtures/mjs-babel-plugin/a.js b/eslint/babel-eslint-tests/test/fixtures/mjs-babel-plugin/a.js
@@ -0,0 +1,3 @@
+export default function foo() {
+  return "bar";
+}
diff --git a/eslint/babel-eslint-tests/test/fixtures/mjs-babel-plugin/babel.config.json b/eslint/babel-eslint-tests/test/fixtures/mjs-babel-plugin/babel.config.json
@@ -0,0 +1,3 @@
+{
+  "plugins": ["module:./plugin.mjs"]
+}
diff --git a/eslint/babel-eslint-tests/test/fixtures/mjs-babel-plugin/eslint.config.js b/eslint/babel-eslint-tests/test/fixtures/mjs-babel-plugin/eslint.config.js
@@ -0,0 +1,14 @@
+module.exports = {
+  languageOptions: {
+    parser: require("@babel/eslint-parser/experimental-worker"),
+    parserOptions: {
+      babelOptions: {
+        configFile: __dirname + "/babel.config.json",
+        sourceType: "module",
+      },
+    },
+  },
+  rules: {
+    "template-curly-spacing": "error",
+  },
+};
diff --git a/eslint/babel-eslint-tests/test/fixtures/mjs-babel-plugin/plugin.mjs b/eslint/babel-eslint-tests/test/fixtures/mjs-babel-plugin/plugin.mjs
@@ -0,0 +1,11 @@
+export default async function () {
+  await Promise.resolve();
+
+  return {
+    visitor: {
+      StringLiteral(path) {
+        path.replaceWithSourceString("foo");
+      }
+    }
+  };
+};
diff --git a/eslint/babel-eslint-tests/test/integration/config-files.js b/eslint/babel-eslint-tests/test/integration/config-files.js
@@ -38,4 +38,25 @@ describe("Babel config files", () => {
       ).toMatchObject([{ errorCount: 0, messages: [] }]);
     }
   });
+
+  it("works with async-requiring ESM plugins", async () => {
+    const engine = new ESLint({
+      ignore: false,
+      overrideConfigFile: fileURLToPath(
+        new URL(
+          parseInt(ESLint.version, 10) >= 9
+            ? "../fixtures/mjs-babel-plugin/eslint.config.js"
+            : "../fixtures/mjs-babel-plugin-eslint-8/.eslintrc.js",
+          import.meta.url,
+        ),
+      ),
+    });
+    expect(
+      await engine.lintFiles([
+        fileURLToPath(
+          new URL("../fixtures/mjs-babel-plugin/a.js", import.meta.url),
+        ),
+      ]),
+    ).toMatchObject([{ errorCount: 0, messages: [] }]);
+  });
 });

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export default function foo() {`
	`2`	`+ return "bar";`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "plugins": ["module:./plugin.mjs"]`
	`3`	`+}`