Separate npm and binary builds - publish JS bundle to npm, binaries to GitHub releases

Author: DanielFGray

.github/workflows/release.yml

@@ -7,6 +7,7 @@ on:
       - 'src/**'
       - 'package.json'
       - 'build.ts'
+      - 'build-npm.ts'
       - 'bun.lock'
   workflow_dispatch:
 
@@ -32,7 +33,10 @@ jobs:
       - name: Install dependencies
         run: bun install --frozen-lockfile
 
-      - name: Build all platforms
+      - name: Build for npm (JavaScript bundle)
+        run: bun run build:npm
+
+      - name: Build binaries for all platforms
         run: bun run build
 
       - name: Get version from package.json
@@ -47,13 +51,24 @@ jobs:
           body: |
             ## Effect DevTools Terminal UI
             
-            ### Installation
+            ### Installation via npm
             ```bash
             npm install -g effect-devtui
             effect-devtools
+            ```
+            
+            ### Or download binary directly
+            Download the binary for your platform below and run it directly.
+            
+            ```bash
+            # Linux x64
+            ./effect-devtools-linux-x64
+            
+            # macOS (Intel)
+            ./effect-devtools-darwin-x64
             
-            # Or run directly with bunx
-            bunx effect-devtui
+            # Windows
+            effect-devtools-windows-x64.exe
             ```
             
             Built from commit ${{ github.sha }}
@@ -74,6 +89,6 @@ jobs:
           registry-url: 'https://registry.npmjs.org'
 
       - name: Publish to npm
-        run: npm publish --access public
+        run: npm publish --access public --provenance
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

bin/effect-devtools

@@ -1,65 +1,13 @@
 #!/usr/bin/env node
 
-// Installer script for effect-devtools
-// Downloads the appropriate binary for the current platform
+// Entry point for effect-devtools npm package
+// Runs the bundled JavaScript version
 
-import { createRequire } from "module";
-import { platform, arch } from "os";
-import { existsSync } from "fs";
-import { join, dirname } from "path";
 import { fileURLToPath } from "url";
+import { dirname, join } from "path";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
-const require = createRequire(import.meta.url);
-const pkg = require("../package.json");
-
-// Map platform/arch to binary names
-const PLATFORMS = {
-  darwin: {
-    x64: "effect-devtools-darwin-x64",
-    arm64: "effect-devtools-darwin-arm64",
-  },
-  linux: {
-    x64: "effect-devtools-linux-x64",
-    arm64: "effect-devtools-linux-arm64",
-  },
-  win32: {
-    x64: "effect-devtools-windows-x64.exe",
-  },
-};
-
-const currentPlatform = platform();
-const currentArch = arch();
-
-const binaryName = PLATFORMS[currentPlatform]?.[currentArch];
-
-if (!binaryName) {
-  console.error(
-    `Unsupported platform: ${currentPlatform} ${currentArch}`
-  );
-  console.error("Supported platforms:");
-  console.error(JSON.stringify(PLATFORMS, null, 2));
-  process.exit(1);
-}
-
-const binaryPath = join(__dirname, "..", "dist", binaryName.replace(".exe", ""), binaryName);
-
-if (!existsSync(binaryPath)) {
-  console.error(`Binary not found: ${binaryPath}`);
-  console.error("Please report this issue at:");
-  console.error(pkg.bugs.url);
-  process.exit(1);
-}
-
-// Re-export the binary
-import { spawn } from "child_process";
-
-const child = spawn(binaryPath, process.argv.slice(2), {
-  stdio: "inherit",
-});
-
-child.on("exit", (code) => {
-  process.exit(code || 0);
-});
+// Import and run the bundled app
+await import(join(__dirname, "..", "dist", "index.js"));

build-npm.ts

@@ -0,0 +1,44 @@
+#!/usr/bin/env bun
+
+import solidPlugin from "@opentui/solid/bun-plugin"
+import path from "path"
+import { fileURLToPath } from "url"
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+process.chdir(__dirname)
+
+import pkg from "./package.json"
+
+console.log("Building for npm publish...")
+
+await Bun.$`rm -rf dist`
+await Bun.$`mkdir -p dist`
+
+// Build a JavaScript bundle for npm (not a binary)
+const result = await Bun.build({
+  conditions: ["browser"],
+  tsconfig: "./tsconfig.json",
+  plugins: [solidPlugin],
+  sourcemap: "external",
+  target: "node",
+  minify: false,
+  entrypoints: ["./src/index.tsx"],
+  outdir: "./dist",
+  format: "esm",
+  define: {
+    VERSION: `'${pkg.version}'`,
+  },
+})
+
+if (!result.success) {
+  console.error("Build failed:")
+  for (const log of result.logs) {
+    console.error(log)
+  }
+  process.exit(1)
+}
+
+console.log("NPM build complete!")
+console.log("Output: dist/index.js")

package.json

@@ -21,6 +21,7 @@
   "scripts": {
     "dev": "bun --watch --conditions=browser src/index.tsx",
     "build": "./build.ts",
+    "build:npm": "./build-npm.ts",
     "build:single": "./build.ts --single",
     "start": "bun --conditions=browser src/index.tsx"
   },