aminnairi/rollup-plugin-external

README

@aminnairi/rollup-plugin-external

Rollup plugin for automatically computing your external dependencies.

Summary

Requirements
Installation
Usage
- ECMAScript
- TypeScript
Options
Changelog
Contributing
License

Requirements

Node.js
NPM

Installation

$ npm install --save-dev @aminnairi/rollup-plugin-external

Usage

ECMAScript

import {external} from "@aminnairi/rollup-plugin-external";

export default {
  plugins: [
    external()
  ]
};

TypeScript

import {external, ExternalOptions} from "@aminnairi/rollup-plugin-external";

const externalOptions: ExternalOptions = {
  withBuiltinModules: false
};

export default {
  plugins: [
    external(externalOptions)
  ]
}

Options

exclude

Modules to exclude from the Rollup's external configuration (default to []).

external({
  exclude: ["package", "to", "exclude"]
});

include

Modules to include in the Rollup's external configuration (default to []).

external({
  include: ["package", "to", "include"]
});

packageJsonPath

Path to the module configuration (default to package.json).

external({
  packageJsonPath: "./settings/package.production.json"
});

withBuiltinModules

Whether to include or not Node.js builtin modules in the Rollup's external configuration (default to true).

external({
  withBuiltinModules: false
});

withBundledDependencies

Whether to include or not bundledDependencies in the Rollup's external configuration (default to true).

external({
  withBundledDependencies: false
});

withDependencies

Whether to include or not dependencies in the Rollup's external configuration (default to true).

external({
  withDependencies: false
});

withOptionalDependencies

Whether to include or not optionalDependencies in the Rollup's external configuration (default to true).

external({
  withOptionalDependencies: false
});

withPeerDependencies

Whether to include or not peerDependencies in the Rollup's external configuration (default to true).

external({
  withPeerDependencies: false
});

README