Use Vite in your Meteor app! ⚡️
⚡Significantly speeds up Meteor's client-side build process. Uses the Vite dev server under-the-hood, leading to blazing fast hot-module-replacement during development.
# Add the Meteor-Vite plugin to your dependencies
meteor npm i meteor-vite
# Install the latest version of Vite (Meteor v3+)
npm i -D vite
# Then add the Vite-Bundler package to your Meteor project.
meteor add jorgenvatle:vite-bundlerIf you are using Meteor v2, you need to make sure you install Vite v4 instead.
meteor npm i -D vite@4You can structure your app just like you would with a typical Meteor application. The key difference is the addition of a Vite entry file for your Meteor client and server. These will become the primary entrypoints for your app.
If you're installing Meteor-Vite for an existing project, just rename your current client/server entry modules to entry-vite.ts.
Then create a new empty entry-meteor.js file for your Meteor client and server.
- client/
- entry-vite.ts # Write your Meteor client code from here.
- entry-meteor.js # Leave empty, Vite will write to this file to load missing dependencies at runtime.
- index.html
- server/
- entry-vite.ts # Write your Meteor server code from here.
- entry-meteor.js # If you enable server builds with Vite: Leave empty. Vite will write to this file to load your finished server bundle.
- package.json
- vite.config.tsNow, make sure you have mainModule entry in your package.json for each of the new meteor-entry.js files.
{
"name": "my-app",
"private": true,
"scripts": {
"dev": "meteor run",
"build": "meteor build ../output/vue --directory"
},
"dependencies": {
// ...
},
"meteor": {
"mainModule": {
"client": "client/entry-meteor.js",
"server": "server/entry-meteor.js"
},
}
}You can leave your meteor-entry.js files empty, or write to them if you'd like. Do keep in mind that Vite may write to
them during development and production bundling. What you add to your meteor-entry.js files will be ignored by Vite.
So you should generally avoid adding anything to these modules unless you have a very specific use case that cannot
be handled by Vite.
Create a Vite configuration file (vite.config.ts) in your project root. And load in the meteor-vite plugin.
// vite.config.ts
import { defineConfig } from 'vite'
import { meteor } from 'meteor-vite/plugin';
export default defineConfig({
plugins: [
meteor({
clientEntry: 'client/entry-vite.ts',
// Optionally specify a server entrypoint to build the Meteor server with Vite.
serverEntry: 'server/entry-vite.ts',
enableExperimentalFeatures: true, // Required to enable server bundling.
}),
// ... Other Vite plugins here. E.g. React or Vue (See examples below)
],
})Write your code from your entry-vite.ts files. Install any Vite plugins you prefer to power your Meteor app.
See below for examples with popular UI frameworks.
If you have any existing Meteor build plugins like typescript, etc. you can safely remove them.
Vite comes with out-of-the-box support most of these. For the rest, it's usually as simple as just adding a plugin to
vite.config.ts.
Start your app and enjoy blazingly fast HMR and builds, all powered by Vite! ⚡️
meteor run// vite.config.ts
import { defineConfig } from 'vite'
import { meteor } from 'meteor-vite/plugin';
import vue from '@vitejs/plugin-vue'
export default defineConfig({
plugins: [
meteor({
clientEntry: 'client/entry-vite.ts',
}),
vue(),
],
// Other vite options here...
})// vite.config.ts
import { defineConfig } from 'vite'
import { meteor } from 'meteor-vite/plugin';
import vue from '@vitejs/plugin-vue2'
export default defineConfig({
plugins: [
meteor({
clientEntry: 'client/entry-vite.ts',
}),
vue(),
],
// Other vite options here...
})// vite.config.ts
import { defineConfig } from 'vite'
import { meteor } from 'meteor-vite/plugin';
import react from '@vitejs/plugin-react'
export default defineConfig({
plugins: [
meteor({
clientEntry: 'client/entry-vite.ts',
}),
react({
jsxRuntime: 'classic',
}),
],
optimizeDeps: {
exclude: ['@meteor-vite/react-meteor-data'],
}
})If your project depends on react-meteor-data it might be worthwhile to
replace it with our npm-published fork @meteor-vite/react-meteor-data.
The fork simply publishes the package over npm instead of Atmosphere. This has a few benefits. Primarily, Meteor won't try to bundle React for you, instead leaving it to Vite. This gives you more flexibility in configuring your React environment through Vite. And a good boost in build times.
And that should be it. Write your app from your vite.tsx entrypoint and enjoy lightning fast HMR ⚡
The only required config field is your Vite clientEntry field. The rest is optional and usually doesn't require
tinkering with.
// vite.config.ts
import { meteor } from 'meteor-vite/plugin';
export default defineConfig({
plugins: [
meteor({
/**
* Path to the client entrypoint for your app.
* This becomes your new Vite-powered mainModule for Meteor.
* @required
*/
clientEntry: 'client/entry-vite.ts',
/**
* Enter your Meteor server's entrypoint here to prebuild your Meteor server modules using Vite.
* This will not compile your Atmosphere packages, but will build all your app's server modules into
* a single file, greatly aiding Meteor in server reload performance during development.
*
* Not only does this come with improved performance, but also the flexibility of Vite's build system.
* The Meteor server is built using Vite SSR mode. To configure just the server builds see
* {@link https://vite.dev/config/#conditional-config Conditional Configuration docs}
* @optional
*/
serverEntry: 'server/entry-vite.ts',
/**
* Failsafe opt-in to prevent experimental features and configuration from taking effect.
* Required if {@link serverEntry} is specified.
*/
enableExperimentalFeatures: true,
/**
* Skips bundling the provided npm packages if they are already provided by Meteor.
* This assumes you have a Meteor package that depends on the provided npm packages.
* @default []
*/
externalizeNpmPackages: ['react', 'react-dom'],
/**
* Configures runtime validation of Meteor package stubs generated by Vite.
* See Features section in readme for more info
* @optional
*/
stubValidation: {
/**
* list of packages to ignore export validation for.
* @default []
*/
ignorePackages: ['ostrio:cookies'],
/**
* Suppress warning messages when we resolve a module that has conflicting export keys.
* This is generally only an issue for React where as we ignore conditional exports when creating an
* ESM stub. These are only ESM export stubs that point to your Meteor bundle, so it's generally safe
* to ignore.
* @default []
*/
ignoreDuplicateExportsInPackages: ['react', 'react-dom'],
/**
* Will only emit warnings in the console instead of throwing an exception that may
* prevent the client app from loading.
* @default false
*/
warnOnly: true,
/**
* Set to true to completely disable stub validation. Any of the above options will be ignored.
* This is discuraged as `warnOnly` should give you an important heads up if something might be wrong
* with Meteor-Vite
* @default false
*/
disabled: false,
},
}),
],
});There are a couple extra advanced settings you can change through your package.json file under meteor.vite.
In most cases, you won't need to add anything here.
// package.json
{
"name": "my-app",
// ...
"meteor": {
"mainModule": { /* ... */ },
// Additional configuration for Meteor-Vite (optional)
"vite": {
// If your Vite config file lives in another directory (e.g. private/vite.config.ts), specify its path here
"configFile": "",
// Replace or remove Meteor packages when bundling Vite for production.
// This may be useful for a small subset of compiler-plugin packages that interfere with Vite's build process.
//
// This is only used during the Vite bundling step. The packages included in your final production
// bundle remains unaffected.
"replacePackages": [
// Removes standard-minifier packages while building with Vite. (default)
{ "startsWith": "standard-minifier", "replaceWith": "" },
// Replace refapp:meteor-typescript with the official typescript package. (default)
{ "startsWith": "refapp:meteor-typescript", replaceWith: "typescript" },
]
}
}
}Meteor-Vite will automatically detect lazy loaded Meteor packages and import them into your Meteor client's entrypoint. This is necessary to ensure that the Vite bundler has access to your Meteor packages.
The imported files can safely be committed to your project repository. If you remove the associated package in the future, simply remove the import statement.
Our detection for these packages is fairly primitive, so it's best to keep the imports in the Meteor client
entrypoint as specified in the meteor.mainModule.client field of your package.json file.
{
"meteor": {
"mainModule": {
"client": "client/entry-meteor.js", // Lazy loaded packages checked for and added to this file.
"server": "server/entry-meteor.js"
}
}
}Runtime validation at the client is performed for Meteor packages that are compiled by Vite. This is done to avoid a situation where Meteor-Vite incorrectly exports undefined values from a Meteor Package. Which can lead to silently broken Meteor packages.
The validation is done simply through verifying that package exports do not have a typeof value of undefined.
If you do have a package that intentionally has undefined exports, you can disable the warning message for this
package by excluding it in your Meteor settings.json file;
// vite.config.ts
export default defineConfig({
plugins: [
meteor({
stubValidation: {
ignorePackages: ["ostrio:cookies"]
}
})
]
})mainModuleCode written to or imported by your Meteor client's mainModule.client
will not be processed by Vite, however, it will still by loaded by the Meteor client. So if you have a use case where
you have some code that you don't want Vite to process, but still want in your client bundle, this would be the place
to put that.
But do be careful with this - any code that's imported by both your Vite config's clientEntry
and your Meteor mainModule.client may lead to the code being included twice in your final production bundle.
zodern:relaySince zodern:relay depends on a Babel plugin for processing your publication and methods on the client, we need some
extra configuration to make that work with Vite.
We have a separate Vite plugin that should take care of this for you:
The Vite integration comes with two dependencies that work together to enable compatibility between Meteor and Vite.
meteor-vite - Internal Vite plugin and server worker parsing and formatting Meteor packages for Vite.
jorgenvatle:vite-bundler - Meteor build plugin for launching Vite workers and compiling production bundles from Vite and Meteor.