Rebrand to react-adonisjs (#110)

Author: jarle

README.md

@@ -1,20 +1,20 @@
-# remix-adonisjs
+# react-adonisjs
 
 Sponsored by [SummYT.app](https://summyt.app)
 
-**remix-adonisjs** includes all the amazing features you love from Remix, plus support for production-grade:
+**react-adonisjs** (previously react-adonisjs) includes all the amazing features you love from React Router, plus support for production-grade:
 
 - Database ORM and migrations
 - Authentication
 - Router middleware
 - Mailer
 - Dependency injection
 
-...and much, much more from the AdonisJS 6 ecosystem. Read [the about section](https://matstack.dev/remix-adonisjs/about) if you want to learn more.
+...and much, much more from the AdonisJS 6 ecosystem. Read [the about section](https://matstack.dev/react-adonisjs/about) if you want to learn more.
 
 ## Quickstart
 
-Create a fresh remix-adonisjs project using the [React Router 7 starter template](https://github.com/jarle/remix-starter-kit)
+Create a fresh react-adonisjs project using the [React Router 7 starter template](https://github.com/jarle/remix-starter-kit)
 
 ```
 npm init adonisjs@latest -- -K="github:jarle/remix-starter-kit"
@@ -23,25 +23,25 @@ npm init adonisjs@latest -- -K="github:jarle/remix-starter-kit"
 You should now be able to start building.
 Just jump into your new folder and start the dev server with `npm run dev`.
 
-You can create new Remix routes with the command:
+You can create new React Router routes with the command:
 
 ```
-node ace remix:route my-route
+node ace react:route my-route
 ```
 
-There are flags for including Remix-specific functionality in the route.
+There are flags for including React Router-specific functionality in the route.
 Example for adding a server action:
 
 ```
-node ace remix:route --action my-route
+node ace react:route --action my-route
 ```
 
 Ready to build?
-Check out the guide on [how to set up a login flow](https://matstack.dev/remix-adonisjs/hands-on/building-a-login-flow) to get familiar with remix-adonisjs.
+Check out the guide on [how to set up a login flow](https://matstack.dev/react-adonisjs/hands-on/building-a-login-flow) to get familiar with react-adonisjs.
 
 ## Documentation
 
-Guides for remix-adonisjs can be found in the [official documentation](https://matstack.dev/remix-adonisjs/)
+Guides for react-adonisjs can be found in the [official documentation](https://matstack.dev/react-adonisjs/)
 
 For implementation details/reference, refer to the official documentation for the two frameworks:
 
@@ -50,18 +50,18 @@ For implementation details/reference, refer to the official documentation for th
 
 ## Discussion
 
-The recommended place to discuss remix-adonisjs is on [GitHub Discussions](https://github.com/jarle/remix-adonisjs/discussions).
+The recommended place to discuss react-adonisjs is on [GitHub Discussions](https://github.com/jarle/react-adonisjs/discussions).
 
 ## Contributing
 
 Contributions are _very_ welcome ❤️
 
 You can hack on the project by using the [reference application](./packages/reference-app/README.md) and its associated integrations tests.
 
-A good start is to check out issues marked with [help wanted](https://github.com/jarle/remix-adonisjs/labels/help%20wanted) and see if you can contribute either with code or your opinion/experience.
+A good start is to check out issues marked with [help wanted](https://github.com/jarle/react-adonisjs/labels/help%20wanted) and see if you can contribute either with code or your opinion/experience.
 
 Some other ideas for improvements:
 
-- [Documentation](https://github.com/jarle/remix-adonisjs-docs)
+- [Documentation](https://github.com/jarle/react-adonisjs-docs)
 - Ease of setup
 - Project structure

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@matstack/remix-adonisjs",
+  "name": "@matstack/react-adonisjs-monorepo",
   "private": true,
   "workspaces": [
     "packages/*"

packages/adapter/README.md

@@ -1 +1 @@
-# Remix AdonisJS
+# React Router AdonisJS

packages/adapter/commands/remix_route.ts renamed to packages/adapter/commands/react_router_route.ts

@@ -1,12 +1,9 @@
 import { BaseCommand, args, flags } from '@adonisjs/core/ace'
 import { stubsRoot } from '../index.js'
 
-/**
- * Create a remix route
- */
-export default class MakeRemixRoute extends BaseCommand {
-  static commandName = 'remix:route'
-  static description = 'Create a Remix route'
+export default class MakeReactRouterRoute extends BaseCommand {
+  static commandName = 'react:route'
+  static description = 'Create a React Router route module'
 
   @args.string({ description: 'The name of the route, without prefix' })
   declare name: string

packages/adapter/configure.ts

@@ -40,7 +40,7 @@ export async function configure(command: Configure) {
   await codemods.makeUsingStub(STUBS_ROOT, 'env.d.ts.stub', {})
 
   await codemods.updateRcFile((rcFile) => {
-    rcFile.addCommand('@matstack/remix-adonisjs/commands')
-    rcFile.addProvider('@matstack/remix-adonisjs/remix_provider')
+    rcFile.addCommand('@matstack/react-adonisjs/commands')
+    rcFile.addProvider('@matstack/react-adonisjs/react_router_provider')
   })
 }

packages/adapter/package.json

@@ -1,7 +1,7 @@
 {
-  "name": "@matstack/remix-adonisjs",
-  "description": "An adapter for using Remix with AdonisJS",
-  "version": "1.0.1",
+  "name": "@matstack/react-adonisjs",
+  "description": "An adapter for using React Router with AdonisJS",
+  "version": "1.0.2",
   "engines": {
     "node": ">=20.10.0"
   },
@@ -25,7 +25,7 @@
   "exports": {
     ".": "./build/index.js",
     "./commands": "./build/commands/main.js",
-    "./remix_provider": "./build/providers/remix_provider.js",
+    "./react_router_provider": "./build/providers/react_router_provider.js",
     "./build_hook": "./build/src/hooks/build_hook.js",
     "./types": "./build/src/types/main.js"
   },
@@ -95,12 +95,12 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/jarle/remix-adonisjs"
+    "url": "git+https://github.com/jarle/react-adonisjs"
   },
   "bugs": {
-    "url": "https://github.com/jarle/remix-adonisjs/issues"
+    "url": "https://github.com/jarle/react-adonisjs/issues"
   },
-  "homepage": "https://matstack.dev/remix-adonisjs",
+  "homepage": "https://matstack.dev/react-adonisjs",
   "prettier": "@adonisjs/prettier-config",
   "publishConfig": {
     "access": "public",

packages/adapter/providers/remix_provider.ts renamed to packages/adapter/providers/react_router_provider.ts

@@ -1,33 +1,33 @@
 /// <reference types="@adonisjs/vite/vite_provider" />
 
-import type { RequestHandler } from '../src/remix_adapter.js'
+import type { RequestHandler } from '../src/react_router_adapter.js'
 
 import { HttpContext } from '@adonisjs/core/http'
 import type { ApplicationService } from '@adonisjs/core/types'
 import '../src/types/main.js'
 
 declare module '@adonisjs/core/types' {
   interface ContainerBindings {
-    remix: Promise<RequestHandler>
+    reactRouter: Promise<RequestHandler>
   }
 }
 
 declare module '@adonisjs/core/http' {
   interface HttpContext {
-    remixHandler: () => Promise<void>
+    reactRouterHandler: () => Promise<void>
   }
 }
 
-export default class RemixProvider {
+export default class ReactRouterProvider {
   static needsApplication = true
-  private remixBundle: string
+  private reactRouterBundle: string
 
   constructor(protected app: ApplicationService) {
-    this.remixBundle = app.makeURL('remix/server/server.js').href
+    this.reactRouterBundle = app.makeURL('react-router/server/server.js').href
   }
 
   async boot() {
-    const { createRequestHandler } = await import('../src/remix_adapter.js')
+    const { createRequestHandler } = await import('../src/react_router_adapter.js')
     const env = this.app.getEnvironment()
     if (env !== 'web' && env !== 'test') {
       return
@@ -38,7 +38,7 @@ export default class RemixProvider {
     const build =
       (this.app.inDev || this.app.inTest) && devServer
         ? () => devServer.ssrLoadModule('virtual:react-router/server-build')
-        : await import(this.remixBundle)
+        : await import(this.reactRouterBundle)
 
     const requestHandler = createRequestHandler({
       build,
@@ -49,7 +49,7 @@ export default class RemixProvider {
     })
     const app = this.app
     HttpContext.getter(
-      'remixHandler',
+      'reactRouterHandler',
       function (this: HttpContext) {
         return () =>
           requestHandler({

packages/adapter/src/debug.ts

@@ -1,3 +1,3 @@
 import { debuglog } from 'node:util'
 
-export default debuglog('matstack:remix-adonisjs')
+export default debuglog('matstack:react-adonisjs')

packages/adapter/src/hooks/build_hook.ts

@@ -1,25 +1,26 @@
 import app from '@adonisjs/core/services/app'
 import type { AssemblerHookHandler } from '@adonisjs/core/types/app'
 import { execa } from 'execa'
-import { spawn } from 'node:child_process'
 import fs from 'node:fs'
 import path from 'node:path'
 
 /**
  *
  * The hook is responsible for launching the react-router build command when the application is built
  */
-export default async function remixBuildHook({ logger }: Parameters<AssemblerHookHandler>[0]) {
+export default async function reactRouterBuildHook({
+  logger,
+}: Parameters<AssemblerHookHandler>[0]) {
   logger.info('building React Router app with vite')
   await execa('react-router', ['build'], {
-    preferLocal: true,   // use ./node_modules/.bin/react-router
+    preferLocal: true, // use ./node_modules/.bin/react-router
     stdio: 'inherit',
   })
   const config = await resolveViteConfig()
   // const cli = await import('@remix-run/dev')
   // await cli.run(['vite:build'])
   const assetsDir = config?.build?.assetsDir ?? 'assets'
-  const source = app.makePath('build', 'remix', 'client', assetsDir)
+  const source = app.makePath('build', 'react-router', 'client', assetsDir)
   const target = app.makePath('build', 'public', assetsDir, config?.base ?? '/')
   moveDirectorySync(source, target)
 }
@@ -41,30 +42,6 @@ function moveDirectorySync(source: string, target: string) {
   }
 }
 
-async function runCommand(command: string, args = []) {
-  return new Promise((resolve, reject) => {
-    const subprocess = spawn(command, args, { shell: true })
-    let stdout = ''
-    let stderr = ''
-
-    subprocess.stdout.on('data', (data) => {
-      stdout += data.toString()
-    })
-
-    subprocess.stderr.on('data', (data) => {
-      stderr += data.toString()
-    })
-
-    subprocess.on('close', (code) => {
-      if (code === 0) {
-        resolve(stdout)
-      } else {
-        reject(new Error(`Command failed with code ${code}: ${stderr}`))
-      }
-    })
-  })
-}
-
 export async function resolveViteConfig() {
   let vite = await import('vite')
 

packages/adapter/src/remix_adapter.ts renamed to packages/adapter/src/react_router_adapter.ts

@@ -8,11 +8,11 @@ import type { Request as AdonisRequest, Response as AdonisResponse } from '@adon
 import {
   AppLoadContext,
   ServerBuild,
-  createRequestHandler as createRemixRequestHandler,
+  createRequestHandler as createReactRouterRequestHandler,
 } from 'react-router'
 
-import { Readable } from 'node:stream'
 import { createReadableStreamFromReadable } from '@react-router/node'
+import { Readable } from 'node:stream'
 import debug from './debug.js'
 
 export type HandlerContext = {
@@ -30,7 +30,7 @@ export type GetLoadContextFunction = (context: HandlerContext) => AppLoadContext
 export type RequestHandler = (context: HandlerContext) => Promise<void>
 
 /**
- * Returns a request handler for AdonisJS that serves the response using Remix.
+ * Returns a request handler for AdonisJS that serves the response using React Router.
  */
 export function createRequestHandler({
   build,
@@ -41,20 +41,20 @@ export function createRequestHandler({
   getLoadContext: GetLoadContextFunction
   mode?: string
 }): RequestHandler {
-  let handleRequest = createRemixRequestHandler(build, mode)
+  let handleRequest = createReactRouterRequestHandler(build, mode)
 
   return async (context: HandlerContext) => {
-    debug(`Creating remix request for ${context.http.request.parsedUrl}`)
-    const request = createRemixRequest(context.http.request, context.http.response)
+    debug(`Creating react-router request for ${context.http.request.parsedUrl}`)
+    const request = createReactRouterRequest(context.http.request, context.http.response)
     const loadContext = getLoadContext(context)
 
     const response = await handleRequest(request, loadContext)
 
-    sendRemixResponse(context.http, response)
+    sendReactRouterResponse(context.http, response)
   }
 }
 
-export function createRemixHeaders(requestHeaders: IncomingHttpHeaders): Headers {
+export function createReactRouterHeaders(requestHeaders: IncomingHttpHeaders): Headers {
   const headers = new Headers()
 
   for (let [key, values] of Object.entries(requestHeaders)) {
@@ -71,7 +71,7 @@ export function createRemixHeaders(requestHeaders: IncomingHttpHeaders): Headers
   return headers
 }
 
-export function createRemixRequest(req: AdonisRequest, res: AdonisResponse): Request {
+export function createReactRouterRequest(req: AdonisRequest, res: AdonisResponse): Request {
   const url = new URL(req.completeUrl(true))
 
   // Abort action/loaders once we can no longer write a response
@@ -84,7 +84,7 @@ export function createRemixRequest(req: AdonisRequest, res: AdonisResponse): Req
 
   const init: RequestInit = {
     method: req.method(),
-    headers: createRemixHeaders(req.headers()),
+    headers: createReactRouterHeaders(req.headers()),
     signal: controller.signal,
   }
 
@@ -102,14 +102,14 @@ export function createRemixRequest(req: AdonisRequest, res: AdonisResponse): Req
   return new Request(url.href, init)
 }
 
-export async function sendRemixResponse(ctx: HttpContext, webResponse: Response) {
+export async function sendReactRouterResponse(ctx: HttpContext, webResponse: Response) {
   const res = ctx.response
   res.response.statusMessage = webResponse.statusText
   if (res.getStatus() === 200) {
     res.status(webResponse.status)
   }
 
-  debug('Commit session early for remix response')
+  debug('Commit session early for react-router response')
   await ctx.session?.commit()
   webResponse.headers.forEach((value, key) => res.append(key, value))