fix: commonjs imports (#118)

n1ru4l · web-flow · commit f6857331e4b7 · 2022-08-05T11:15:41.000+02:00
* fix: commonjs imports

* :) :) :)

* add ts smoke tests

* this is not a test lul

* add more module resolution variations

* better changeset
diff --git a/.changeset/nine-snails-speak.md b/.changeset/nine-snails-speak.md
@@ -0,0 +1,22 @@
+---
+"bob-the-bundler": major
+---
+
+Change the exports map again, to please TypeScript commonjs :)
+
+This is a major breaking change as it requires adjusting your `package.json` exports map.
+
+The `require` entries file extension must be changed from `.d.ts` to `.d.cts`.
+
+```diff
+  {
+    "exports": {
+      ".": {
+        "require": {
+-          "types": "./dist/typings/index.d.ts",
++          "types": "./dist/typings/index.d.cts"
+        }
+      }
+    }
+  }
+```
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -36,3 +36,5 @@ jobs:
         run: yarn install
       - name: Run Tests
         run: yarn test
+      - name: Run TS Smoke Tests
+        run: yarn test:ts
diff --git a/package.json b/package.json
@@ -49,6 +49,7 @@
     "prepublish": "yarn build",
     "build": "rimraf dist && tsc",
     "test": "jest",
+    "test:ts": "node test/ts-tests/run-tests.mjs",
     "prerelease": "yarn build",
     "release": "changeset publish",
     "release:canary": "node scripts/canary-release.js && yarn build && yarn changeset publish --tag alpha"
diff --git a/src/commands/bootstrap.ts b/src/commands/bootstrap.ts
@@ -21,7 +21,7 @@ export const presetFields = Object.freeze({
   exports: {
     ".": {
       require: {
-        types: "./dist/typings/index.d.ts",
+        types: "./dist/typings/index.d.cts",
         default: "./dist/cjs/index.js",
       },
       import: {
diff --git a/src/commands/build.ts b/src/commands/build.ts
@@ -274,6 +274,30 @@ async function build({
       join(distPath, "cjs", "package.json"),
       JSON.stringify({ type: "commonjs" })
     );
+    // We need to provide .cjs extension type definitions as well :)
+    // https://github.com/ardatan/graphql-tools/discussions/4581#discussioncomment-3329673
+
+    const declarations = await globby("**/*.d.ts", {
+      cwd: getBuildPath("cjs"),
+      absolute: false,
+      ignore: filesToExcludeFromDist,
+    });
+    await Promise.all(
+      declarations.map((filePath) =>
+        limit(async () => {
+          const contents = await fse.readFile(
+            join(getBuildPath("cjs"), filePath),
+            "utf-8"
+          );
+          await fse.writeFile(
+            join(distPath, "typings", filePath.replace(/\.d\.ts/, ".d.cts")),
+            contents
+              .replace(/\.js";\n/g, `.cjs";\n`)
+              .replace(/\.js';\n/g, `.cjs';\n`)
+          );
+        })
+      )
+    );
   }
 
   // move the package.json to dist
diff --git a/test/__fixtures__/simple-monorepo/packages/a/package.json b/test/__fixtures__/simple-monorepo/packages/a/package.json
@@ -9,7 +9,7 @@
   "exports": {
     ".": {
       "require": {
-        "types": "./dist/typings/index.d.ts",
+        "types": "./dist/typings/index.d.cts",
         "default": "./dist/cjs/index.js"
       },
       "import": {
@@ -23,7 +23,7 @@
     },
     "./*": {
       "require": {
-        "types": "./dist/typings/*.d.ts",
+        "types": "./dist/typings/*.d.cts",
         "default": "./dist/cjs/*.js"
       },
       "import": {
@@ -45,4 +45,4 @@
     "access": "public"
   },
   "type": "module"
-}
+}
diff --git a/test/__fixtures__/simple-monorepo/packages/b/package.json b/test/__fixtures__/simple-monorepo/packages/b/package.json
@@ -10,7 +10,7 @@
   "exports": {
     ".": {
       "require": {
-        "types": "./dist/typings/index.d.ts",
+        "types": "./dist/typings/index.d.cts",
         "default": "./dist/cjs/index.js"
       },
       "import": {
@@ -24,7 +24,7 @@
     },
     "./foo": {
       "require": {
-        "types": "./dist/typings/foo.d.ts",
+        "types": "./dist/typings/foo.d.cts",
         "default": "./dist/cjs/foo.js"
       },
       "import": {
diff --git a/test/__fixtures__/simple/package.json b/test/__fixtures__/simple/package.json
@@ -9,7 +9,7 @@
   "exports": {
     ".": {
       "require": {
-        "types": "./dist/typings/index.d.ts",
+        "types": "./dist/typings/index.d.cts",
         "default": "./dist/cjs/index.js"
       },
       "import": {
@@ -23,7 +23,7 @@
     },
     "./*": {
       "require": {
-        "types": "./dist/typings/*.d.ts",
+        "types": "./dist/typings/*.d.cts",
         "default": "./dist/cjs/*.js"
       },
       "import": {
diff --git a/test/__fixtures__/simple/src/index.ts b/test/__fixtures__/simple/src/index.ts
@@ -1 +1,3 @@
 export const someNumber = 1;
+
+export default "kek";
diff --git a/test/integration.spec.ts b/test/integration.spec.ts
@@ -26,14 +26,18 @@ it("can bundle a simple project", async () => {
     exports.__esModule = true;
     exports.someNumber = void 0;
     exports.someNumber = 1;
+    exports[\\"default\\"] = \\"kek\\";
     "
   `);
   expect(fse.readFileSync(indexDtsFilePath, "utf8")).toMatchInlineSnapshot(`
     "export declare const someNumber = 1;
+    declare const _default: \\"kek\\";
+    export default _default;
     "
   `);
   expect(fse.readFileSync(indexMjsFilePath, "utf8")).toMatchInlineSnapshot(`
     "export var someNumber = 1;
+    export default \\"kek\\";
     "
   `);
   expect(fse.readFileSync(readmeFilePath, "utf8")).toMatchInlineSnapshot(`
@@ -57,7 +61,7 @@ it("can bundle a simple project", async () => {
       \\"exports\\": {
         \\".\\": {
           \\"require\\": {
-            \\"types\\": \\"./typings/index.d.ts\\",
+            \\"types\\": \\"./typings/index.d.cts\\",
             \\"default\\": \\"./cjs/index.js\\"
           },
           \\"import\\": {
@@ -71,7 +75,7 @@ it("can bundle a simple project", async () => {
         },
         \\"./*\\": {
           \\"require\\": {
-            \\"types\\": \\"./typings/*.d.ts\\",
+            \\"types\\": \\"./typings/*.d.cts\\",
             \\"default\\": \\"./cjs/*.js\\"
           },
           \\"import\\": {
@@ -166,7 +170,7 @@ it("can build a monorepo project", async () => {
       \\"exports\\": {
         \\".\\": {
           \\"require\\": {
-            \\"types\\": \\"./typings/index.d.ts\\",
+            \\"types\\": \\"./typings/index.d.cts\\",
             \\"default\\": \\"./cjs/index.js\\"
           },
           \\"import\\": {
@@ -180,7 +184,7 @@ it("can build a monorepo project", async () => {
         },
         \\"./*\\": {
           \\"require\\": {
-            \\"types\\": \\"./typings/*.d.ts\\",
+            \\"types\\": \\"./typings/*.d.cts\\",
             \\"default\\": \\"./cjs/*.js\\"
           },
           \\"import\\": {
@@ -256,7 +260,7 @@ it("can build a monorepo project", async () => {
       \\"exports\\": {
         \\".\\": {
           \\"require\\": {
-            \\"types\\": \\"./typings/index.d.ts\\",
+            \\"types\\": \\"./typings/index.d.cts\\",
             \\"default\\": \\"./cjs/index.js\\"
           },
           \\"import\\": {
@@ -270,7 +274,7 @@ it("can build a monorepo project", async () => {
         },
         \\"./foo\\": {
           \\"require\\": {
-            \\"types\\": \\"./typings/foo.d.ts\\",
+            \\"types\\": \\"./typings/foo.d.cts\\",
             \\"default\\": \\"./cjs/foo.js\\"
           },
           \\"import\\": {
diff --git a/test/ts-tests/.gitignore b/test/ts-tests/.gitignore
@@ -0,0 +1 @@
+fixture.js
diff --git a/test/ts-tests/fixture.ts b/test/ts-tests/fixture.ts
@@ -0,0 +1,4 @@
+import kek from "simple";
+import { someNumber } from "simple";
+
+console.log(`${kek} ${someNumber}`);
diff --git a/test/ts-tests/package.json b/test/ts-tests/package.json
@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}
diff --git a/test/ts-tests/run-tests.mjs b/test/ts-tests/run-tests.mjs
@@ -0,0 +1,28 @@
+import execa from "execa";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+async function run(commandStr) {
+  const [command, ...args] = commandStr.split(" ");
+  await execa(command, args);
+}
+
+async function main() {
+  await run(`rm -rf ${__dirname}/node_modules`);
+  await run(`mkdir -p ${__dirname}/node_modules`);
+  await run(
+    `ln -s ${__dirname}/../__fixtures__/simple/dist ${__dirname}/node_modules/simple`
+  );
+
+  await run(`yarn tsc --project ${__dirname}/tsconfig.esnext-node.json`);
+  await run(`yarn tsc --project ${__dirname}/tsconfig.commonjs-node.json`);
+  await run(`yarn tsc --project ${__dirname}/tsconfig.commonjs-node16.json`);
+  await run(`yarn tsc --project ${__dirname}/tsconfig.commonjs-nodenext.json`);
+  await run(`yarn tsc --project ${__dirname}/tsconfig.node16-node16.json`);
+  await run(`yarn tsc --project ${__dirname}/tsconfig.nodenext-nodenext.json`);
+}
+
+main();
diff --git a/test/ts-tests/tsconfig.commonjs-node.json b/test/ts-tests/tsconfig.commonjs-node.json
@@ -0,0 +1,8 @@
+{
+  "include": ["fixture.ts"],
+  "compilerOptions": {
+    "strict": true,
+    "module": "CommonJS",
+    "moduleResolution": "Node"
+  }
+}
diff --git a/test/ts-tests/tsconfig.commonjs-node16.json b/test/ts-tests/tsconfig.commonjs-node16.json
@@ -0,0 +1,8 @@
+{
+  "include": ["fixture.ts"],
+  "compilerOptions": {
+    "strict": true,
+    "module": "CommonJS",
+    "moduleResolution": "Node16"
+  }
+}
diff --git a/test/ts-tests/tsconfig.commonjs-nodenext.json b/test/ts-tests/tsconfig.commonjs-nodenext.json
@@ -0,0 +1,8 @@
+{
+  "include": ["fixture.ts"],
+  "compilerOptions": {
+    "strict": true,
+    "module": "CommonJS",
+    "moduleResolution": "NodeNext"
+  }
+}
diff --git a/test/ts-tests/tsconfig.esnext-node.json b/test/ts-tests/tsconfig.esnext-node.json
@@ -0,0 +1,8 @@
+{
+  "include": ["fixture.ts"],
+  "compilerOptions": {
+    "strict": true,
+    "module": "ESNext",
+    "moduleResolution": "Node"
+  }
+}
diff --git a/test/ts-tests/tsconfig.node16-node16.json b/test/ts-tests/tsconfig.node16-node16.json
@@ -0,0 +1,8 @@
+{
+  "include": ["fixture.ts"],
+  "compilerOptions": {
+    "strict": true,
+    "module": "Node16",
+    "moduleResolution": "Node16"
+  }
+}
diff --git a/test/ts-tests/tsconfig.nodenext-nodenext.json b/test/ts-tests/tsconfig.nodenext-nodenext.json
@@ -0,0 +1,8 @@
+{
+  "include": ["fixture.ts"],
+  "compilerOptions": {
+    "strict": true,
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext"
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
`1`	`1`	`export const someNumber = 1;`
	`2`	`+`
	`3`	`+export default "kek";`