feat: package is now ESM (#353)

BREAKING CHANGE: package is now ESM

Author: wolfy1339

package-lock.json

@@ -3,14 +3,15 @@
   "publishConfig": {
     "access": "public"
   },
+  "type": "module",
   "version": "0.0.0-development",
   "description": "Universal library to retrieve GitHub’s identity URL for the OAuth web flow",
   "scripts": {
     "build": "node scripts/build.mjs && tsc -p tsconfig.json",
     "lint": "prettier --check '{src,test}/**/*' README.md package.json",
     "lint:fix": "prettier --write '{src,test}/**/*' README.md package.json",
     "pretest": "npm run -s lint",
-    "test": "jest --coverage"
+    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" npx jest --coverage"
   },
   "repository": "github:octokit/oauth-authorization-url.js",
   "files": [
@@ -24,7 +25,7 @@
   "author": "Gregor Martynus (https://github.com/gr2m)",
   "license": "MIT",
   "devDependencies": {
-    "@octokit/tsconfig": "^2.0.0",
+    "@octokit/tsconfig": "^3.0.0",
     "@types/jest": "^29.0.0",
     "esbuild": "^0.20.0",
     "glob": "^10.2.6",
@@ -34,11 +35,15 @@
     "typescript": "^5.0.0"
   },
   "jest": {
+    "extensionsToTreatAsEsm": [
+      ".ts"
+    ],
     "transform": {
       "^.+\\.(ts|tsx)$": [
         "ts-jest",
         {
-          "tsconfig": "test/tsconfig.test.json"
+          "tsconfig": "test/tsconfig.test.json",
+          "useESM": true
         }
       ]
     },
@@ -49,6 +54,9 @@
         "functions": 100,
         "lines": 100
       }
+    },
+    "moduleNameMapper": {
+      "^(.+)\\.jsx?$": "$1"
     }
   },
   "release": {

package.json

@@ -35,28 +35,6 @@ async function main() {
 
   const entryPoints = ["./pkg/dist-src/index.js"];
 
-  await Promise.all([
-    // Build the a CJS Node.js bundle
-    esbuild.build({
-      entryPoints,
-      outdir: "pkg/dist-node",
-      bundle: true,
-      platform: "node",
-      target: "node18",
-      format: "cjs",
-      ...sharedOptions,
-    }),
-    // Build an ESM browser bundle
-    esbuild.build({
-      entryPoints,
-      outdir: "pkg/dist-web",
-      bundle: true,
-      platform: "browser",
-      format: "esm",
-      ...sharedOptions,
-    }),
-  ]);
-
   // Copy the README, LICENSE to the pkg folder
   await copyFile("LICENSE", "pkg/LICENSE");
   await copyFile("README.md", "pkg/README.md");
@@ -73,13 +51,15 @@ async function main() {
     JSON.stringify(
       {
         ...pkg,
-        files: ["dist-*/**", "bin/**"],
-        main: "dist-node/index.js",
-        browser: "dist-web/index.js",
-        types: "dist-types/index.d.ts",
-        module: "dist-src/index.js",
+        files: ["dist-*/**"],
+        exports: {
+          ".": {
+            types: "./dist-types/index.d.ts",
+            import: "./dist-src/index.js",
+          },
+        },
         sideEffects: false,
-        unpkg: "dist-web/index.js"
+        unpkg: "dist-src/index.js"
       },
       null,
       2

scripts/build.mjs

@@ -3,14 +3,14 @@ import type {
   GitHubAppOptions,
   OAuthAppResult,
   GitHubAppResult,
-} from "./types";
+} from "./types.js";
 export type {
   ClientType,
   OAuthAppOptions,
   GitHubAppOptions,
   OAuthAppResult,
   GitHubAppResult,
-} from "./types";
+} from "./types.js";
 
 export function oauthAuthorizationUrl(options: OAuthAppOptions): OAuthAppResult;
 export function oauthAuthorizationUrl(

src/index.ts

@@ -1,4 +1,5 @@
-import { oauthAuthorizationUrl } from "../src/index";
+import { oauthAuthorizationUrl } from "../src/index.js";
+import { jest } from "@jest/globals";
 
 beforeAll(() => {
   Math.random = jest.fn(() => 0.123);

test/index.test.ts

@@ -2,8 +2,7 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "emitDeclarationOnly": false,
-    "noEmit": true,
-    "verbatimModuleSyntax": false
+    "noEmit": true
   },
   "include": ["src/**/*"]
 }