fix: Rewrite build system using esbuild & tsc (#61)

Author: giraugh

.changeset/rare-llamas-refuse.md

@@ -0,0 +1,5 @@
+---
+"windpipe": patch
+---
+
+Fix typescript types for ESM default import

.github/workflows/release.yml

@@ -26,14 +26,17 @@ jobs:
         with:
           node-version: 20.x
 
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+
       - name: Install Dependencies
-        run: npm ci
+        run: pnpm i
 
       - name: Create release pull request or publish to npm
         id: changesets
         uses: changesets/action@v1
         with:
-          publish: npm run ci:release
+          publish: pnpm run ci:release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
@@ -59,10 +62,10 @@ jobs:
           node-version: 20.x
 
       - name: Install Dependencies
-        run: npm ci
+        run: pnpm ci
 
       - name: Generate Docs
-        run: npm run doc
+        run: pnpm run doc
 
       - name: Setup pages
         uses: actions/configure-pages@v4

.github/workflows/test-prs.yml

@@ -18,7 +18,11 @@ jobs:
       with:
         node-version: 20.x
         cache: 'npm'
-    - run: npm ci
-    - run: npm run build
-    - run: npm test
+
+    - name: Install pnpm
+      uses: pnpm/action-setup@v4
+
+    - run: pnpm i
+    - run: pnpm run build
+    - run: pnpm test
 

build.mjs

@@ -0,0 +1,41 @@
+import { build } from "esbuild";
+import { writeFile } from "node:fs/promises";
+
+const ENTRY = "src/index.ts";
+
+function buildEsm() {
+    return build({
+        entryPoints: [ENTRY],
+        outfile: "dist/index.js",
+        bundle: true,
+        platform: "node",
+        format: "esm",
+        target: "es2022",
+        sourcemap: true,
+        external: [], // put deps here if you don't want to bundle them
+    });
+}
+
+async function buildCjs() {
+    // Build using esm
+    await build({
+        entryPoints: [ENTRY],
+        outfile: "dist/core.cjs",
+        bundle: true,
+        platform: "node",
+        format: "cjs",
+        target: "es2022",
+        sourcemap: true,
+        external: [],
+    });
+
+    // Then build an entry point so we can get a nice default export
+    await writeFile(
+        "dist/index.cjs",
+        '"use strict";\nmodule.exports=require("./core.cjs").default;',
+    );
+
+    return writeFile("dist/index.d.cts", 'import Stream from "./index.js"; export = Stream;');
+}
+
+await Promise.all([buildEsm(), buildCjs()]);

package.json

@@ -6,10 +6,12 @@
   "scripts": {
     "lint": "tsc && eslint .",
     "format": "eslint --fix .",
-    "build": "tsup ./src/index.ts",
     "doc": "typedoc ./src --media ./media --plugin typedoc-plugin-extras --favicon ./media/logo.png --footerLastModified true --plugin typedoc-material-theme --themeColor '#03284e' --plugin typedoc-plugin-rename-defaults",
     "test": "vitest",
-    "ci:release": "npm run build && changeset publish"
+    "build": "rm -rf dist && pnpm run build:js && pnpm run build:types",
+    "build:js": "node build.mjs",
+    "build:types": "tsc -p tsconfig.types.json",
+    "ci:release": "pnpm run build && changeset publish"
   },
   "keywords": [],
   "files": [
@@ -20,14 +22,12 @@
   "types": "./dist/index.d.cts",
   "exports": {
     ".": {
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
+      "types": {
+        "import": "./dist/index.d.ts",
+        "require": "./dist/index.d.cts"
       },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
     }
   },
   "author": {
@@ -45,14 +45,13 @@
     "@eslint/js": "^9.0.0",
     "@types/highland": "^2.13.0",
     "@types/node": "^20.10.7",
+    "esbuild": "^0.27.3",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.3",
     "globals": "^15.0.0",
     "highland": "^2.13.5",
-    "npm-run-all": "^4.1.5",
     "prettier": "3.2.5",
-    "tsup": "^8.0.1",
     "typedoc": "^0.25.7",
     "typedoc-material-theme": "^1.0.2",
     "typedoc-plugin-extras": "^3.0.0",
@@ -64,16 +63,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "tsup": {
-    "format": [
-      "esm",
-      "cjs"
-    ],
-    "splitting": true,
-    "cjsInterop": true,
-    "dts": {
-      "footer": "export = Stream"
-    }
-  },
   "packageManager": "pnpm@8.14.0+sha1.bb42032ff80dba5f9245bc1b03470d2fa0b7fb2f"
 }