Specify runtime exports (#10853)

.github/workflows/ci.yml

@@ -53,6 +53,7 @@ jobs:
       - name: Generate coverage report
         run: |
           make -j test-ci-coverage
+          yarn test:esm
       - name: Upload coverage report
         uses: codecov/codecov-action@v1
         with:

.gitignore

@@ -7,9 +7,8 @@
 .pnp.js
 
 .DS_Store
-/node_modules
-/.github/actions/*/node_modules
-/packages/*/node_modules
+**/node_modules
+!**/test/fixtures/**/node_modules
 /packages/*/LICENSE
 !/packages/babel-parser/LICENSE
 !/packages/babel-plugin-transform-object-assign/LICENSE
@@ -63,13 +62,11 @@ packages/babel-standalone/babel.js
 packages/babel-standalone/babel.js.map
 packages/babel-standalone/babel.min.js
 /codemods/*/lib
-/codemods/*/node_modules
 /packages/babel-parser/build
 .idea/
 /.changelog
 
 /eslint/*/lib
-/eslint/*/node_modules
 /eslint/*/LICENSE
 !/packages/babel-eslint-plugin/LICENSE
 /.vscode

package.json

@@ -9,7 +9,8 @@
     "fix": "make fix",
     "lint": "make lint",
     "test": "make test",
-    "version": "yarn --immutable-cache && git add yarn.lock"
+    "version": "yarn --immutable-cache && git add yarn.lock",
+    "test:esm": "node test/esm/index.mjs"
   },
   "devDependencies": {
     "@babel/cli": "^7.11.6",
@@ -69,7 +70,8 @@
   "workspaces": [
     "codemods/*",
     "eslint/*",
-    "packages/*"
+    "packages/*",
+    "test/esm"
   ],
   "resolutions": {
     "@lerna/version": "patch:@lerna/version@npm:3.20.2#.yarn-patches/@lerna/version.patch",

packages/babel-plugin-transform-runtime/scripts/build-dist.js

@@ -90,32 +90,68 @@ function writeCoreJS({
       `module.exports = require("${corejsRoot}/${corejsPath}");`
     );
   });
+
+  writeCorejsExports(pkgDirname, runtimeRoot, paths);
+}
+
+function writeCorejsExports(pkgDirname, runtimeRoot, paths) {
+  const pkgJsonPath = require.resolve(`${pkgDirname}/package.json`);
+  const pkgJson = require(pkgJsonPath);
+  const exports = pkgJson.exports;
+  // Export `./core-js/` so `import "@babel/runtime-corejs3/core-js/some-feature.js"` works
+  exports[`./${runtimeRoot}/`] = `./${runtimeRoot}/`;
+  for (const corejsPath of paths) {
+    // Export `./core-js/some-feature` so `import "@babel/runtime-corejs3/core-js/some-feature"` also works
+    const corejsExportPath = `./${runtimeRoot}/${corejsPath}`;
+    exports[corejsExportPath] = corejsExportPath + ".js";
+  }
+  pkgJson.exports = exports;
+  outputFile(pkgJsonPath, JSON.stringify(pkgJson, undefined, 2) + "\n");
 }
 
 function writeHelpers(runtimeName, { corejs } = {}) {
-  writeHelperFiles(runtimeName, { corejs, esm: false });
-  writeHelperFiles(runtimeName, { corejs, esm: true });
+  const helperPaths = writeHelperFiles(runtimeName, { corejs, esm: false });
+  const helperESMPaths = writeHelperFiles(runtimeName, { corejs, esm: true });
+  writeHelperExports(runtimeName, helperPaths.concat(helperESMPaths));
 }
 
+function writeHelperExports(runtimeName, helperPaths) {
+  const helperSubExports = {};
+  for (const helperPath of helperPaths) {
+    helperSubExports[helperPath.replace(".js", "")] = helperPath;
+  }
+  const exports = {
+    "./helpers/": "./helpers/",
+    ...helperSubExports,
+    "./package.json": "./package.json",
+    "./regenerator": "./regenerator/index.js",
+    "./regenerator/": "./regenerator/",
+  };
+  const pkgDirname = getRuntimeRoot(runtimeName);
+  const pkgJsonPath = require.resolve(`${pkgDirname}/package.json`);
+  const pkgJson = require(pkgJsonPath);
+  pkgJson.exports = exports;
+  outputFile(pkgJsonPath, JSON.stringify(pkgJson, undefined, 2) + "\n");
+}
 function writeHelperFiles(runtimeName, { esm, corejs }) {
   const pkgDirname = getRuntimeRoot(runtimeName);
-
+  const helperPaths = [];
   for (const helperName of helpers.list) {
-    const helperFilename = path.join(
-      pkgDirname,
-      "helpers",
-      esm ? "esm" : "",
-      `${helperName}.js`
-    );
-
+    const helperPath =
+      "./" + path.join("helpers", esm ? "esm" : "", `${helperName}.js`);
+    const helperFilename = path.join(pkgDirname, helperPath);
     outputFile(
       helperFilename,
       buildHelper(runtimeName, pkgDirname, helperFilename, helperName, {
         esm,
         corejs,
       })
     );
+
+    helperPaths.push(helperPath);
   }
+
+  return helperPaths;
 }
 
 function getRuntimeRoot(runtimeName) {
@@ -171,11 +207,7 @@ function buildHelper(
         transformRuntime,
         { corejs, useESModules: esm, version: runtimeVersion },
       ],
-      buildRuntimeRewritePlugin(
-        runtimeName,
-        path.relative(path.dirname(helperFilename), pkgDirname),
-        helperName
-      ),
+      buildRuntimeRewritePlugin(runtimeName, helperName, esm),
     ],
     overrides: [
       {
@@ -186,12 +218,19 @@ function buildHelper(
   }).code;
 }
 
-function buildRuntimeRewritePlugin(runtimeName, relativePath, helperName) {
-  function adjustImportPath(node, relativePath) {
-    node.value =
-      helpers.list.indexOf(node.value) !== -1
-        ? `./${node.value}`
-        : node.value.replace(runtimeName + "/", relativePath + "/");
+function buildRuntimeRewritePlugin(runtimeName, helperName, esm) {
+  const helperPath = esm ? "helpers/esm" : "helpers";
+  /**
+   * rewrite helpers imports to runtime imports
+   * @example
+   * adjustImportPath(ast`"setPrototypeOf"`)
+   * // returns ast`"@babel/runtime/helpers/esm/setPrototypeOf"`
+   * @param {*} node The string literal contains import path
+   */
+  function adjustImportPath(node) {
+    if (helpers.list.includes(node.value)) {
+      node.value = `${runtimeName}/${helperPath}/${node.value}`;
+    }
   }
 
   return {
@@ -206,7 +245,7 @@ function buildRuntimeRewritePlugin(runtimeName, relativePath, helperName) {
     },
     visitor: {
       ImportDeclaration(path) {
-        adjustImportPath(path.get("source").node, relativePath);
+        adjustImportPath(path.get("source").node);
       },
       CallExpression(path) {
         if (
@@ -217,9 +256,8 @@ function buildRuntimeRewritePlugin(runtimeName, relativePath, helperName) {
           return;
         }
 
-        // replace any reference to @babel/runtime and other helpers
-        // with a relative path
-        adjustImportPath(path.get("arguments")[0].node, relativePath);
+        // replace reference to internal helpers with @babel/runtime import path
+        adjustImportPath(path.get("arguments")[0].node);
       },
     },
   };

packages/babel-runtime-corejs2/helpers/esm/iterableToArray.js

@@ -1,6 +1,6 @@
-import _Array$from from "../../core-js/array/from";
-import _isIterable from "../../core-js/is-iterable";
-import _Symbol from "../../core-js/symbol";
+import _Array$from from "@babel/runtime-corejs2/core-js/array/from";
+import _isIterable from "@babel/runtime-corejs2/core-js/is-iterable";
+import _Symbol from "@babel/runtime-corejs2/core-js/symbol";
 export default function _iterableToArray(iter) {
   if (typeof _Symbol !== "undefined" && _isIterable(Object(iter))) return _Array$from(iter);
 }

packages/babel-runtime-corejs2/helpers/esm/temporalRef.js

@@ -1,5 +1,5 @@
-import undef from "./temporalUndefined";
-import err from "./tdz";
+import undef from "@babel/runtime-corejs2/helpers/esm/temporalUndefined";
+import err from "@babel/runtime-corejs2/helpers/esm/tdz";
 export default function _temporalRef(val, name) {
   return val === undef ? err(name) : val;
 }

packages/babel-runtime-corejs2/helpers/esm/toArray.js

@@ -1,7 +1,7 @@
-import arrayWithHoles from "./arrayWithHoles";
-import iterableToArray from "./iterableToArray";
-import unsupportedIterableToArray from "./unsupportedIterableToArray";
-import nonIterableRest from "./nonIterableRest";
+import arrayWithHoles from "@babel/runtime-corejs2/helpers/esm/arrayWithHoles";
+import iterableToArray from "@babel/runtime-corejs2/helpers/esm/iterableToArray";
+import unsupportedIterableToArray from "@babel/runtime-corejs2/helpers/esm/unsupportedIterableToArray";
+import nonIterableRest from "@babel/runtime-corejs2/helpers/esm/nonIterableRest";
 export default function _toArray(arr) {
   return arrayWithHoles(arr) || iterableToArray(arr) || unsupportedIterableToArray(arr) || nonIterableRest();
 }

packages/babel-runtime-corejs2/helpers/iterableToArray.js

@@ -1,8 +1,8 @@
-var _Array$from = require("../core-js/array/from");
+var _Array$from = require("@babel/runtime-corejs2/core-js/array/from");
 
-var _isIterable = require("../core-js/is-iterable");
+var _isIterable = require("@babel/runtime-corejs2/core-js/is-iterable");
 
-var _Symbol = require("../core-js/symbol");
+var _Symbol = require("@babel/runtime-corejs2/core-js/symbol");
 
 function _iterableToArray(iter) {
   if (typeof _Symbol !== "undefined" && _isIterable(Object(iter))) return _Array$from(iter);