fix(build): switch to esbuild (#161)

Switch to esbuild

Author: kfcampbell

package-lock.json

@@ -6,9 +6,9 @@
   "version": "0.0.0-development",
   "description": "Octokit authentication strategy for OAuth clients",
   "scripts": {
-    "build": "pika-pack build",
-    "lint": "prettier --check '{src,test}/**/*' README.md package.json",
-    "lint:fix": "prettier --write '{src,test}/**/*' README.md package.json",
+    "build": "node scripts/build.mjs && tsc -p tsconfig.json",
+    "lint": "prettier --check '{src,test,scripts}/**/*' README.md package.json",
+    "lint:fix": "prettier --write '{src,test,scripts}/**/*' README.md package.json",
     "pretest": "npm run -s lint",
     "test": "jest --coverage"
   },
@@ -31,15 +31,13 @@
   },
   "devDependencies": {
     "@octokit/core": "^4.0.0",
-    "@octokit/tsconfig": "^1.0.2",
-    "@pika/pack": "^0.5.0",
-    "@pika/plugin-build-node": "^0.9.2",
-    "@pika/plugin-build-web": "^0.9.2",
-    "@pika/plugin-ts-standard-pkg": "^0.9.2",
+    "@octokit/tsconfig": "^2.0.0",
     "@types/btoa-lite": "^1.0.0",
     "@types/jest": "^29.0.0",
     "@types/node": "^18.0.0",
+    "esbuild": "^0.17.19",
     "fetch-mock": "^9.11.0",
+    "glob": "^10.2.7",
     "jest": "^29.0.0",
     "mockdate": "^3.0.4",
     "prettier": "2.8.8",
@@ -50,7 +48,14 @@
   },
   "peerDependencies": {},
   "jest": {
-    "preset": "ts-jest",
+    "transform": {
+      "^.+\\.(ts|tsx)$": [
+        "ts-jest",
+        {
+          "tsconfig": "test/tsconfig.test.json"
+        }
+      ]
+    },
     "coverageThreshold": {
       "global": {
         "statements": 100,
@@ -60,22 +65,6 @@
       }
     }
   },
-  "@pika/pack": {
-    "pipeline": [
-      [
-        "@pika/plugin-ts-standard-pkg"
-      ],
-      [
-        "@pika/plugin-build-node",
-        {
-          "minNodeVersion": "14"
-        }
-      ],
-      [
-        "@pika/plugin-build-web"
-      ]
-    ]
-  },
   "release": {
     "branches": [
       "+([0-9]).x",

package.json

@@ -0,0 +1,88 @@
+import esbuild from "esbuild";
+import { copyFile, readFile, writeFile, rm } from "node:fs/promises";
+import { glob } from "glob";
+
+const sharedOptions = {
+  sourcemap: "external",
+  sourcesContent: true,
+  minify: false,
+  allowOverwrite: true,
+  packages: "external",
+};
+
+async function main() {
+  // Start with a clean slate
+  await rm("pkg", { recursive: true, force: true });
+  // Build the source code for a neutral platform as ESM
+  await esbuild.build({
+    entryPoints: await glob(["./src/*.ts", "./src/**/*.ts"]),
+    outdir: "pkg/dist-src",
+    bundle: false,
+    platform: "neutral",
+    format: "esm",
+    ...sharedOptions,
+    sourcemap: false,
+  });
+
+  // Remove the types file from the dist-src folder
+  const typeFiles = await glob([
+    "./pkg/dist-src/**/types.js.map",
+    "./pkg/dist-src/**/types.js",
+  ]);
+  for (const typeFile of typeFiles) {
+    await rm(typeFile);
+  }
+
+  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: "node14",
+      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");
+
+  // Handle the package.json
+  let pkg = JSON.parse((await readFile("package.json", "utf8")).toString());
+  // Remove unnecessary fields from the package.json
+  delete pkg.scripts;
+  delete pkg.prettier;
+  delete pkg.release;
+  delete pkg.jest;
+  await writeFile(
+    "pkg/package.json",
+    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",
+        sideEffects: false,
+      },
+      null,
+      2
+    )
+  );
+}
+main();

scripts/build.mjs

@@ -1,4 +1,4 @@
-import {
+import type {
   OAuthAppAuthOptions,
   GitHubAppAuthOptions,
   OAuthAppAuthentication,

src/auth.ts

@@ -1,5 +1,5 @@
 import btoa from "btoa-lite";
-import {
+import type {
   EndpointOptions,
   EndpointDefaults,
   OctokitResponse,
@@ -8,7 +8,7 @@ import {
   Route,
 } from "@octokit/types";
 
-import { OAuthAppState, GitHubAppState } from "./types";
+import type { OAuthAppState, GitHubAppState } from "./types";
 import { auth } from "./auth";
 import { requiresBasicAuth } from "./requires-basic-auth";
 

src/hook.ts

@@ -4,15 +4,15 @@ import { request as octokitRequest } from "@octokit/request";
 import { VERSION } from "./version";
 import { auth } from "./auth";
 import { hook } from "./hook";
-import {
+import type {
   State,
   OAuthAppStrategyOptions,
   GitHubAppStrategyOptions,
   OAuthAppAuthInterface,
   GitHubAppAuthInterface,
 } from "./types";
 
-export {
+export type {
   OAuthAppStrategyOptionsWebFlow,
   GitHubAppStrategyOptionsWebFlow,
   OAuthAppStrategyOptionsDeviceFlow,

src/index.ts

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

test/tsconfig.test.json

@@ -1,5 +1,13 @@
 {
   "extends": "@octokit/tsconfig",
-  "include": ["src/**/*"],
-  "compilerOptions": { "esModuleInterop": true }
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "declaration": true,
+    "outDir": "pkg/dist-types",
+    "emitDeclarationOnly": true,
+    "sourceMap": true
+  },
+  "include": [
+    "src/**/*"
+  ]
 }