Incorporate the v3_routeConfig future flag for Remix.
#2722
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Oxygen deployed a preview of your
Learn more about Hydrogen's GitHub integration. |
juanpprieto
reviewed
Feb 18, 2025
|
|
||
| 2. In the Vite config (`vite.config.ts` usually) the `remix` plugin needs to have it's configuration slightly altered. | ||
|
|
||
| From this: |
There was a problem hiding this comment.
I would wrap this instruction on a diff -/+ block instead
juanpprieto
reviewed
Feb 18, 2025
| import {PageLayout} from '~/components/PageLayout'; | ||
| import { RootLoader } from './root'; | ||
|
|
||
| export default function Layout() { |
There was a problem hiding this comment.
I think now that we have a separate file for this layout, I would prefer if we consolidated /components/PageLayout.tsx here to avoid an unnecessary level of abstraction
| @@ -16,6 +16,9 @@ | |||
| "dependencies": { | |||
| "@remix-run/react": "^2.15.3", | |||
| "@remix-run/server-runtime": "^2.15.3", | |||
| "@remix-run/fs-routes": "^2.15.3", | |||
There was a problem hiding this comment.
A reminder that we will need to add these new dependencies to our changelog.json entry when the time comes to release this
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WHY are these changes introduced?
These changes are to support an upgrade to the next version of Remix, by using the future flag and supporting libraries to get the code ready for that upgrade in place before the upgrade itself happens.
WHAT is this pull request doing?
v3_routeConfigflag set totrue.hydrogen.v3presetfunction which excludes theroutesattribute that thehydrogen.presetfunction includes because that is incompatible with the flag being turned on.hydrogenRoutesfunction which transforms the route specified inroutes.tsto include the virtual routes.getVirtualRoutesto work without using any node libraries so that it can run in MiniOxygen.LANGenvironment variable in theclipackage so that the date formatting uses the US formatting.build.test.tsnow closes resources so that the test doesn't fail due to the hanging file watchers.build.tssets theserver.watchconfiguration option as that may be necessary to disable the file watching.hydrogen/dev.tsshuts down the watcher on theviteServerwhen finishing up.setup.test.tsmakes sure to include theroutes.tsfile.classic-compiler/dev.tsmakes sure to filter out the virtual routes whendisableVirtualRoutesis true.common.tsnow makes sure to includeroutes.tsandlayout.tsx.local.test.tsslightly tweaked to make it easier to find out what files are missing and also now correctly takes account of the content that was shifted fromroot.tsxtolayout.tsx.remix-config.tsconstructs a valueroutesViteNodeContextwhich is necessary when resolving the config ifv3_routeConfigis enabled.route-validator.tsis now null safe when assigningcurrentRoute.path.replacers.tslooks forlayoutinstead ofroot.get-virtual-routes.test.tsnow checks for thejsxfiles instead of thetsxfiles of the virtual routes.@remix-run/devto not watch inremixVitePluginwhen in a test because the file watchers cannot be reached to switch them off which causes tests relying on that to fail.viteto handle thewatchproperties of the config to set it if the value isnullas that has meaning in that particular case.HOW to test your changes?
routes.tswith thehydrogenRoutesfunction, to add the supporting routes.hydrogen.preset()tohydrogen.v3preset().Post-merge steps
Checklist