Date: 2024-02-22
Status: accepted
The Remix Team has created a Vite Plugin and it is now stable. It can be used to replace the existing remix compiler. In Remix v3 the plugin will be the only supported way to build remix applications.
Using vite also means we get better hot module replacement, a thriving ecosystem of tools, and shared efforts with other projects using vite.
If we don't adopt vite, we'll be stuck on Remix v2 forever 🙃 Now that the vite plugin is stable, adopting vite is really the only way forward.
That said, we currently have a few route modules that mix server-only utilities with server/client code. In vite, you cannot have any exported functions which use server-only code, so those utilities will need to be moved. Luckily, the vite plugin will fail the build if it finds any issues so if it builds, it works. Additionally, this will help us make a cleaner separation between server and server/client code which is a good thing.
The simple rule is this: if it's a Remix export (like loader, or action)
then it can be in the route. If it's our own utility export (like
requireRecentVerification we had in the /verify route) then it needs to go
in a .server file. To be clear, if you don't export it, then it's fine.
Server-only utility functions are fine in routes. It just becomes a problem for
remix when they are exported.
An interesting exception to this is sever-only code in the handle export like
the getSitemapEntries function. For
this, you need to use
vite-env-only.
Adopt vite.
Almost everything is better. We have slightly more complicated rules around the server/client code separation, but for the most part that's better and there are fewer surprises.