acionyx / rollup-plugin-module-replacement

Plugin for replacing modules in Rollup

rollup-plugin-module-replacement

Replace modules when bundling packages with Rollup.

This can be useful for allowing different behaviour between builds.

Plugin can be used for simple aliasing too.

Furthermore it provides a way to chain aliasing with any resolving plugin (like rollup-plugin-node-resolve), see examples below.

Let's take a look at an example:

// rollup.config.js

import replacement from "rollup-plugin-module-replacement";

const appTarget = process.env.APP_TARGET || "VERSION_A";

export default {
  // ...
  plugins: [
    replacement({
      entries: [
        {
          find: /(.*)-APP_TARGET(\.*)/,
          replacement: importee =>
            importee.replace(/-APP_TARGET/, `-${appTarget}`)
        }
      ]
    })
  ]
};

If replacement is a String, find will be simply replaced with it. If replacement is a function, it is expected to return a String containing new path.

Plugin does not make any resolve logic under the hood. If you want files to be resolved with any plugin, see Advanced usage section below.

For Webpack users: This is a plugin to basically mimic the NormalModuleReplacementPlugin functionality in Rollup.

Installation

$ npm install --save-dev rollup-plugin-module-replacement
OR
$ yarn add -D rollup-plugin-module-replacement

Usage

// rollup.config.js
import replacement from "rollup-plugin-module-replacement";

export default {
  // ...
  plugins: [
    replacement({
      entries: [
        {
          find: /(.*)-APP_TARGET(\.*)/,
          replacement: importee =>
            importee.replace(/-APP_TARGET/, `-${appTarget}`)
        }
      ]
    })
  ]
};

The order of the entries is important, in that the first rules are applied first.

You can use either simple Strings or Regular Expressions to search in a more distinct and complex manner (e.g. to do partial replacements via subpattern-matching, see aboves example).

Advanced usage

In most situations you would like to keep preferred resolving method together with aliasing. It is a common issue with plugins like rollup-plugin-alias, because they do their resolve algorithm under the hood and it may not suit your needs.

So how to keep aliases together with your resolve algorithm like rollup-plugin-node-resolve?

It is very easy to do, see example below.

// rollup.config.js
import replacement from "rollup-plugin-module-replacement";
import resolve from "rollup-plugin-node-resolve";

const customResolver = resolve({
  extensions: [".mjs", ".js", ".jsx", ".json", ".sass", ".scss"]
});
const projectRootDir = path.resolve(__dirname);

export default {
  // ...
  plugins: [
    replacement(
      {
        entries: [
          {
            find: "src",
            replacement: path.resolve(projectRootDir, "src")
            // OR place `customResolver` here. See explanation below.
          }
        ]
      },
      customResolver
    ),
    resolve()
  ]
};

In example below we made an alias src and still keep node-resolve algorithm for your files that are "aliased" with src by passing customResolver option. Also we keep resolve() plugin separately in plugins list for other files that are not aliased with src.

customResolver option can be passed inside each entree too for granular control over resolving.

customResolver also can be your own function, not plugin.

In same manner you can chain other plugins by using rollup-plugin-module-replacement architecture.

License

MIT, see LICENSE for more information

rollup-plugin-module-replacement's Issues

[feature request] Use TypeScript instead

Rollup and its plugins are all using TypeScript now.

I'm using the following for workaround, but not sure if it is correct:

declare module 'rollup-plugin-module-replacement' {
  import { Plugin } from 'rollup'

  export interface ModuleReplacementPluginOptions {
    entries: Array<{
      find: RegExp
      replacement: string | ((importee: string) => string)
    }>
    customResolver?:
      | Plugin
      | ((updatedId: string, importerId: string) => string)
  }

  const replacement: (options?: ModuleReplacementPluginOptions) => Plugin

  export default replacement
}

Provide include/exclude options

Hello
Thanks for plugin ❤️

Can you please add options include/exclude
It should be great for direct replace in several files