vite-plugin-duplicate-packages

Vite plugin for helping to deal with duplicate packages.

Installation

npm install @christiango/vite-plugin-duplicate-packages
# or
yarn add @christiango/vite-plugin-duplicate-packages

Usage

Add the plugin to your vite.config.js or vite.config.ts:

import { defineConfig } from 'vite';
import { duplicatePackagesPlugin } from '@christiango/vite-plugin-duplicate-packages';

export default defineConfig({
  plugins: [
    duplicatePackagesPlugin({
      // options
    }),
  ],
});

Options

deduplicateDoppelgangers

• Type: boolean
• Default: false

Automatically deduplicate NPM/Yarn doppelgangers. Doppelgangers are packages that exist in multiple versions but one version is never actually used (phantom dependency). When enabled, the plugin will eliminate duplicate packages of the same version that are bundled multiple times from different locations in the dependency tree.

For more information about doppelgangers, see Rush.js documentation on NPM doppelgangers.

Example:

duplicatePackagesPlugin({
  deduplicateDoppelgangers: true,
});

When enabled, if you have:

• [email protected] in node_modules/dep-x/node_modules/package-a
• [email protected] in node_modules/dep-y/node_modules/package-a
• [email protected] in node_modules/package-a (unused)

The plugin will deduplicate the two instances of [email protected], reducing your bundle size.

exceptions

• Type: { [packageName: string]: { maxAllowedVersionCount: number } }
• Default: {}

Configure exceptions for packages that are allowed to have multiple versions in the bundle. This is useful for cases where duplicate packages cannot be avoided.

Example:

duplicatePackagesPlugin({
  exceptions: {
    react: { maxAllowedVersionCount: 2 },
    lodash: { maxAllowedVersionCount: 3 },
  },
});

With this configuration:

• react can have up to 2 versions in the bundle without causing an error
• lodash can have up to 3 versions in the bundle without causing an error
• Any other package with multiple versions will cause a build error

Important: The plugin will throw an error if you define an exception for a package that is not found in the bundle or doesn't have duplicates. This helps keep your configuration clean and up-to-date.

Features

Duplicate Package Detection

By default, the plugin analyzes your bundle and throws an error if multiple versions of the same package are detected. This helps prevent issues caused by having different versions of the same library in your bundle.

Example error message:

Duplicate packages detected in bundle:

  • react: 17.0.2, 18.2.0

Multiple versions of the same package can cause runtime errors and increase bundle size.

When duplicates are detected, the build will fail with a clear error message showing which packages have multiple versions.