fix(serve): update usage error to support ESM (#7400)

remix-run · Sep 13, 2023 · 6430a57 · 6430a57
1 parent 1071209
commit 6430a57
Show file tree

Hide file tree

Showing 10 changed files with 18 additions and 20 deletions.
diff --git a/.changeset/remix-serve-esm-usage-error.md b/.changeset/remix-serve-esm-usage-error.md
@@ -0,0 +1,5 @@
+---
+"@remix-run/serve": patch
+---
+
+Update remix-serve usage error message to support ESM projects
diff --git a/docs/file-conventions/remix-config.md b/docs/file-conventions/remix-config.md
@@ -112,15 +112,6 @@ main module. If specified, Remix will compile this file along with your
 application into a single file to be deployed to your server. This file can use
 either a `.js` or `.ts` file extension.
 
-## serverBuildDirectory
-
-<docs-warning>This option is deprecated and will likely be removed in a future
-stable release. Use [`serverBuildPath`][server-build-path]
-instead.</docs-warning>
-
-The path to the server build, relative to `remix.config.js`. Defaults to
-"build". This needs to be deployed to your server.
-
 ## serverBuildPath
 
 The path to the server build file, relative to `remix.config.js`. This file
@@ -150,7 +141,7 @@ module.exports = {
   appDirectory: "app",
   assetsBuildDirectory: "public/build",
   publicPath: "/build/",
-  serverBuildDirectory: "build",
+  serverBuildPath: "build/index.js",
   ignoredRouteFiles: ["**/.*"],
   serverDependenciesToBundle: [
     /^rehype.*/,

diff --git a/docs/guides/migrating-react-router-app.md b/docs/guides/migrating-react-router-app.md
@@ -302,7 +302,7 @@ In your `package.json` file, update your scripts to use `remix` commands instead
   "scripts": {
     "build": "remix build",
     "dev": "remix dev",
-    "start": "remix-serve build",
+    "start": "remix-serve build/index.js",
     "typecheck": "tsc"
   }
 }

diff --git a/docs/guides/typescript.md b/docs/guides/typescript.md
@@ -17,7 +17,7 @@ The Remix compiler will not do any type checking (it simply removes the types).
   "scripts": {
     "build": "remix build",
     "dev": "remix dev",
-    "start": "remix-serve build",
+    "start": "remix-serve build/index.js",
     "typecheck": "tsc"
   },
   "dependencies": {

diff --git a/docs/other-api/dev.md b/docs/other-api/dev.md
@@ -155,7 +155,7 @@ For example, you may have it hardcoded in your `server.js` file.
 If you are using `remix-serve` as your app server, you can use its `--port` flag to set the app server port:
 
 ```sh
-remix dev -c "remix-serve --port 8000 ./build"
+remix dev -c "remix-serve --port 8000 ./build/index.js"
 ```
 
 In contrast, the `remix dev --port` option is an escape-hatch for users who need fine-grain control of network ports.

diff --git a/docs/other-api/serve.md b/docs/other-api/serve.md
@@ -9,29 +9,31 @@ Remix is designed for you to own your server, but if you don't want to set one u
 
 ```sh
 remix-serve <server-build-path>
+# e.g.
+remix-serve build/index.js
 ```
 
 ## `PORT` environment variable
 
 You can change the port of the server with an environment variable.
 
 ```sh
-PORT=4000 npx remix-serve <server-build-path>
+PORT=4000 npx remix-serve build/index.js
 ```
 
 ## `HOST` environment variable
 
 You can configure the hostname for your Express app via `process.env.HOST` and that value will be passed to the internal [`app.listen`][express-listen] method when starting the server.
 
 ```sh
-HOST=127.0.0.1 npx remix-serve build/
+HOST=127.0.0.1 npx remix-serve build/index.js
 ```
 
 ## Development Environment
 
 Depending on `process.env.NODE_ENV`, the server will boot in development or production mode.
 
-The `server-build-path` needs to point to the `serverBuildDirectory` defined in `remix.config.js`.
+The `server-build-path` needs to point to the `serverBuildPath` defined in `remix.config.js`.
 
 Because only the build artifacts (`build/`, `public/build/`) need to be deployed to production, the `remix.config.js` is not guaranteed to be available in production, so you need to tell Remix where your server build is with this option.
 

diff --git a/packages/create-remix/__tests__/fixtures/stack/package.json b/packages/create-remix/__tests__/fixtures/stack/package.json
@@ -5,7 +5,7 @@
   "scripts": {
     "build": "remix build",
     "dev": "remix dev",
-    "start": "remix-serve build"
+    "start": "remix-serve build/index.js"
   },
   "dependencies": {},
   "devDependencies": {},

diff --git a/packages/remix-dev/__tests__/fixtures/node/package.json b/packages/remix-dev/__tests__/fixtures/node/package.json
@@ -5,7 +5,7 @@
   "scripts": {
     "build": "remix build",
     "dev": "remix dev",
-    "start": "remix-serve build",
+    "start": "remix-serve build/index.js",
     "typecheck": "tsc"
   },
   "dependencies": {

diff --git a/packages/remix-dev/__tests__/fixtures/stack/package.json b/packages/remix-dev/__tests__/fixtures/stack/package.json
@@ -5,7 +5,7 @@
   "scripts": {
     "build": "remix build",
     "dev": "remix dev",
-    "start": "remix-serve build"
+    "start": "remix-serve build/index.js"
   },
   "dependencies": {},
   "devDependencies": {},

diff --git a/packages/remix-serve/cli.ts b/packages/remix-serve/cli.ts
@@ -37,7 +37,7 @@ async function run() {
 
   if (!buildPathArg) {
     console.error(`
-  Usage: remix-serve <build-dir>`);
+  Usage: remix-serve <server-build-path> - e.g. remix-serve build/index.js`);
     process.exit(1);
   }