feat: package is now ESM

BREAKING CHANGE: package is now ESM
octokit · Feb 25, 2024 · 80ed2fe · 80ed2fe
1 parent 8426abb
commit 80ed2fe
Show file tree

Hide file tree

Showing 8 changed files with 44 additions and 68 deletions.
diff --git a/README.md b/README.md
@@ -69,7 +69,8 @@ Install with `npm install @octokit/oauth-app`
 ### For OAuth Apps
 
 ```js
-const { OAuthApp, createNodeMiddleware } = require("@octokit/oauth-app");
+import { OAuthApp, createNodeMiddleware } from "@octokit/oauth-app";
+import { createServer } from "node:http";
 
 const app = new OAuthApp({
   clientType: "oauth-app",
@@ -82,7 +83,7 @@ app.on("token", async ({ token, octokit }) => {
   console.log(`Token retrieved for ${data.login}`);
 });
 
-require("http").createServer(createNodeMiddleware(app)).listen(3000);
+createServer(createNodeMiddleware(app)).listen(3000);
 // can now receive user authorization callbacks at /api/github/oauth/callback
 // See all endpoints at https://github.com/octokit/oauth-app.js#middlewares
 ```
@@ -92,7 +93,8 @@ require("http").createServer(createNodeMiddleware(app)).listen(3000);
 GitHub Apps do not support `scopes`. If the GitHub App has expiring user tokens enabled, the token used for the `octokit` instance will be refreshed automatically, and the additional refresh-related properties will be passed to the `"token"` event handler.
 
 ```js
-const { OAuthApp, createNodeMiddleware } = require("@octokit/oauth-app");
+import { OAuthApp, createNodeMiddleware } from "@octokit/oauth-app";
+import { createServer } from "node:http";
 
 const app = new OAuthApp({
   clientType: "github-app",
@@ -105,7 +107,7 @@ app.on("token", async ({ token, octokit, expiresAt }) => {
   console.log(`Token retrieved for ${data.login}`);
 });
 
-require("http").createServer(createNodeMiddleware(app)).listen(3000);
+createServer(createNodeMiddleware(app)).listen(3000);
 // can now receive user authorization callbacks at /api/github/oauth/callback
 // See all endpoints at https://github.com/octokit/oauth-app.js#middlewares
 ```
@@ -239,7 +241,7 @@ You can pass in your own Octokit constructor with custom defaults and plugins. T
 For usage with enterprise, set `baseUrl` to the hostname + `/api/v3`. Example:
 
 ```js
-const { Octokit } = require("@octokit/core");
+import { Octokit } from "@octokit/core";
 new OAuthApp({
   clientId: "1234567890abcdef1234",
   clientSecret: "1234567890abcdef1234567890abcdef12345678",
@@ -895,7 +897,9 @@ By default, all middlewares expose the following routes
 Native http server middleware for Node.js
 
 ```js
-const { OAuthApp, createNodeMiddleware } = require("@octokit/oauth-app");
+import { OAuthApp, createNodeMiddleware } from "@octokit/oauth-app";
+import { createServer } from "node:http";
+
 const app = new OAuthApp({
   clientType: "oauth-app",
   clientId: "1234567890abcdef1234",
@@ -906,7 +910,7 @@ const middleware = createNodeMiddleware(app, {
   pathPrefix: "/api/github/oauth",
 });
 
-require("http").createServer(middleware).listen(3000);
+createServer(middleware).listen(3000);
 // can now receive user authorization callbacks at /api/github/oauth/callback
 ```
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,12 +2,13 @@
   "name": "@octokit/oauth-app",
   "version": "0.0.0-development",
   "description": "GitHub OAuth toolset for Node.js",
+  "type": "module",
   "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",
     "test:typescript": "npx tsc --noEmit --declaration --noUnusedLocals --allowImportingTsExtensions --moduleResolution node16 --module node16 test/typescript-validate.ts"
   },
   "repository": "github:octokit/oauth-app.js",
@@ -20,9 +21,9 @@
   "author": "Gregor Martynus (https://twitter.com/gr2m)",
   "license": "MIT",
   "dependencies": {
-    "@octokit/auth-oauth-app": "^8.0.0-beta.2",
-    "@octokit/auth-oauth-user": "^5.0.0",
-    "@octokit/auth-unauthenticated": "^5.0.0",
+    "@octokit/auth-oauth-app": "^8.0.0",
+    "@octokit/auth-oauth-user": "^5.0.1",
+    "@octokit/auth-unauthenticated": "^6.0.0-beta.1",
     "@octokit/core": "^6.0.0",
     "@octokit/oauth-authorization-url": "^7.0.0",
     "@octokit/oauth-methods": "^5.0.0",
@@ -45,11 +46,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
         }
       ]
     },

diff --git a/scripts/build.mjs b/scripts/build.mjs
@@ -46,7 +46,7 @@ async function main() {
     bundle: true,
     platform: "node",
     target: "node18",
-    format: "cjs",
+    format: "esm",
     ...sharedOptions,
   });
 
@@ -67,9 +67,12 @@ async function main() {
       {
         ...pkg,
         files: ["dist-*/**", "bin/**"],
-        main: "dist-node/index.js",
-        types: "dist-types/index.d.ts",
-        source: "dist-src/index.js",
+        exports: {
+          ".": {
+            types: "./dist-types/index.d.ts",
+            import: "./dist-node/index.js",
+          },
+        },
         sideEffects: false,
       },
       null,

diff --git a/test/app.test.ts b/test/app.test.ts
@@ -1,5 +1,6 @@
 import fetchMock from "fetch-mock";
 import { Octokit } from "@octokit/core";
+import { jest } from "@jest/globals";
 
 import { OAuthApp } from "../src/index.ts";
 import { OAuthAppOctokit } from "../src/oauth-app-octokit.ts";

diff --git a/test/node-middleware.test.ts b/test/node-middleware.test.ts
@@ -1,5 +1,6 @@
 import { createServer, IncomingMessage } from "node:http";
 import { URL } from "node:url";
+import { jest } from "@jest/globals";
 
 import { createNodeMiddleware, OAuthApp } from "../src/index.ts";
 

diff --git a/test/tsconfig.test.json b/test/tsconfig.test.json
@@ -3,7 +3,6 @@
   "compilerOptions": {
     "emitDeclarationOnly": false,
     "noEmit": true,
-    "verbatimModuleSyntax": false,
     "allowImportingTsExtensions": true
   },
   "include": ["src/**/*"]

diff --git a/test/web-worker-handler.test.ts b/test/web-worker-handler.test.ts
@@ -1,4 +1,5 @@
 import { URL } from "node:url";
+import { jest } from "@jest/globals";
 import { createWebWorkerHandler, OAuthApp } from "../src/index.ts";
 
 describe("createWebWorkerHandler(app)", () => {