@brrock/oj 0.0.0-stage → 0.2.16

package/README.md

@@ -1,3 +1,55 @@
-# Temporary Holding Version
+# @brrock/oj
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Prebuilt Linux binaries of [oj](https://github.com/lovablelabs/oj) (lovablelabs' Rust frontend tooling), packaged for npm so it can run where you can't `cargo install`, like Vercel builds.
+
+Upstream oj only ships to crates.io. This repo builds it from source for each oj release and publishes:
+
+| package | contents |
+|---|---|
+| `@brrock/oj` | the `oj` command (a small Node launcher) |
+| `@brrock/oj-linux-x64-gnu` | oj for Linux x64, glibc ≥ 2.34 |
+| `@brrock/oj-linux-arm64-gnu` | oj for Linux arm64, glibc ≥ 2.34 |
+
+npm installs only the platform package that matches the machine. Binaries are built inside `amazonlinux:2023`, which is Vercel's build image.
+
+## Use on Vercel
+
+```sh
+npm i -D @brrock/oj
+```
+
+```json
+{
+  "scripts": {
+    "build": "oj build"
+  }
+}
+```
+
+Set the Vercel project's output directory to `dist`. Versions match upstream oj versions.
+
+Only Linux is supported. On macOS/Windows install oj with `cargo install oj --locked`; you can point the launcher at any binary with `OJ_BINARY_PATH=/path/to/oj`.
+
+`@brrock/oj` depends on `rolldown@1.2.1` and sets `OJ_VENDORED_ROLLDOWN` to it, the same rolldown the upstream nix build vendors for oj's TanStack Start bundles. Set `OJ_VENDORED_ROLLDOWN=` (empty) to use the app's own rolldown instead.
+
+## How releases work
+
+`.github/workflows/release.yml` runs every 6 hours. When the latest `lovablelabs/oj` release isn't on npm yet, it:
+
+1. builds `oj` for x64 and arm64 in `amazonlinux:2023` (fat-LTO release build, so expect 1–2 hours),
+2. publishes the platform packages, then `@brrock/oj`, through npm trusted publishing (OIDC). Provenance is attached automatically and no npm token is stored.
+
+To build a specific version by hand: `make release VERSION=0.2.16`.
+
+## One-time setup
+
+You need npm ≥ 11.10 (for `npm trust`) and 2FA enabled on your npm account.
+
+```sh
+make login     # npm login
+make setup     # publishes empty 0.0.0 placeholders, then trusts release.yml for each package
+make release   # build + publish the latest oj
+make watch     # follow the run
+```
+
+Trusted publishing can only be configured on packages that already exist, which is why `setup` publishes placeholders first. Optionally run `make lockdown` afterwards to block token-based publishes.

package/bin/oj.js

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+"use strict";
+
+const { spawnSync } = require("child_process");
+const { binaryPath, vendoredRolldownDir } = require("..");
+
+let bin;
+try {
+  bin = binaryPath();
+} catch (e) {
+  console.error(e.message);
+  process.exit(1);
+}
+
+const env = { ...process.env };
+if (env.OJ_VENDORED_ROLLDOWN === undefined) {
+  const dir = vendoredRolldownDir();
+  if (dir) env.OJ_VENDORED_ROLLDOWN = dir;
+}
+
+const result = spawnSync(bin, process.argv.slice(2), { stdio: "inherit", env });
+if (result.error) {
+  console.error(`@brrock/oj: failed to run ${bin}: ${result.error.message}`);
+  process.exit(1);
+}
+if (result.signal) process.kill(process.pid, result.signal);
+process.exit(result.status ?? 1);

package/index.js

@@ -0,0 +1,62 @@
+"use strict";
+
+const fs = require("fs");
+const path = require("path");
+
+const PLATFORMS = {
+  "linux-x64": "@brrock/oj-linux-x64-gnu",
+  "linux-arm64": "@brrock/oj-linux-arm64-gnu",
+};
+
+/** Absolute path to the oj binary for this machine. Throws if unsupported. */
+function binaryPath() {
+  if (process.env.OJ_BINARY_PATH) return process.env.OJ_BINARY_PATH;
+
+  const key = `${process.platform}-${process.arch}`;
+  const pkg = PLATFORMS[key];
+  if (!pkg) {
+    throw new Error(
+      `@brrock/oj: no prebuilt oj for ${key}. Supported: ${Object.keys(PLATFORMS).join(", ")}.\n` +
+        "On other platforms install oj with `cargo install oj --locked` and set OJ_BINARY_PATH.",
+    );
+  }
+
+  let bin;
+  try {
+    bin = require.resolve(`${pkg}/bin/oj`);
+  } catch {
+    throw new Error(
+      `@brrock/oj: the platform package "${pkg}" is not installed.\n` +
+        "It is an optionalDependency; make sure optional dependencies are not omitted " +
+        "(--omit=optional / --no-optional) and that your lockfile was not created on a different platform only.",
+    );
+  }
+
+  // npm normally keeps the exec bit, but some installers/caches drop it.
+  try {
+    fs.accessSync(bin, fs.constants.X_OK);
+  } catch {
+    try {
+      fs.chmodSync(bin, 0o755);
+    } catch {}
+  }
+  return bin;
+}
+
+/**
+ * Directory holding node_modules/rolldown, for OJ_VENDORED_ROLLDOWN: oj runs
+ * its own TanStack Start bundles on the rolldown it was tested against
+ * (the upstream nix build vendors it the same way). Returns undefined if
+ * rolldown can't be found, in which case oj falls back to the app's copy.
+ */
+function vendoredRolldownDir() {
+  try {
+    const pkgJson = fs.realpathSync(require.resolve("rolldown/package.json"));
+    // .../<dir>/node_modules/rolldown/package.json -> <dir>
+    return path.dirname(path.dirname(path.dirname(pkgJson)));
+  } catch {
+    return undefined;
+  }
+}
+
+module.exports = { binaryPath, vendoredRolldownDir };

package/package.json

@@ -1,6 +1,36 @@
 {
   "name": "@brrock/oj",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.16",
+  "description": "Prebuilt Linux binaries of oj (lovablelabs/oj), e.g. for running oj on Vercel",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/brrock/oj-builds.git"
+  },
+  "homepage": "https://github.com/lovablelabs/oj",
+  "keywords": [
+    "oj",
+    "vite",
+    "bundler",
+    "vercel"
+  ],
+  "bin": {
+    "oj": "bin/oj.js"
+  },
+  "main": "index.js",
+  "files": [
+    "bin",
+    "index.js",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "rolldown": "1.2.1"
+  },
+  "optionalDependencies": {
+    "@brrock/oj-linux-x64-gnu": "0.2.16",
+    "@brrock/oj-linux-arm64-gnu": "0.2.16"
+  }
+}