Fix reveal and routes CLI commands (#12745)

Author: markdalgleish

.changeset/popular-lobsters-agree.md

@@ -0,0 +1,5 @@
+---
+"@react-router/dev": patch
+---
+
+Fix `reveal` and `routes` CLI commands

packages/react-router-dev/__tests__/cli-reveal-test.ts

@@ -0,0 +1,77 @@
+import path from "node:path";
+import fse from "fs-extra";
+import execa from "execa";
+
+function getProjectDir() {
+  let projectDir = path.join(
+    __dirname,
+    ".tmp",
+    `reveal-test-${Math.random().toString(32).slice(2)}`
+  );
+  fse.copySync(path.join(__dirname, "fixtures", "basic"), projectDir);
+  return projectDir;
+}
+
+async function runCli(cwd: string, args: string[]) {
+  return await execa(
+    "node",
+    [
+      "--require",
+      require.resolve("esbuild-register"),
+      path.resolve(__dirname, "../cli/index.ts"),
+      ...args,
+    ],
+    { cwd }
+  );
+}
+
+describe("the reveal command", () => {
+  it("generates an entry.server.tsx file in the app directory", async () => {
+    let projectDir = getProjectDir();
+
+    let entryClientFile = path.join(projectDir, "app", "entry.client.tsx");
+    let entryServerFile = path.join(projectDir, "app", "entry.server.tsx");
+
+    expect(fse.existsSync(entryServerFile)).toBeFalsy();
+    expect(fse.existsSync(entryClientFile)).toBeFalsy();
+
+    await runCli(projectDir, ["reveal"]);
+
+    expect(fse.existsSync(entryServerFile)).toBeTruthy();
+    expect(fse.existsSync(entryClientFile)).toBeTruthy();
+  });
+
+  it("generates an entry.server.tsx file in the app directory when specific entries are provided", async () => {
+    let projectDir = getProjectDir();
+
+    let entryClientFile = path.join(projectDir, "app", "entry.client.tsx");
+    let entryServerFile = path.join(projectDir, "app", "entry.server.tsx");
+
+    expect(fse.existsSync(entryServerFile)).toBeFalsy();
+    expect(fse.existsSync(entryClientFile)).toBeFalsy();
+
+    await runCli(projectDir, ["reveal", "entry.server"]);
+    expect(fse.existsSync(entryServerFile)).toBeTruthy();
+    expect(fse.existsSync(entryClientFile)).toBeFalsy();
+    fse.removeSync(entryServerFile);
+
+    await runCli(projectDir, ["reveal", "entry.client"]);
+    expect(fse.existsSync(entryClientFile)).toBeTruthy();
+    expect(fse.existsSync(entryServerFile)).toBeFalsy();
+  });
+
+  it("generates an entry.server.jsx file in the app directory", async () => {
+    let projectDir = getProjectDir();
+
+    let entryClientFile = path.join(projectDir, "app", "entry.client.jsx");
+    let entryServerFile = path.join(projectDir, "app", "entry.server.jsx");
+
+    expect(fse.existsSync(entryServerFile)).toBeFalsy();
+    expect(fse.existsSync(entryClientFile)).toBeFalsy();
+
+    await runCli(projectDir, ["reveal", "--no-typescript"]);
+
+    expect(fse.existsSync(entryServerFile)).toBeTruthy();
+    expect(fse.existsSync(entryClientFile)).toBeTruthy();
+  });
+});

packages/react-router-dev/__tests__/cli-routes-test.ts

@@ -0,0 +1,31 @@
+import path from "node:path";
+import execa from "execa";
+
+async function runCli(cwd: string, args: string[]) {
+  return await execa(
+    "node",
+    [
+      "--require",
+      require.resolve("esbuild-register"),
+      path.resolve(__dirname, "../cli/index.ts"),
+      ...args,
+    ],
+    { cwd }
+  );
+}
+
+describe("the routes command", () => {
+  it("displays routes", async () => {
+    let projectDir = path.join(__dirname, "fixtures", "basic");
+
+    let result = await runCli(projectDir, ["routes"]);
+
+    expect(result.stdout).toMatchInlineSnapshot(`
+      "<Routes>
+        <Route file="root.tsx">
+          <Route index file="routes/_index.tsx" />
+        </Route>
+      </Routes>"
+    `);
+  });
+});

packages/react-router-dev/__tests__/fixtures/node/.gitignore renamed to packages/react-router-dev/__tests__/fixtures/basic/.gitignore

@@ -1,6 +1,6 @@
 node_modules
 
-/.cache
 /build
-/public/build
 .env
+
+.react-router/

packages/react-router-dev/__tests__/fixtures/node/app/root.tsx renamed to packages/react-router-dev/__tests__/fixtures/basic/app/root.tsx

@@ -0,0 +1,5 @@
+// Note that since this is used in a unit test context, we don't have access to
+// the `dev` build yet, so we can't import from `@react-router/dev/routes`.
+const routes = [{ file: "routes/_index.tsx", index: true }];
+
+export default routes;

packages/react-router-dev/__tests__/fixtures/basic/app/routes.ts

@@ -1,7 +1,8 @@
 {
-  "include": ["remix.env.d.ts", "**/*.ts", "**/*.tsx"],
+  "include": ["**/*.ts", "**/*.tsx"],
   "compilerOptions": {
     "lib": ["DOM", "DOM.Iterable", "ES2022"],
+    "types": ["@react-router/node", "vite/client"],
     "verbatimModuleSyntax": true,
     "esModuleInterop": true,
     "jsx": "react-jsx",