nolanlawson/rollup-plugin-inline-typeof

README

rollup-plugin-inline-typeof

Rollup plugin to scan for typeof invocations (and similar expressions like foo === undefined) and replace them with functions so that JavaScript engines can inline them.

This can reduce bundle size and speed up JavaScript execution, as inspired by InfernoJS. See Why for more details.

Note: very experimental. Please use with care, check your bundle size, and run benchmarks to confirm it's a boost and not a regression.

Installation

npm install --save-dev rollup-plugin-inline-typeof

Usage

var rollup = require('rollup').rollup;
var inlineTypeof = require('rollup-plugin-inline-typeof');

rollup({
  entry: 'main.js',
  plugins: [
    inlineTypeof()
  ]
}).then(...)

Examples

Example input:

if (typeof foo === 'undefined') {
  console.log('yolo');
}

Output:

function isUndefined (x) { return typeof x === "undefined" }

if (isUndefined(foo)) {
  console.log('yolo');
}

Or we can get fancier:

if (typeof foo === 'undefined' && foo === null) {
  console.log('yolo');
}

if (typeof foo === 'boolean' || typeof foo !== 'function' || typeof foo !== 'undefined') {
  console.log('haha')
}

Output:

function isUndefined (x) { return typeof x === "undefined" }
function isFunction (x) { return typeof x === "function" }
function isBoolean (x) { return typeof x === "boolean" }
function isNull (x) { return x === null }

if (isUndefined(foo) && isNull(foo)) {
  console.log('yolo');
}

if (isBoolean(foo) || !isFunction(foo) || !isUndefined(foo)) {
  console.log('haha');
}

Why?

I was inspired by Dominic Gannaway's interview about InfernoJS explaining some of the optimizations they used. This one caught my eye:

Inferno prefers the usage of helper functions that all get inlined by a JIT compiler – for example, rather than doing foo === null, doing isNull(foo). We found that this really helped improve bundle size, and in some cases it also improved JIT performance.

You can see how Inferno does this using this utlity module. However, replacing all typeof invocations in a large codebase is time-consuming, and results in harder-to-maintain code. Wouldn't it be nice if we could automate this at build time?

That's exactly what this plugin does. For each category of typeof (including foo === null and foo === undefined), we define a Rollup module (e.g. isNull(), isUndefined()), and replace each invocation of typeof with a function call.

Since Rollup handles all module definitions, we can guarantee that there will only be one instance of each function for the entire bundle, and we can also guarantee that collisions will be intelligently handled. (Rollup will replace the function names with isNull$1() etc. in the case of collisions.)

Notes

In your list of plugins, you should probably put inlineTypeof() first because it may conflict with other plugins (such as rollup-plugin-commonjs).

Credits

Thanks to Rich Harris for rollup-plugin-inject and Alex Lur for rollup-plugin-ignore which I based this codebase off of.

README

rollup-plugin-inline-typeof

Rollup plugin to scan for typeof invocations (and similar expressions like foo === undefined) and replace them with functions so that JavaScript engines can inline them.

This can reduce bundle size and speed up JavaScript execution, as inspired by InfernoJS. See Why for more details.

Note: very experimental. Please use with care, check your bundle size, and run benchmarks to confirm it's a boost and not a regression.

Installation

npm install --save-dev rollup-plugin-inline-typeof

Usage

var rollup = require('rollup').rollup;
var inlineTypeof = require('rollup-plugin-inline-typeof');

rollup({
  entry: 'main.js',
  plugins: [
    inlineTypeof()
  ]
}).then(...)

Examples

Example input:

if (typeof foo === 'undefined') {
  console.log('yolo');
}

Output:

function isUndefined (x) { return typeof x === "undefined" }

if (isUndefined(foo)) {
  console.log('yolo');
}

Or we can get fancier:

if (typeof foo === 'undefined' && foo === null) {
  console.log('yolo');
}

if (typeof foo === 'boolean' || typeof foo !== 'function' || typeof foo !== 'undefined') {
  console.log('haha')
}

Output:

function isUndefined (x) { return typeof x === "undefined" }
function isFunction (x) { return typeof x === "function" }
function isBoolean (x) { return typeof x === "boolean" }
function isNull (x) { return x === null }

if (isUndefined(foo) && isNull(foo)) {
  console.log('yolo');
}

if (isBoolean(foo) || !isFunction(foo) || !isUndefined(foo)) {
  console.log('haha');
}

Why?

I was inspired by Dominic Gannaway's interview about InfernoJS explaining some of the optimizations they used. This one caught my eye:

Inferno prefers the usage of helper functions that all get inlined by a JIT compiler – for example, rather than doing foo === null, doing isNull(foo). We found that this really helped improve bundle size, and in some cases it also improved JIT performance.

Notes

In your list of plugins, you should probably put inlineTypeof() first because it may conflict with other plugins (such as rollup-plugin-commonjs).

Credits

Thanks to Rich Harris for rollup-plugin-inject and Alex Lur for rollup-plugin-ignore which I based this codebase off of.

gem-hunter