Migrate superflare and @superflare/remix from remix v2 → react-router v7

.github/workflows/publish-snapshot.yml

@@ -9,7 +9,7 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v2
 
-      - run: corepack enable
+      - run: npm install -g corepack@latest && corepack enable
       - uses: actions/setup-node@v4
         with:
           node-version: 20

apps/site/.env.example

@@ -1,3 +1,4 @@
 DOCSEARCH_APP_ID=RETR9S9VHS
 DOCSEARCH_API_KEY=326c1723a310dfe29004b47608709907
 DOCSEARCH_INDEX_NAME=tailwindui-protocol
+GITHUB_TOKEN=foo

apps/site/.gitignore

@@ -39,5 +39,5 @@ node_modules
 /public/build
 .env
 /.wrangler
-
+.react-router/
 .dev.vars

apps/site/app/components/Button.tsx

@@ -1,4 +1,4 @@
-import { Link } from "@remix-run/react";
+import { Link } from "react-router";
 import clsx from "clsx";
 
 const styles = {

apps/site/app/components/Layout.tsx

@@ -1,5 +1,5 @@
 import { useCallback, useEffect, useState } from "react";
-import { Link, useLocation } from "@remix-run/react";
+import { Link, useLocation } from "react-router";
 import clsx from "clsx";
 
 import { Hero } from "~/components/Hero";

apps/site/app/components/MobileNavigation.tsx

@@ -1,5 +1,5 @@
 import { useEffect, useState } from "react";
-import { Link, useNavigation } from "@remix-run/react";
+import { Link, useNavigation } from "react-router";
 import { Dialog } from "@headlessui/react";
 
 import { Logomark } from "~/components/Logo";

apps/site/app/components/Navigation.tsx

@@ -1,4 +1,4 @@
-import { Link, useLocation } from "@remix-run/react";
+import { Link, useLocation } from "react-router";
 import clsx from "clsx";
 import { Manifest } from "~/docs.server";
 

apps/site/app/components/QuickLinks.jsx

@@ -1,4 +1,4 @@
-import { Link } from "@remix-run/react";
+import { Link } from "react-router";
 
 import { Icon } from "./Icon";
 

apps/site/app/components/Search.tsx

@@ -1,6 +1,6 @@
 import { useCallback, useEffect, useState } from "react";
 import { createPortal } from "react-dom";
-import { Link, useNavigate } from "@remix-run/react";
+import { Link, useNavigate } from "react-router";
 import { DocSearchModal, useDocSearchKeyboardEvents } from "@docsearch/react";
 
 function Hit({ hit, children }: { hit: any; children: any }) {

apps/site/app/entry.server.tsx

@@ -0,0 +1,51 @@
+/**
+ * By default, Remix will handle generating the HTTP Response for you.
+ * You are free to delete this file if you'd like to, but if you ever want it revealed again, you can run `npx remix reveal` ✨
+ * For more information, see https://remix.run/file-conventions/entry.server
+ */
+
+import { isbot } from "isbot";
+import { renderToReadableStream } from "react-dom/server";
+import {
+  type AppLoadContext,
+  type EntryContext,
+  ServerRouter,
+} from "react-router";
+
+export default async function handleRequest(
+  request: Request,
+  responseStatusCode: number,
+  responseHeaders: Headers,
+  routerContext: EntryContext
+) {
+  let shellRendered = false;
+  const userAgent = request.headers.get("user-agent");
+
+  const body = await renderToReadableStream(
+    <ServerRouter context={routerContext} url={request.url} />,
+    {
+      onError(error: unknown) {
+        responseStatusCode = 500;
+        // Log streaming rendering errors from inside the shell.  Don't log
+        // errors encountered during initial shell rendering since they'll
+        // reject and get logged in handleDocumentRequest.
+        if (shellRendered) {
+          console.error(error);
+        }
+      },
+    }
+  );
+  shellRendered = true;
+
+  // Ensure requests from bots and SPA Mode renders wait for all content to load before responding
+  // https://react.dev/reference/react-dom/server/renderToPipeableStream#waiting-for-all-content-to-load-for-crawlers-and-static-generation
+  if ((userAgent && isbot(userAgent)) || routerContext.isSpaMode) {
+    await body.allReady;
+  }
+
+  responseHeaders.set("Content-Type", "text/html");
+  return new Response(body, {
+    headers: responseHeaders,
+    status: responseStatusCode,
+  });
+}

apps/site/app/root.tsx

@@ -1,21 +1,19 @@
 import {
-  json,
   type LinksFunction,
   type MetaFunction,
-  type LoaderFunctionArgs,
-} from "@remix-run/cloudflare";
-import {
   Links,
   Meta,
   Outlet,
   Scripts,
   ScrollRestoration,
   useLoaderData,
-} from "@remix-run/react";
+} from "react-router";
 import "@docsearch/css";
 import "focus-visible";
 import "./styles/tailwind.css";
 
+import type { Route } from "./routes/+types/_index";
+
 export const meta: MetaFunction = () => [
   { title: "Superflare", "twitter:title": "Superflare" },
   { viewport: "width=device-width,initial-scale=1" },
@@ -45,14 +43,14 @@ export const links: LinksFunction = () => [
   },
 ];
 
-export async function loader({ context: { cloudflare } }: LoaderFunctionArgs) {
-  return json({
+export async function loader({ context: { cloudflare } }: Route.LoaderArgs) {
+  return {
     ENV: {
       DOCSEARCH_APP_ID: cloudflare.env.DOCSEARCH_APP_ID,
       DOCSEARCH_API_KEY: cloudflare.env.DOCSEARCH_API_KEY,
       DOCSEARCH_INDEX_NAME: cloudflare.env.DOCSEARCH_INDEX_NAME,
     },
-  });
+  };
 }
 
 const themeScript = `

apps/site/app/routes.ts

@@ -0,0 +1,4 @@
+import { type RouteConfig } from "@react-router/dev/routes";
+import { flatRoutes } from "@react-router/fs-routes";
+
+export default flatRoutes() satisfies RouteConfig;

apps/site/app/routes/$.tsx

@@ -1,4 +1,4 @@
-import { MetaFunction } from "@remix-run/react/dist/routeModules";
+import { type MetaFunction } from "react-router";
 
 import { loader as indexLoader } from "./_index";
 
@@ -7,9 +7,7 @@ export { default } from "./_index";
 export const loader = indexLoader;
 
 export const meta: MetaFunction<typeof loader> = ({ data }) => [
-  {
-    title: data?.title ? `${data.title} - Superflare` : "Superflare",
-  },
+  { title: data?.title ? `${data.title} - Superflare` : "Superflare" },
   {
     "twitter:title": data?.title ? `${data.title} - Superflare` : "Superflare",
   },

apps/site/app/routes/_index.tsx

@@ -1,18 +1,16 @@
-import {
-  json,
-  type LoaderFunctionArgs,
-  type MetaFunction,
-} from "@remix-run/cloudflare";
-import { useLoaderData } from "@remix-run/react";
+import { type MetaFunction } from "react-router";
+import { useLoaderData } from "react-router";
 import { Layout } from "~/components/Layout";
 import { getManifest, getMarkdownForPath, parseMarkdoc } from "~/docs.server";
 import { renderMarkdoc } from "~/markdoc";
 
+import type { Route } from "./+types/_index";
+
 export async function loader({
   params,
   context: { cloudflare },
-}: LoaderFunctionArgs) {
-  const path = params["*"] ?? ("index" as string);
+}: Route.LoaderArgs) {
+  const path = params["*"] ?? "index";
 
   const useGitHub = process.env.NODE_ENV === "production";
   const markdown = await getMarkdownForPath(
@@ -34,7 +32,7 @@ export async function loader({
   const { content, title, tableOfContents, description } =
     parseMarkdoc(markdown);
 
-  return json({ content, title, tableOfContents, manifest, description });
+  return { content, title, tableOfContents, manifest, description };
 }
 
 export const meta: MetaFunction<typeof loader> = ({ data }) => [

apps/site/load-context.ts

@@ -7,8 +7,10 @@ type Cloudflare = Omit<PlatformProxy<Env>, "dispose" | "caches"> & {
   caches: CacheStorage;
 };
 
-declare module "@remix-run/cloudflare" {
+declare module "react-router" {
   interface AppLoadContext {
     cloudflare: Cloudflare;
   }
 }
+
+export {}; // necessary for TS to treat this as a module

apps/site/package.json

@@ -4,23 +4,23 @@
   "type": "module",
   "private": true,
   "scripts": {
-    "build": "remix vite:build",
+    "build": "react-router build",
     "deploy": "wrangler deploy",
-    "dev:remix": "remix vite:dev",
+    "dev:remix": "react-router dev",
     "dev:docs": "node ./scripts/serve-local-docs.mjs",
     "dev": "concurrently \"npm:dev:*\"",
     "start": "wrangler dev",
-    "typegen": "wrangler types",
-    "typecheck": "tsc"
+    "typegen": "wrangler types && react-router typegen",
+    "typecheck": "react-router typegen && tsc"
   },
   "browserslist": "defaults, not ie <= 11",
   "dependencies": {
     "@docsearch/css": "^3.8.0",
     "@docsearch/react": "^3.8.0",
     "@headlessui/react": "^2.1.2",
     "@markdoc/markdoc": "0.4.0",
-    "@remix-run/cloudflare": "^2.12.1",
-    "@remix-run/react": "^2.12.1",
+    "@react-router/cloudflare": "^7.0.0",
+    "@react-router/fs-routes": "^7.0.0",
     "@sindresorhus/slugify": "^2.1.1",
     "@tailwindcss/typography": "^0.5.8",
     "autoprefixer": "^10.4.19",
@@ -33,13 +33,13 @@
     "prism-react-renderer": "^2.3.1",
     "react": "18.2.0",
     "react-dom": "18.2.0",
+    "react-router": "^7.0.0",
     "tailwindcss": "^3.4.4",
     "tiny-invariant": "^1.3.1"
   },
   "devDependencies": {
-    "@cloudflare/workers-types": "^4.20241011.0",
-    "@remix-run/dev": "^2.12.1",
-    "@remix-run/eslint-config": "^2.12.1",
+    "@cloudflare/workers-types": "^4.20250109.0",
+    "@react-router/dev": "^7.0.0",
     "@types/js-yaml": "^4.0.5",
     "@types/react": "^18.0.28",
     "@types/react-dom": "^18.0.11",

apps/site/react-router.config.ts

@@ -0,0 +1,3 @@
+import { type Config } from "@react-router/dev/config";
+
+export default { ssr: true } satisfies Config;

apps/site/tsconfig.json

@@ -1,8 +1,18 @@
 {
-  "include": ["worker-configuration.d.ts", "**/*.ts", "**/*.tsx"],
+  "include": [
+    "worker-configuration.d.ts",
+    "**/*.ts",
+    "**/*.tsx",
+    ".react-router/types/**/*"
+  ],
   "compilerOptions": {
     "lib": ["DOM", "DOM.Iterable", "ES2022"],
-    "types": ["@remix-run/cloudflare", "vite/client"],
+    "types": [
+      "@cloudflare/workers-types",
+      "@react-router/cloudflare",
+      "vite/client"
+    ],
+    "rootDirs": [".", "./.react-router/types"],
     "isolatedModules": true,
     "esModuleInterop": true,
     "jsx": "react-jsx",
@@ -18,7 +28,7 @@
       "~/*": ["./app/*"]
     },
 
-    // Remix takes care of building everything in `remix build`.
+    // React router takes care of building everything in `react-router build`.
     "noEmit": true
   }
 }

apps/site/vite.config.ts

@@ -1,23 +1,10 @@
+import { reactRouter } from "@react-router/dev/vite";
+import { cloudflareDevProxy } from "@react-router/dev/vite/cloudflare";
 import { defineConfig } from "vite";
-import {
-  vitePlugin as remix,
-  cloudflareDevProxyVitePlugin,
-} from "@remix-run/dev";
 import tsconfigPaths from "vite-tsconfig-paths";
 
 export default defineConfig({
-  plugins: [
-    cloudflareDevProxyVitePlugin(),
-    remix({
-      future: {
-        v3_fetcherPersist: true,
-        v3_lazyRouteDiscovery: true,
-        v3_relativeSplatPath: true,
-        v3_throwAbortReason: true,
-      },
-    }),
-    tsconfigPaths(),
-  ],
+  plugins: [cloudflareDevProxy(), reactRouter(), tsconfigPaths()],
   ssr: {
     noExternal: ["@docsearch/react", "@markdoc/markdoc"],
     resolve: {

apps/site/worker-configuration.d.ts

@@ -4,4 +4,5 @@ interface Env {
 	DOCSEARCH_APP_ID: string;
 	DOCSEARCH_API_KEY: string;
 	DOCSEARCH_INDEX_NAME: string;
+	GITHUB_TOKEN: string;
 }

apps/site/worker.ts

@@ -1,10 +1,10 @@
-import { createRequestHandler, type ServerBuild } from "@remix-run/cloudflare";
+import { createRequestHandler, type ServerBuild } from "react-router";
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore This file won’t exist if it hasn’t yet been built
 import * as build from "./build/server"; // eslint-disable-line import/no-unresolved
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-const handleRemixRequest = createRequestHandler(build as any as ServerBuild);
+const handleRequest = createRequestHandler(build as any as ServerBuild);
 
 export default {
   async fetch(request, env, ctx) {
@@ -15,7 +15,7 @@ export default {
           // `getPlatformProxy` used during development via Remix's
           // `cloudflareDevProxyVitePlugin`:
           // https://developers.cloudflare.com/workers/wrangler/api/#getplatformproxy
-          cf: request.cf,
+          cf: request.cf!,
           ctx: {
             passThroughOnException: ctx.passThroughOnException.bind(ctx),
             waitUntil: ctx.waitUntil.bind(ctx),
@@ -24,7 +24,7 @@ export default {
           env,
         },
       };
-      return await handleRemixRequest(request, loadContext);
+      return await handleRequest(request, loadContext);
     } catch (error) {
       console.log(error);
       return new Response("An unexpected error occurred", { status: 500 });

examples/remix-cms/.eslintrc.js

@@ -1,4 +1,4 @@
 /** @type {import('eslint').Linter.Config} */
 module.exports = {
-  extends: ["@remix-run/eslint-config", "@remix-run/eslint-config/node"],
+  extends: [],
 };

examples/remix-cms/.gitignore

@@ -7,3 +7,4 @@ node_modules
 .env
 /.wrangler
 superflare.env.d.ts
+.react-router/

examples/remix-cms/app/components/admin/Button.tsx

@@ -1,4 +1,4 @@
-import { Link } from "@remix-run/react";
+import { Link } from "react-router";
 import clsx from "clsx";
 
 export function Button({