npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@yelo/rollup-node-external

v1.0.1

Published

Easily exclude node_modules in Rollup bundle, forked from webpack-node-externals

Downloads

13,656

Readme

rollup node modules external

Easily exclude node modules in rollup, forked from webpack-node-externals

Version Downloads

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-dev

In 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')(),
        ...
    ],
    ...
};

And that's it. All node modules will no longer be bundled but will be left as require('module').

Detailed overview

Description

This library scans the node_modules folder for all node_modules names, and builds an external function that tells rollup not to bundle those modules, or any sub-modules of theirs.

Configuration

This library accepts an options 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 node_modules, 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')(),
        ...
    ],
    ...
};

For most use cases, the defaults of importType and modulesDir should be used.

Test

npm run test

License

MIT