fix: please webpack module resolution

kamilkisiela · Jun 20, 2022 · 2e18f50 · 2e18f50
1 parent dd77d39
commit 2e18f50
Show file tree

Hide file tree

Showing 9 changed files with 185 additions and 108 deletions.
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -7,4 +7,4 @@
   "baseBranch": "master",
   "updateInternalDependencies": "patch",
   "ignore": []
-}
+}
diff --git a/src/commands/bootstrap.ts b/src/commands/bootstrap.ts
@@ -3,7 +3,7 @@ import * as fse from "fs-extra";
 import { createCommand } from "../command";
 
 /** The default bob fields that should be within a package.json */
-const presetFields = {
+export const presetFields = Object.freeze({
   main: "dist/index.js",
   module: "dist/index.mjs",
   typings: "dist/index.d.ts",
@@ -13,22 +13,32 @@ const presetFields = {
   exports: {
     ".": {
       require: {
-        default: "./dist/index.js",
         types: "./dist/index.d.ts",
+        default: "./dist/index.js",
       },
       import: {
+        types: "./dist/index.d.ts",
         default: "./dist/index.mjs",
+      },
+      /** without this default (THAT MUST BE LAST!!!) webpack will have a midlife crisis. */
+      default: {
         types: "./dist/index.d.ts",
+        default: "./dist/index.js",
       },
     },
     "./*": {
       require: {
-        default: "./dist/*.js",
         types: "./dist/*.d.ts",
+        default: "./dist/*.js",
       },
       import: {
+        types: "./dist/*.d.ts",
         default: "./dist/*.mjs",
+      },
+      /** without this default (THAT MUST BE LAST!!!) webpack will have a midlife crisis. */
+      default: {
         types: "./dist/*.d.ts",
+        default: "./dist/*.mjs",
       },
     },
     "./package.json": "./package.json",
@@ -37,7 +47,7 @@ const presetFields = {
     directory: "dist",
     access: "public",
   },
-};
+});
 
 export const bootstrapCommand = createCommand<{}, {}>((api) => {
   return {

diff --git a/src/commands/build.ts b/src/commands/build.ts
@@ -17,6 +17,7 @@ import mkdirp from "mkdirp";
 import { createCommand } from "../command";
 import { BobConfig } from "../config";
 import { rewriteExports } from "../utils/rewrite-exports";
+import { presetFields } from "./bootstrap";
 
 interface BuildOptions {
   external?: string[];
@@ -406,17 +407,7 @@ function rewritePackageJson(pkg: Record<string, any>, distPath: string) {
   if (pkg.exports) {
     newPkg.exports = rewriteExports(pkg.exports, DIST_DIR);
   } else {
-    newPkg.exports = {
-      ".": {
-        require: "./index.js",
-        import: "./index.mjs",
-      },
-      "./*": {
-        require: "./*.js",
-        import: "./*.mjs",
-      },
-      "./package.json": "./package.json",
-    };
+    newPkg.exports = presetFields.exports;
   }
 
   if (pkg.bin) {
@@ -449,21 +440,23 @@ export function validatePackageJson(pkg: any) {
   expect("typescript.definition", `${DIST_DIR}/index.d.ts`);
 
   expect("exports['.'].require", {
-    default: `./${DIST_DIR}/index.js`,
     types: `./${DIST_DIR}/index.d.ts`,
+    default: `./${DIST_DIR}/index.js`,
   });
   expect("exports['.'].import", {
-    default: `./${DIST_DIR}/index.mjs`,
     types: `./${DIST_DIR}/index.d.ts`,
+    default: `./${DIST_DIR}/index.mjs`,
   });
+  expect("exports['.'].default", `./${DIST_DIR}/index.mjs`);
   expect("exports['./*'].require", {
-    default: `./${DIST_DIR}/*.js`,
     types: `./${DIST_DIR}/*.d.ts`,
+    default: `./${DIST_DIR}/*.js`,
   });
   expect("exports['./*'].import", {
-    default: `./${DIST_DIR}/*.mjs`,
     types: `./${DIST_DIR}/*.d.ts`,
+    default: `./${DIST_DIR}/*.mjs`,
   });
+  expect("exports['./*'].default", `./${DIST_DIR}/*.mjs`);
 }
 
 async function copyToDist(cwd: string, files: string[], distDir: string) {

diff --git a/src/utils/rewrite-exports.ts b/src/utils/rewrite-exports.ts
@@ -1,5 +1,13 @@
 export function rewriteExports(
-  exports: Record<string, string | { require?: string | { [key: string]: string }; import?: string | { [key: string]: string } }>,
+  exports: Record<
+    string,
+    | string
+    | {
+        require?: string | { [key: string]: string };
+        import?: string | { [key: string]: string };
+        default?: string | { [key: string]: string };
+      }
+  >,
   distDir: string
 ) {
   const newExports = { ...exports };
@@ -8,52 +16,68 @@ export function rewriteExports(
 
   newExports["."] = {
     require: {
+      types: "./index.d.ts",
       default: "./index.js",
-      types: "./index.d.ts"
     },
     import: {
+      types: "./index.d.ts",
       default: "./index.mjs",
+    },
+    default: {
       types: "./index.d.ts",
+      default: "./index.mjs",
     },
   };
 
   newExports["./*"] = {
-    require:  {
+    require: {
+      types: "./*.d.ts",
       default: "./*.js",
-      types: "./*.d.ts"
     },
     import: {
+      types: "./*.d.ts",
+      default: "./*.mjs",
+    },
+    default: {
+      types: "./*.d.ts",
       default: "./*.mjs",
-      types: "./*.d.ts"
     },
   };
 
   for (const [key, value] of Object.entries(newExports)) {
     if (!value) continue;
 
-    let newValue = value as string | { require?: string | { [key: string]: string }; import?: string | { [key: string]: string } };
+    let newValue = value as
+      | string
+      | {
+          require?: string | { [key: string]: string };
+          import?: string | { [key: string]: string };
+          default?: string | { [key: string]: string };
+        };
 
     if (typeof newValue === "string") {
       newValue = newValue.replace(`${distDir}/`, "");
     } else if (typeof newValue === "object" && newValue != null) {
-
-      function transformValue(value: string | { [key: string]: string } | undefined) {
+      function transformValue(
+        value: string | { [key: string]: string } | undefined
+      ) {
         if (value == null) {
-          return undefined
+          return undefined;
         }
         if (typeof value === "object") {
-          const newValue: Record<string, string> = {}
+          const newValue: Record<string, string> = {};
           for (const [key, path] of Object.entries(value)) {
-            newValue[key] = path.replace(`${distDir}/`, "")
+            newValue[key] = path.replace(`${distDir}/`, "");
           }
-          return newValue
+          return newValue;
         }
-        return value.replace(`${distDir}/`, "")
+        return value.replace(`${distDir}/`, "");
       }
 
       newValue = {
         require: transformValue(newValue.require),
         import: transformValue(newValue.import),
+        default: transformValue(newValue.import),
       };
     }
     newExports[key.replace(`${distDir}/`, "")] = newValue;

diff --git a/test/__fixtures__/simple-monorepo/packages/a/package.json b/test/__fixtures__/simple-monorepo/packages/a/package.json
@@ -9,23 +9,25 @@
   "exports": {
     ".": {
       "require": {
-        "default": "./dist/index.js",
-        "types": "./dist/index.d.ts"
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
       },
       "import": {
-        "default": "./dist/index.mjs",
-        "types": "./dist/index.d.ts"
-      }
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.mjs"
+      },
+      "default": "./dist/index.mjs"
     },
     "./*": {
       "require": {
-        "default": "./dist/*.js",
-        "types": "./dist/*.d.ts"
+        "types": "./dist/*.d.ts",
+        "default": "./dist/*.js"
       },
       "import": {
-        "default": "./dist/*.mjs",
-        "types": "./dist/*.d.ts"
-      }
+        "types": "./dist/*.d.ts",
+        "default": "./dist/*.mjs"
+      },
+      "default": "./dist/*.mjs"
     },
     "./package.json": "./package.json"
   },

diff --git a/test/__fixtures__/simple-monorepo/packages/b/package.json b/test/__fixtures__/simple-monorepo/packages/b/package.json
@@ -9,23 +9,25 @@
   "exports": {
     ".": {
       "require": {
-        "default": "./dist/index.js",
-        "types": "./dist/index.d.ts"
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
       },
       "import": {
-        "default": "./dist/index.mjs",
-        "types": "./dist/index.d.ts"
-      }
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.mjs"
+      },
+      "default": "./dist/index.mjs"
     },
     "./*": {
       "require": {
-        "default": "./dist/*.js",
-        "types": "./dist/*.d.ts"
+        "types": "./dist/*.d.ts",
+        "default": "./dist/*.js"
       },
       "import": {
-        "default": "./dist/*.mjs",
-        "types": "./dist/*.d.ts"
-      }
+        "types": "./dist/*.d.ts",
+        "default": "./dist/*.mjs"
+      },
+      "default": "./dist/*.mjs"
     },
     "./package.json": "./package.json"
   },

diff --git a/test/__fixtures__/simple/package.json b/test/__fixtures__/simple/package.json
@@ -9,28 +9,30 @@
   "exports": {
     ".": {
       "require": {
-        "default": "./dist/index.js",
-        "types": "./dist/index.d.ts"
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
       },
       "import": {
-        "default": "./dist/index.mjs",
-        "types": "./dist/index.d.ts"
-      }
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.mjs"
+      },
+      "default": "./dist/index.mjs"
     },
     "./*": {
       "require": {
-        "default": "./dist/*.js",
-        "types": "./dist/*.d.ts"
+        "types": "./dist/*.d.ts",
+        "default": "./dist/*.js"
       },
       "import": {
-        "default": "./dist/*.mjs",
-        "types": "./dist/*.d.ts"
-      }
+        "types": "./dist/*.d.ts",
+        "default": "./dist/*.mjs"
+      },
+      "default": "./dist/*.mjs"
     },
     "./package.json": "./package.json"
   },
   "publishConfig": {
     "directory": "dist",
     "access": "public"
   }
-}
+}