rollup node modules external
Easily exclude node modules in rollup, forked from webpack-node-externals
rollup allows you to define external - modules that should not be bundled.
When bundling with rollup for the backend - you usually don't want to bundle its
node_modules dependencies.
This library creates an external function that ignores node_modules when bundling in rollup.Forked from liady/webpack-node-externals
Quick usage
npm install @yelo/rollup-node-external --save-devIn your
rollup.config.js:
var external = require('@yelo/rollup-node-external');
...
module.exports = {
...
external: external(), // in order to ignore all modules in node_modules folder
plugins: [
...
// import node-resolve plugin
require('rollup-plugin-node-resovle')(),
...
],
...
};require('module').Detailed overview
Description
This library scans thenode_modules folder for all nodemodules names, and builds an external function that tells rollup not to bundle those modules, or any sub-modules of theirs.Configuration
This library accepts anoptions object.options.whitelist (=[])
An array for the external to whitelist, so they will be included in the bundle. Can accept exact strings ('module_name'), regex patterns (/^module_name/), or a function that accepts the module name and returns whether it should be included.
Important - if you have set aliases in your rollup config with the exact same names as modules in nodemodules, you need to whitelist them so rollup will know they should be bundled.
options.importType (='commonjs')
The method in which unbundled modules will be required in the code. Best to leave as commonjs for node modules.options.modulesDir (='node_modules')
The folder in which to search for the node modules.options.modulesFromFile (=false)
Read the modules from the package.json file instead of the node_modules folder.Example
var external = require('@yelo/rollup-node-external');
...
module.exports = {
...
external: external({
// this WILL include `jquery` and `rollup/hot/dev-server` in the bundle, as well as `lodash/*`
whitelist: ['jquery', 'rollup/hot/dev-server', /^lodash/]
}),
plugins: [
...
require('rollup-plugin-node-resovle')(),
...
],
...
};importType and modulesDir should be used.Test
npm run test