bun.sh support

[saada]

What version of Remix are you using?

❯ create-remix --version 1.6.5

Steps to Reproduce

❯ bun --version
0.1.5
> bun run create-remix --template remix-run/indie-stack blog-tutorial
? TypeScript or JavaScript? TypeScript
? Do you want me to run `bun install`? Yes
⠦ Creating your app…error: Script not found "config"
Command failed: bun config get @remix-run:registry
error: Script not found "config"

error "create-remix" exited with 1 status

Looks like bun does not support the config command.

Expected Behavior

I expected remix to just work.

Actual Behavior

bun config does not exist as a command. We'll need to either skip that step or find another way?

Skipping this step and running bun install manually seems to be the workaround

? Do you want me to run `bun install`? No

[machour]

FYI, some work have been done (https://twitter.com/ebey_jacob/status/1544475779337048066) but no full support yet.

[djhi]

In case someone is wondering if it works now, I just started to use bun on a small remix project with tailwind, prisma & supabase among other things. Works flawlessly

edit: watch mode does not work

[MariaZentsova]

How did you install remix with bun? I run bun run create-remix and it's not working for me ..

[machour]

Converting this to a Proposal discussion, as per our Development Process.

[electromidz]

Some one have suggestion for this issue ?!
I want to create this remix with bun version 0.5.9 and I think have problem with that ...

[selbekk]

Now that Bun is in a stable 1.0 – what thoughts have been made to support running Remix on it?

[sergiodxa]

The problem is you're using Remix App Server, this one is using renderToPipeableStream because it's intended to work on Node, not Bun or Cloudflare.

So you need to change this in the entry.server.

[sergiodxa]

The main issue is that ReactDOM should expose renderToReadableStream to Node because ReadableStream is a thing now in Node, and that way the same code will work everywhere.

[eddyw]

If anyone (like me) finds themselves here:

-import { renderToPipeableStream } from "react-dom/server";
+import { renderToPipeableStream } from "react-dom/server.node";

In entry.server.tsx 😅

[danestves]

@eddyw from my side it keeps telling me that is using the browser version, what else did you do? 👀

[eddyw]

@danestves This is all things I changed:

server.mjs

import { createRequestHandler } from "@remix-run/express";
import { broadcastDevReady } from "@remix-run/node";
import express from "express";

let build = await import("./build/index.js");

const app = express();
app.use(express.static("public"));

const remix = createRequestHandler({
  build,
  mode: build.mode,
});

app.all("*", remix);

app.listen(3000, () => {
	if (process.env.NODE_ENV === "development") {
		broadcastDevReady(build);
	}
	console.log("App listening on http://localhost:3000");
});

entry.server.tsx

import { PassThrough } from "node:stream";
import type { AppLoadContext, EntryContext } from "@remix-run/node";
import { createReadableStreamFromReadable } from "@remix-run/node";
import { RemixServer } from "@remix-run/react";
// @ts-ignore
-import { renderToPipeableStream } from "react-dom/server";
+import { renderToPipeableStream } from "react-dom/server.node";
...

package.json

...
  "scripts": {
    "build": "NODE_ENV=production bunx --bun remix build",
    "build:dev": "NODE_ENV=development bunx --bun remix build",
    "start:bun": "NODE_ENV=production bun ./server.mjs",
    "start:node": "NODE_ENV=production node ./server.mjs",
    "dev": "bunx --bun remix dev"
  },
...

remix.config.js

export default {
  ignoredRouteFiles: ["**/.*"],
  serverModuleFormat: "esm",
  dev: {
    manual: true,
    command: "bun --hot ./server.mjs",
  }
};

When in doubt, because prev build or cache has caused issues for me before when changing stuff (e.g entry server):

# rm -rf .cache/
# rm -rf build/
# bun dev

[maranomynet]

Really hope I can someday run Remix on Bun, without needing to have Node installed on the side, and without having to use a custom (entry.)server setup. (I'm currently converting a project away from bun back to node+yarn+vitest to reduce the number of workarounds and engine jumps required, until things get resolved.)

@sergiodxa you talk about an issue with ReactDOM and that the dev build scripts are "mostly working".

Do you know if the React team have any plans to revolse their bit?

And is there any work planned on resolving the Remix dev build scripts?

[sergiodxa]

I don't think using Bun to build the app is a priority for the team, just using it to run the app. In theory since Bun has a bundler it should be possible to create a Bun plugin for Remix similar to the Vite plugin for Remix so you can directly use that, but then you will have to be sure to keep up with official changes to the Vite plugin to keep compatibility.

[maranomynet]

I see.
I was just surprised to find that the normal Vite plugin doesn't "just work" – since Bun aims to be drop-in compatible with Node.

So I don't think we should need a whole separate Bun vite plugin, rather to see what needs to tweaked so it doesn't break.
I can't tell if it's a Bun issue, or Remix/Vite issue.
Next.js supposedly "just works" on bun.

[sergiodxa]

Next.js supposedly "just works" on bun

But what works? Does the compiler just work or the runtime? Because Remix runtime also just works, you only need Node for the build, but your app can run using Bun, I have tried it before, even the Bun HTTP server work with a simple adapter.

Also doing bun run build to run next build doesn't necessarily run with Bun, it's just using Bun as a replacement of npm, the only way to really be sure everything works is to don't have Node installed when running it.

[maranomynet]

If you add the --bun argument (after the run keyword) bun supposedly replaces the node shebang with the path to bun.

So in that case node should be out of the picture, unless the script spawns child processes that envoke node explicitly.

[maranomynet]

But you are right, the claim that Next works with bun, might indeed have this invisible asterisk next to it.

I haven't tried it myself. Been too busy playing with Remix. 😅