Skip to content

Latest commit

 

History

History
72 lines (53 loc) · 2.64 KB

README.md

File metadata and controls

72 lines (53 loc) · 2.64 KB

autoroll

npm version dependency status install size license

This is a multipurpose configuration file for rollup. It reads your package.json file and automatically extracts relevant information.

Usage

Put this in your rollup.config.js:

module.exports = require('autoroll')();

That's all. Now it generates UMD bundles from ES6 sources. Entry point paths are configured in de facto standard package.json fields which you should set up anyway:

  • browser
  • main
  • module

If you have dependencies, to avoid bloat they don't get bundled by default. You can include specific dependencies in the UMD bundle by listing them in rollup.config.js:

module.exports = require('autoroll')(
  {
    include: [
      'some',
      'dependencies'
    ]
  }
);

They are looked up from the current working directory (package root in npm scripts), under node_modules. Each package should have a package.json file with a module or main field defining an ES6 entry point.

There is special support for boennemann/alle. If an alle-style directory contains a subdirectory node_modules with several packages belonging to the same monorepo, autoroll can create a separate bundle for each one. Entry points and bundle paths are configured in package.json files for each package.

For example packages under packages/node_modules can be bundled with the following rollup.config.js:

module.exports = require('autoroll')({ alle: 'packages' });

Any more complicated setup should use a traditional rollup config file with plugins like rollup-plugin-node-resolve and rollup-plugin-commonjs. This package is for avoiding build system bloat in simpler cases.

For testing packages with old Node.js versions (lack of modern JavaScript features can resemble old mobile browsers), it can be helpful to run rollup conditionally in package scripts using the included checkver tool:

{
  "prepublish": "(checkver ge 5.0.0 && rollup -c)"
}

License

The MIT License

Copyright (c) 2018- BusFaster Ltd