Sunday, March 17, 2024

A Information to Migrating from Webpack to Vite — SitePoint

Must read


On this article, we’ll take a look at learn how to improve a frontend internet software from Webpack to Vite.

Vite is the newest frontend improvement software to be having fun with an incredible development in reputation and adoption. Simply take a look at these downloads from npm developments within the picture under.

Picture supply

This development is being pushed by a key idea on the coronary heart of Vite: developer expertise. When put next with Webpack, Vite can supply considerably sooner construct instances and sizzling reloading instances throughout improvement. It does this by profiting from trendy browser options comparable to ES modules within the browser.

A Vite application loaded with script type module

Earlier than we dive into the method of migrating from Webpack to Vite, it’s price noting that the frontend improvement panorama is repeatedly evolving, and Vite isn’t the one software within the highlight. esbuild is one other extremely quick JavaScript bundler and minifier that’s catching the eye of internet builders. And for those who’re on the lookout for a extra zero-config strategy, you may additionally wish to discover Parcel, which supplies a seamless expertise for a lot of builders.

Desk of Contents
  1. Issues earlier than Migrating to Vite
  2. Step 1: Putting in Vite
  3. Step 2: Make package deal.json Adjustments
  4. Step 3: Out with webpack.config, in with vite.config
  5. Step 4: Plugins
  6. Well-liked Webpack Plugins and their Vite Equivalents
  7. Conclusion

Issues earlier than Migrating to Vite

Whereas Vite introduces many thrilling new options into your workflow, as with all new know-how there are drawbacks to contemplate. When in comparison with such a mature software as Webpack, the first consideration would be the ecosystem of third-party plugins.

There are dozens of core/official Webpack plugins, and tons of (presumably 1000’s) of community-contributed plugins on npm which have been developed over the ten years that Webpack has been in use. Whereas plugin help for Vite is excellent, you could end up within the state of affairs the place the plugin you depend on to your challenge doesn’t have a Vite equal, and this might grow to be a blocker to your migration to Vite.

Step 1: Putting in Vite

Step one emigrate your challenge is to create a brand new Vite software and discover the software you’re migrating to. You possibly can boilerplate a brand new Vite app with the next:

npm create vite@newest

New Vite application console output

Then begin the event server like so:

npm run dev

Now, navigate to the displayed localhost URL in your browser.

Vite application running locally

Vite will create a listing containing the information pictured under.

Vite folder structure

Many of those will likely be acquainted to you and will likely be like-for-like replacements in your personal software.

Step 2: Make package deal.json Adjustments

To start utilizing Vite in your present Webpack challenge, head over to the package deal.json of the Webpack challenge you wish to migrate and set up Vite:

npm set up –save vite

Relying in your frontend framework, you might also wish to set up the framework-specific plugin:

npm set up –save @vitejs/plugin-react

You may as well replace any construct scripts you must use Vite as an alternative of Webpack:

"construct": "webpack --mode manufacturing","dev": "webpack serve",
++   "construct": "vite construct",
++  "dev": "vite serve",

On the similar time, uninstall Webpack:

npm uninstall –save webpack webpack-cli wepack-dev-server

Now run your improvement script to attempt it out!

npm run dev

Step 3: Out with webpack.config, in with vite.config

Except you’re extraordinarily fortunate, you’ll most definitely want to incorporate some further configuration. Vite makes use of the vite.config.js file for configuration, which is essentially analogous to your present webpack.config.js file.

You will discover the complete documentation for this Vite config on vitejs.dev, however a easy Vite configuration for a React app may appear like this:

import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'

export default defineConfig({
  plugins: [react()],
  },
})

Step 4: Plugins

Beneath the hood, Vite makes use of Rollup as its construct software, and you may add any Rollup plugins to Vite by putting in them with npm:

npm set up –save @rollup/plugin-image

`

Additionally add them into the plugins array your vite.config.js file:


import picture from '@rollup/plugin-image'
import { defineConfig } from 'vite'

export default defineConfig({
  plugins: [
      image(),
  ],
})

Well-liked Webpack Plugins and their Vite Equivalents

Let’s subsequent take a look at some well-liked Webpack plugins and their Vite equivalents.

HtmlWebpackPlugin -> vite-plugin-html

HtmlWebpackPlugin simplifies the creation of HTML information to serve your Webpack bundles. In case you’re utilizing HtmlWebpackPlugin in your challenge, Vite has the vite-plugin-html plugin, which supplies related capabilities. You possibly can set up it like so:

npm set up --save-dev vite-plugin-html

And import into your vite.config.js like so:

import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'
import { createHtmlPlugin } from 'vite-plugin-html'

export default defineConfig({
  plugins: [
    react(),
    createHtmlPlugin({
      entry: 'src/main.js',
      template: 'public/index.html',
      inject: {
        data: {
          title: 'index',
          injectScript: `<script src="https://www.sitepoint.com/webpack-vite-migration/./inject.js"></script>`,
        },
    })
  ]
})

MiniCssExtractPlugin is a plugin for Webpack that extracts CSS into separate information. It creates a CSS file for every JavaScript file that incorporates CSS. It’s sometimes utilized in manufacturing environments to facilitate extra environment friendly loading of CSS. The advantage of that is twofold. Firstly, it permits CSS to be cached individually by the browser. Secondly, it prevents a flash of unstyled content material, as CSS is now not embedded within the JavaScript information and might thus be loaded in parallel with JavaScript, leading to sooner web page load instances.

In Vite, you should utilize vite-plugin-purgecss:

npm set up --save-dev vite-plugin-html-purgecss

Use the plugin in your vite.config.js file like so:

import htmlPurge from 'vite-plugin-html-purgecss'

export default {
    plugins: [
        htmlPurge(),
    ]
}

CopyWebpackPlugin -> vite-plugin-static-copy

CopyWebpackPlugin is used to repeat particular person information or whole directories to the construct listing. Vite has an analogous plugin referred to as vite-plugin-static-copy:

npm set up --save-dev vite-plugin-static-copy

Put the next code into vite.config.js:

import { viteStaticCopy } from 'vite-plugin-static-copy'

export default {
  plugins: [
    viteStaticCopy({
      targets: [
        {
          src: 'bin/example.wasm',
          dest: 'wasm-files'
        }
      ]
    })
  ]
}

DefinePlugin -> outline()

In Webpack, the DefinePlugin is used to interchange tokens within the supply code with their assigned values at compile time. This lets you create world constants that may be configured at compile time. In Vite, you’ll be able to obtain the identical impact utilizing the outline possibility in vite.config.js, so you could not want a plugin:

export default defineConfig({
  outline: {
    'course of.env.NODE_ENV': JSON.stringify('manufacturing'),
  },
})

Conclusion

This has been a easy information to migrating a frontend Webpack software to Vite, together with among the hottest Webpack plugins.

In case your challenge is a big, advanced one with an intricate construct course of, Webpack’s feature-rich and versatile configuration could also be nonetheless your best option.

In case you’re migrating a smaller or reasonable challenge, Vite does presents some compelling advantages. Its velocity, each when it comes to the server start-up and sizzling module substitute, can considerably increase improvement productiveness. The simplicity of its configuration can be a welcome respite, and its being designed with native ES Modules and trendy framework compatibility in thoughts units it up properly for the longer term.

Transitioning from Webpack to Vite does require cautious planning and testing, significantly when contemplating plugin replacements or refactoring. However the rewards of this transfer could be substantial. Vite presents a sooner, leaner improvement surroundings that may finally result in a smoother and extra environment friendly improvement workflow.

It’s at all times helpful to keep watch over the evolving panorama of instruments. As you proceed your journey, take into account additionally exploring different trendy instruments like esbuild and Parcel to seek out one of the best match to your challenge wants.

Keep in mind, the software isn’t what issues most, however how you employ it to attain your goals. Webpack, Vite, esbuild, and Parcel are all glorious instruments designed that can assist you create top-notch internet tasks, and one of the best one to make use of is dependent upon your particular wants and constraints.

If you wish to discover Vite additional, take a look at our article the place we discover Vite by its supply code.





Supply hyperlink

More articles

LEAVE A REPLY

Please enter your comment!
Please enter your name here

Latest article