enhancement(cli): Add --port flag to remix dev (#3447)

remix-run · Jun 11, 2022 · cc9e5c3 · cc9e5c3
1 parent 0004317
commit cc9e5c3
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 4 deletions.
diff --git a/packages/remix-dev/__tests__/cli-test.ts b/packages/remix-dev/__tests__/cli-test.ts
@@ -110,6 +110,7 @@ describe("remix CLI", () => {
             --sourcemap         Generate source maps for production
           \`dev\` Options:
             --debug             Attach Node.js inspector
+            --port, -p          Choose the port from which to run your app
           \`routes\` Options:
             --json              Print the routes as JSON
           \`migrate\` Options:

diff --git a/packages/remix-dev/cli/commands.ts b/packages/remix-dev/cli/commands.ts
@@ -234,7 +234,11 @@ export async function watch(
   });
 }
 
-export async function dev(remixRoot: string, modeArg?: string) {
+export async function dev(
+  remixRoot: string,
+  modeArg?: string,
+  portArg?: number
+) {
   let createApp: typeof createAppType;
   let express: typeof Express;
   try {
@@ -255,7 +259,11 @@ export async function dev(remixRoot: string, modeArg?: string) {
   await loadEnv(config.rootDirectory);
 
   let port = await getPort({
-    port: process.env.PORT ? Number(process.env.PORT) : makeRange(3000, 3100),
+    port: portArg
+      ? Number(portArg)
+      : process.env.PORT
+      ? Number(process.env.PORT)
+      : makeRange(3000, 3100),
   });
 
   if (config.serverEntryPoint) {

diff --git a/packages/remix-dev/cli/run.ts b/packages/remix-dev/cli/run.ts
@@ -40,6 +40,7 @@ ${colors.heading("Options")}:
   --sourcemap         Generate source maps for production
 \`dev\` Options:
   --debug             Attach Node.js inspector
+  --port, -p          Choose the port from which to run your app
 \`routes\` Options:
   --json              Print the routes as JSON
 \`migrate\` Options:
@@ -124,10 +125,13 @@ const npxInterop = {
   pnpm: "pnpm exec",
 };
 
-async function dev(projectDir: string, flags: { debug?: boolean }) {
+async function dev(
+  projectDir: string,
+  flags: { debug?: boolean; port?: number }
+) {
   if (!process.env.NODE_ENV) process.env.NODE_ENV = "development";
   if (flags.debug) inspector.open();
-  await commands.dev(projectDir, process.env.NODE_ENV);
+  await commands.dev(projectDir, process.env.NODE_ENV, flags.port);
 }
 
 /**
@@ -155,6 +159,7 @@ export async function run(argv: string[] = process.argv.slice(2)) {
       install: { type: "boolean" },
       json: { type: "boolean" },
       migration: { type: "string", alias: "m" },
+      port: { type: "number", alias: "p" },
       remixVersion: { type: "string" },
       sourcemap: { type: "boolean" },
       template: { type: "string" },