rollup-plugin-terser
Advanced tools
Package description
The rollup-plugin-terser package is a plugin for Rollup, a module bundler for JavaScript, which allows you to minify your JavaScript files using Terser. Minification is the process of removing unnecessary characters from code to reduce its size, thus improving load times in browsers. This plugin integrates Terser into the Rollup build process.
Minification
This feature allows you to minify your JavaScript files. The code sample shows how to include the terser plugin in the Rollup configuration to minify the output bundle.
import { terser } from 'rollup-plugin-terser';
export default {
input: 'src/index.js',
output: {
file: 'bundle.min.js',
format: 'iife'
},
plugins: [
terser()
]
};Compress Options
This feature allows you to specify Terser compress options to customize the minification process. In the code sample, the `drop_console` option is set to `true` to remove console logs from the output.
import { terser } from 'rollup-plugin-terser';
export default {
// ... other rollup config
plugins: [
terser({
compress: {
drop_console: true
}
})
]
};Mangle Options
This feature allows you to mangle property names matching a pattern to shorten the code. In the code sample, properties starting with an underscore are mangled.
import { terser } from 'rollup-plugin-terser';
export default {
// ... other rollup config
plugins: [
terser({
mangle: {
properties: {
regex: /^_/
}
}
})
]
};Source Maps
This feature allows you to generate source maps for the minified code, which can be useful for debugging purposes. The code sample demonstrates how to enable source map generation in the Rollup configuration.
import { terser } from 'rollup-plugin-terser';
export default {
// ... other rollup config
output: {
// ... other output options
sourcemap: true
},
plugins: [
terser({
sourceMap: true
})
]
};Similar to rollup-plugin-terser, rollup-plugin-uglify is a plugin that minifies JavaScript files using UglifyJS. It offers similar functionality but uses a different minification library. Terser is a fork of UglifyJS with ES6+ support.
This package is another Rollup plugin for minifying JavaScript, but it uses babel-minify (formerly known as babili) instead of Terser. It can be a good choice if you are already using Babel in your build process.
This plugin uses Google's Closure Compiler for minifying JavaScript. It is known for its advanced optimizations and is a good choice for projects where performance is a critical concern. However, it may be more complex to configure compared to rollup-plugin-terser.
Readme
Rollup plugin to minify generated es bundle. Uses terser under the hood.
yarn add rollup-plugin-terser --dev
# Or with npm:
npm i rollup-plugin-terser --save-dev
Note: this package requires rollup@0.66 and higher (including rollup@2.0.0)
import { rollup } from "rollup";
import { terser } from "rollup-plugin-terser";
rollup({
input: "main.js",
plugins: [terser()],
});
⚠️ Caveat: any function used in options object cannot rely on its surrounding scope, since it is executed in an isolated context.
terser(options);
options - terser API options
Note: some terser options are set by the plugin automatically:
module: true is set when format is esm or estoplevel: true is set when format is cjsoptions.numWorkers: number
Amount of workers to spawn. Defaults to the number of CPUs minus 1.
// rollup.config.js
import { terser } from "rollup-plugin-terser";
export default {
input: "index.js",
output: [
{ file: "lib.js", format: "cjs" },
{ file: "lib.min.js", format: "cjs", plugins: [terser()] },
{ file: "lib.esm.js", format: "esm" },
],
};
If you'd like to preserve comments (for licensing for example), then you can specify a function to do this like so:
terser({
output: {
comments: function (node, comment) {
var text = comment.value;
var type = comment.type;
if (type == "comment2") {
// multiline comment
return /@preserve|@license|@cc_on/i.test(text);
}
},
},
});
Alternatively, you can also choose to keep all comments (e.g. if a licensing header has already been prepended by a previous rollup plugin):
terser({
output: {
comments: "all",
},
});
See Terser documentation for further reference.
MIT © Bogdan Chadkin
FAQs
Rollup plugin to minify generated es bundle
The npm package rollup-plugin-terser receives a total of 3,551,671 weekly downloads. As such, rollup-plugin-terser popularity was classified as popular.
We found that rollup-plugin-terser demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.