rollup-plugin-import-shaking

rollup-plugin-import-shaking

Import modules as needed.

Installation

npm install rollup-plugin-import-shaking --save-dev

Usage

rollup.config.js

Example

const empty = require('rollup-plugin-empty');
const importShaking = require('rollup-plugin-import-shaking');
const replaceImports = require('rollup-plugin-replace-imports');

module.exports = {
  input: 'src/index.js',
  plugins: [
    empty({
      silent: false,
      dir: 'dist'
    }),
    importShaking({
      modules: [{
        name: ['module1', 'module2'],
        importModule: (n, m) => `${m}/es/${n}`
      }]
    })
  ],
  output: [{
    file: 'dist/index.esm.js',
    format: 'es'
  }, {
    file: 'dist/index.cjs.js',
    format: 'cjs',
    plugins: [
      replaceImports({
        replacement(name) {
          return name.replace('/es/', '/');
        }
      })
    ]
  }]
};

Options

• name <string|string[]> - A package name
• importModule [function] - return a module path
• importStyle [function] - return a style path

export type handler = (namedExport: string, pkgName: string) => string;

export interface ModuleOption {
  name: string | string[];
  importModule?: handler | true;
  importStyle?: handler | true;
}

export interface Options {
  modules: ModuleOption[];
}

export function createPlugin(opts: Options): Plugin;

declare namespace plugin {
  export function createPlugin(opts: Options): Plugin;

  export function decamelize(name: string): string;
}

export default plugin;

Example

demo-import-shaking