Read Vite config in `reveal`/`routes` commands #8916

markdalgleish · 2024-02-28T05:04:41Z

changeset-bot · 2024-02-28T05:04:45Z

🦋 Changeset detected

Latest commit: 116672f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 16 packages

Name	Type
@remix-run/dev	Patch
create-remix	Patch
remix	Patch
@remix-run/architect	Patch
@remix-run/cloudflare	Patch
@remix-run/cloudflare-pages	Patch
@remix-run/cloudflare-workers	Patch
@remix-run/css-bundle	Patch
@remix-run/deno	Patch
@remix-run/eslint-config	Patch
@remix-run/express	Patch
@remix-run/node	Patch
@remix-run/react	Patch
@remix-run/serve	Patch
@remix-run/server-runtime	Patch
@remix-run/testing	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

markdalgleish · 2024-02-28T05:05:50Z

packages/remix-dev/vite/build.ts

-async function resolveViteConfig({
-  configFile,
-  mode,
-  root,
-}: {
-  configFile?: string;
-  mode?: string;
-  root: string;
-}) {
-  let vite = await import("vite");
-
-  // Leverage the Vite config as a way to configure the entire multi-step build
-  // process so we don't need to have a separate Remix config
-  let viteConfig = await vite.resolveConfig(
-    { mode, configFile, root },
-    "build", // command
-    "production", // default mode
-    "production" // default NODE_ENV
-  );
-
-  if (typeof viteConfig.build.manifest === "string") {
-    throw new Error("Custom Vite manifest paths are not supported");
-  }
-
-  return viteConfig;
-}
-
-async function extractRemixPluginContext(viteConfig: Vite.ResolvedConfig) {
-  let ctx = viteConfig["__remixPluginContext" as keyof typeof viteConfig] as
-    | RemixPluginContext
-    | undefined;
-
-  if (!ctx) {
-    console.error(colors.red("Remix Vite plugin not found in Vite config"));
-    process.exit(1);
-  }
-
-  return ctx;
-}
-


This has moved to vite/plugin.ts since the logic is now shared and not specific to the vite:build command.

markdalgleish · 2024-02-28T05:07:14Z

packages/remix-dev/vite/build.ts

+  if (!ctx) {
+    console.error(colors.red("Remix Vite plugin not found in Vite config"));
+    process.exit(1);
+  }


This error used to be in extractRemixPluginContext but since it's now used in contexts where it's not guaranteed that the consumer is using Vite, extractRemixPluginContext now returns undefined if Vite and/or the Remix Vite plugin aren't found, so we handle the error here now instead.

markdalgleish · 2024-02-28T05:08:07Z

packages/remix-dev/vite/plugin.ts

+export async function resolveViteConfig({
+  configFile,
+  mode,
+  root,
+}: {
+  configFile?: string;
+  mode?: string;
+  root: string;
+}) {
+  let vite = await import("vite");
+
+  let viteConfig = await vite.resolveConfig(
+    { mode, configFile, root },
+    "build", // command
+    "production", // default mode
+    "production" // default NODE_ENV
+  );
+
+  if (typeof viteConfig.build.manifest === "string") {
+    throw new Error("Custom Vite manifest paths are not supported");
+  }
+
+  return viteConfig;
+}
+
+export async function extractRemixPluginContext(
+  viteConfig: Vite.ResolvedConfig
+) {
+  return viteConfig["__remixPluginContext" as keyof typeof viteConfig] as
+    | RemixPluginContext
+    | undefined;
+}


As noted above, these have moved from vite/build.ts.

markdalgleish · 2024-02-28T05:10:26Z

packages/remix-dev/vite/plugin.ts

+export async function loadVitePluginContext({
+  configFile,
+  root,
+}: {
+  configFile?: string;
+  root?: string;
+}) {
+  if (!root) {
+    root = process.env.REMIX_ROOT || process.cwd();
+  }
+
+  configFile =
+    configFile ??
+    findConfig(root, "vite.config", [
+      ".ts",
+      ".cts",
+      ".mts",
+      ".js",
+      ".cjs",
+      ".mjs",
+    ]);
+
+  // V3 TODO: Vite config should not be optional
+  if (!configFile) {
+    return;
+  }
+
+  let viteConfig = await resolveViteConfig({ configFile, root });
+  return await extractRemixPluginContext(viteConfig);
+}


This is the logic used by the reveal and routes commands. Since it's not guaranteed that consumers are using Vite, this function returns undefined if a Vite config doesn't exist or if the Remix Vite plugin isn't present. This allows us to fall back to the old Remix config.

brophdawg11

Nice work! Gave it a quick test on my vite app and npx remix routes picked up custom routes. I also pushed a commit to this branch for npx remix reveal to reveal the simpler SPA mode server entry.

brophdawg11 · 2024-02-28T14:53:55Z

packages/remix-dev/cli/commands.ts

+  let formatArg = flags.json ? "json" : "jsx";
  let format = isRoutesFormat(formatArg) ? formatArg : RoutesFormat.jsx;


I think we can streamline this due to the boolean and remove the isRoutesFormat utility?

Suggested change

let formatArg = flags.json ? "json" : "jsx";

let format = isRoutesFormat(formatArg) ? formatArg : RoutesFormat.jsx;

let format = flags.json ? RoutesFormat.json : RoutesFormat.jsx;

brophdawg11 · 2024-02-28T14:55:50Z

packages/remix-dev/cli/run.ts

+          {
+            "--config": String,
+            "-c": "--config",
+          }
+        : {
+            // Handle non Vite config commands
+            "-c": "--command",
+          }),


This feels slightly odd but looks like it was already there before - npx remix -c means something different depending on if you're using vite?

The issue was that remix vite: commands are designed to mirror the Vite CLI where -c is short for --config. This config flag now needs to work with reveal and routes too. Passing -c to these commands currently has no effect.

brophdawg11 · 2024-02-28T14:56:37Z

packages/remix-dev/cli/run.ts

@@ -120,14 +120,25 @@ export async function run(argv: string[] = process.argv.slice(2)) {
      "--tls-key": String,
      "--tls-cert": String,

+      ...(argv[0].startsWith("vite:") ||


Not related to this PR but I noticed we don't mention anything about the vite: commands in the npx remix --help output - might be worth a follow up to add some info there?

Updated the --help output here: #8939

github-actions · 2024-03-05T20:01:12Z

🤖 Hello there,

We just published version 2.8.1-pre.0 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

github-actions · 2024-03-07T16:28:20Z

🤖 Hello there,

We just published version 2.8.1 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

Read Vite config in reveal/routes commands

ade8edf

markdalgleish added package:dev vite labels Feb 28, 2024

remix-cla-bot bot added the CLA Signed label Feb 28, 2024

markdalgleish commented Feb 28, 2024

View reviewed changes

kiliman mentioned this pull request Feb 28, 2024

"npx remix routes" issue with Vite and latest Remix kiliman/remix-flat-routes#88

Closed

Update to reveal the simpler entry.server in SPA mode

1edfbe7

brophdawg11 approved these changes Feb 28, 2024

View reviewed changes

This was linked to issues Feb 28, 2024

remix routes does not work with vite #8845

Closed

SPA Mode: remix reveal generate entries files with unexpected content #8881

Closed

brophdawg11 and others added 3 commits February 28, 2024 10:18

Streamline RoutesFormat logic

402cd6e

Fix error, convert enum to literal union

8786c0f

Merge branch 'dev' into markdalgleish/reveal-routes-vite-config

116672f

markdalgleish merged commit 6d32ca5 into dev Feb 28, 2024
9 checks passed

markdalgleish deleted the markdalgleish/reveal-routes-vite-config branch February 28, 2024 20:22

github-actions bot added the awaiting release This issue has been fixed and will be released soon label Feb 28, 2024

markdalgleish mentioned this pull request Feb 28, 2024

SPA Mode: remix reveal generate entries files with unexpected content #8881

Closed

github-actions bot mentioned this pull request Mar 5, 2024

chore: Update version for release (pre) #8985

Merged

kiliman mentioned this pull request Mar 5, 2024

using remix routes with remix-flat-routes + vite breaks #8986

Closed

github-actions bot mentioned this pull request Mar 7, 2024

chore: Update version for release #9012

Merged

github-actions bot removed the awaiting release This issue has been fixed and will be released soon label Mar 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Read Vite config in `reveal`/`routes` commands #8916

Read Vite config in `reveal`/`routes` commands #8916

markdalgleish commented Feb 28, 2024 •

edited by brophdawg11

Loading

changeset-bot bot commented Feb 28, 2024 •

edited

Loading

markdalgleish Feb 28, 2024

markdalgleish Feb 28, 2024

markdalgleish Feb 28, 2024

markdalgleish Feb 28, 2024 •

edited

Loading

brophdawg11 left a comment

brophdawg11 Feb 28, 2024

brophdawg11 Feb 28, 2024

brophdawg11 Feb 28, 2024

markdalgleish Feb 28, 2024

brophdawg11 Feb 28, 2024

markdalgleish Feb 28, 2024

github-actions bot commented Mar 5, 2024

github-actions bot commented Mar 7, 2024

		let formatArg = flags.json ? "json" : "jsx";
		let format = isRoutesFormat(formatArg) ? formatArg : RoutesFormat.jsx;

	let formatArg = flags.json ? "json" : "jsx";
	let format = isRoutesFormat(formatArg) ? formatArg : RoutesFormat.jsx;
	let format = flags.json ? RoutesFormat.json : RoutesFormat.jsx;

Read Vite config in reveal/routes commands #8916

Read Vite config in reveal/routes commands #8916

Conversation

markdalgleish commented Feb 28, 2024 • edited by brophdawg11 Loading

changeset-bot bot commented Feb 28, 2024 • edited Loading

🦋 Changeset detected

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

markdalgleish Feb 28, 2024 • edited Loading

Choose a reason for hiding this comment

brophdawg11 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Mar 5, 2024

github-actions bot commented Mar 7, 2024

Read Vite config in `reveal`/`routes` commands #8916

Read Vite config in `reveal`/`routes` commands #8916

markdalgleish commented Feb 28, 2024 •

edited by brophdawg11

Loading

changeset-bot bot commented Feb 28, 2024 •

edited

Loading

markdalgleish Feb 28, 2024 •

edited

Loading