@swissquote/crafty-runner-rollup v1.22.3

Description

rollup.js is a module bundler for JavaScript which compiles small pieces of code into something larger and more complex, such as a library or application.

rollup.js works well with libraries because it's able to output files with EcmaScript 2015 exports which allow for advanced tree shaking.

The rollup.js integration is experimental and has some issues that are known and some that are not pinpointed yet.

TOC

Features

• Bundle your JavaScript using EcmaScript 2015 imports or commonjs imports
• Your code is Uglified after compilation.
• Configurable output formats
• Watch mode, re-compiles your files on changes

Options

We don't provide any option to configure rollup.js outside bundles, but as crafty.config.js is considered as a preset, you can define the rollup override method in your configuration file and change the configuration to your needs.

Check the Extending the configuration section below for more information on that.

Bundle Options

The rollup.js preset is compatible with our Babel and TypeScript

inlineRuntime / put @babel/runtime inline or keep it as imports

Default: true when nothing is specified, and to false when a dependency to @babel/runtime is found.

When compiling newer EcmaScript to older versions, some helper functions can be needed to make it work. For example functions to create classes, rest, spread, etc...

These helpers are quite small, however, if you are creating a library which will be included in another project, your bundle might end up containing the library along with the copies that the final project will contain as well.

A way to reduce this cost is instead of having these helpers inline is to keep them as imports.

// This
function _classCallCheck(instance, Constructor) {
  /* */
}
function _defineProperties(target, props) {
  /* */
}
function _createClass(Constructor, protoProps, staticProps) {
  /* */
}

// Becomes
import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
import _createClass from "@babel/runtime/helpers/createClass";

The way to do this is by adding a dependency to @babel/runtime in your project's package.json.

If for some reason you need a dependency to @babel/runtime but still wish helpers to be inline, you can force it with inlineRuntime: true.

Extending the configuration

Each preset and crafty.config.js can define the rollup(crafty, bundle, rollupConfig) function to override rollup.js' configuration.

module.exports = {
  /**
   * Represents the extension point for rollup.js configuration
   * @param {Crafty} crafty - The instance of Crafty.
   * @param {Object} bundle - The bundle that is being prepared for build (name, input, source, destination)
   * @param {Object} rollupConfig - The current rollup.js configuration (input, output, watch)
   */
  rollup(crafty, bundle, rollupConfig) {
    // Mutate any of rollupConfig.input, rollupConfig.output or rollupConfig.watch to your liking
  }
};

The full list of available configuration option is available on the official website.

The difference with the official configuration is how plugins are handled. The section below explains how plugins are configured.

Adding / modifying plugins

In rollup.js, plugins are functions that are called with their options.

As we want to be able to override those options during the preparation phase of the runner, those plugins are presented in the following way :

Here is an example of how the rollup-plugin-eslint is integrated into rollup.js .

const rollupEslint = require("rollup-plugin-eslint");

module.exports = {
  /**
   * Represents the extension point for rollup configuration
   * @param {Crafty} crafty - The instance of Crafty.
   * @param {Object} bundle - The bundle that is being prepared for build (name, input, source, destination)
   * @param {string} rollupConfig - The current rollup configuration (input, output, watch)
   */
  rollup(crafty, bundle, rollupConfig) {
    // rollupConfig.input.plugins is an object during preparation phase with four possible keys :
    // - plugin : the function to initialize the plugin
    // - options : A configuration object, will be passed to the function as a first parameter upon initialization
    // - weight : (optional) The weight of the plugin, used to define the order in which the plugins are run (A weight of 0 is applied if this key is omitted)
    // - init : (optional) A function that Returns an instance of the plugin. The default is : `(plugin) => plugin.plugin(plugin.options)`

    rollupConfig.input.plugins.eslint = {
      plugin: rollupEslint,
      weight: -20,
      options: {
        ...crafty.config.eslint,
        throwOnError: crafty.getEnvironment() === "production",
        exclude: ["node_modules/**"],
        include: ["**/*.js", "**/*.jsx"]
      }
    };
  }
};

Known issues

• If you have two bundles that run with rollup.js, if one fails, the second one stops as well.
• ESLint stops linting after the first file in error, this shouldn't be the case.