Package Exports

butternut

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (butternut) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Butternut

The fast, future-friendly minifier

Warning: this is alpha software. Test thoroughly before using in production! Consider using the check option. Please report any bugs you find!

Why?

Butternut is significantly faster than other JavaScript minifiers, and works with the latest version of JavaScript (ES2015, aka ES6, and beyond). It's typically around 4x faster than UglifyJS and 10-15x faster than Babili.

The compression is better than Babili and Closure Compiler (in standard compilation mode — you can get better results with Closure in advanced mode, but only by writing your code in a very particular way). It's almost as good as Uglify in its current version.

Note: UglifyJS supports ES2015+ as of very recently — see uglify-es.

Usage

The easiest way to use Butternut is to plug it into your existing build process:

rollup-plugin-butternut

Alternatively, you can use it directly via the CLI or the JavaScript API:

Command Line Interface

Install Butternut globally, then use the squash command:

npm install --global butternut # or npm i -g butternut
squash app.js > app.min.js

Run squash --help to see the available options.

JavaScript API

Install Butternut to your project...

npm install --save-dev butternut # or npm i -D butternut

...then use it like so:

const butternut = require('butternut');
const { code, map } = butternut.squash(source, options);

The options argument, if supplied, is an object that can have the following properties:

sourceMap — set to false if you don't want to generate a sourcemap. Defaults to true
file — the destination filename, used in sourcemap generation
source — the source filename, used in sourcemap generation
includeContent — whether to include the original source in the sourcemap. Defaults to true
check — see below

The `check` option

Since Butternut is a new project, it hasn't yet been battle-tested. It may generate code that you don't expect. If you pass check: true (or use the --check flag, if using the CLI), Butternut will parse the generated output to verify that it is valid JavaScript. If not, it means it's messed something up, in which case it will try to help you find the code that it failed to minify correctly.

If you find bugs while using Butternut, please raise an issue!

License

MIT

butternut