Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(vite): document adding additional Vite dev server options #8520

Merged
merged 2 commits into from
Jan 17, 2024
Merged

docs(vite): document adding additional Vite dev server options #8520

merged 2 commits into from
Jan 17, 2024

Conversation

ovi-ispas
Copy link
Contributor

Document adding additional Vite dev server options.

Copy link

changeset-bot bot commented Jan 15, 2024

⚠️ No Changeset found

Latest commit: 0373784

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@brophdawg11
Copy link
Contributor

@pcattori and @markdalgleish should make the call here, but IMO I don't know that we should single out the server aspect of vite here since there's plenty of stuff you can/should configure in vite outside of the remix plugin. I think we want to avoid trying to duplicate the vite config docs in our docs and I like that we already link out to them higher up:

This means that, for any additional bundling features you'd like to use, you should reference [Vite documentation][vite] and the [Vite plugin community][vite-plugins] rather than the Remix documentation.

Vite has many [features][vite-features] and [plugins][vite-plugins] that are not built into the existing Remix compiler.
The use of any such features will render the existing Remix compiler unable to compile your app, so only use them if you intend to use Vite exclusively from here on out.

Maybe we could expand on that slightly and include a bulleted list with links to links to a few common vite configs you might want to override in a Remix app (server, build, mode, etc.)

@ovi-ispas
Copy link
Contributor Author

Thanks for the comment.

Totally valid point @brophdawg11. My initial intention with this PR was not to redundantly add vite configs unrelated to the remix plugin itself, more like to mention that in the context of the migration you have to explicitly also set the port back to what you were used to (3000) if that is what you want, so it won't be a surprise when the app starts on 5173.

Maybe that is not that relevant and just unnecessary information, in which case feel free to close and disregard this PR. 👍

Copy link
Member

@markdalgleish markdalgleish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR!

Your point about this being a migration issue makes sense so I've moved it into the Remix App Server migration docs and reworded it so it only focuses on the port changing.

@markdalgleish markdalgleish merged commit 39b88d0 into remix-run:main Jan 17, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants