This plugin minifies your assets in a webpack build. It ships with several
built-in minimizers covering JavaScript, JSON, and HTML — pick one with the
minify option and target the right files with test.
JavaScript minimizers:
terser—TerserPlugin.terserMinify(default). The same JavaScript-based minifier that webpack uses out of the box; produces small, well-tested output and supports the full set ofextractCommentsmodes.uglify-js—TerserPlugin.uglifyJsMinify. ES5-only minifier, useful when you specifically need UglifyJS-compatible output. Requiresnpm install --save-dev uglify-js.@swc/core—TerserPlugin.swcMinify. A very fast Rust-based JavaScript/TypeScript minifier. Requiresnpm install --save-dev @swc/core.esbuild—TerserPlugin.esbuildMinify. An extremely fast JS bundler/minifier; legal comments are always preserved (noextractCommentssupport). Requiresnpm install --save-dev esbuild.
JSON minimizer:
JSON.stringify—TerserPlugin.jsonMinify. Built in (no extra dependency); supportsspaceandreplaceroptions.
HTML minimizers:
html-minifier-terser—TerserPlugin.htmlMinifierTerser. The default HTML minimizer. JavaScript-based, no native dependency. Requiresnpm install --save-dev html-minifier-terser.@swc/html—TerserPlugin.swcMinifyHtml(full HTML documents) andTerserPlugin.swcMinifyHtmlFragment(HTML fragments, e.g.<template>content). Very fast Rust-based platform for the Web. Requiresnpm install --save-dev @swc/html.@minify-html/node—TerserPlugin.minifyHtmlNode. A Rust HTML minifier optimised for speed and effectiveness. Requiresnpm install --save-dev @minify-html/node.
All of the non-default minimizers are declared as optional peer
dependencies — install only the ones you actually use. You can also stack
multiple TerserPlugin instances in the same build to handle different
file types with different minimizers (see Examples).
Webpack v5 comes with the latest terser-webpack-plugin out of the box.
If you are using Webpack v5 or above and wish to customize the options, you will still need to install terser-webpack-plugin.
Using Webpack v4, you have to install terser-webpack-plugin v4.
To begin, you'll need to install terser-webpack-plugin:
npm install terser-webpack-plugin --save-devor
yarn add -D terser-webpack-pluginor
pnpm add -D terser-webpack-pluginThen add the plugin to your webpack configuration. For example:
webpack.config.js
const TerserPlugin = require("terser-webpack-plugin");
module.exports = {
optimization: {
minimize: true,
minimizer: [new TerserPlugin()],
},
};Finally, run webpack using the method you normally use (e.g., via CLI or an npm script).
Works only with source-map, inline-source-map, hidden-source-map and nosources-source-map values for the devtool option.
Why?
evalwraps modules ineval("string")and the minimizer does not handle strings.cheaphas no column information and the minimizer generates only a single line, which leaves only a single mapping.
Using supported devtool values enable source map generation.
Type:
type test = string | RegExp | (string | RegExp)[];Default: /\.m?js(\?.*)?$/i
Test to match files against.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
test: /\.js(\?.*)?$/i,
}),
],
},
};Type:
type include = string | RegExp | (string | RegExp)[];Default: undefined
Files to include.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
include: /\/includes/,
}),
],
},
};Type:
type exclude = string | RegExp | (string | RegExp)[];Default: undefined
Files to exclude.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
exclude: /\/excludes/,
}),
],
},
};Type:
type parallel = boolean | number;Default: true
Use multi-process parallel running to improve the build speed.
Default number of concurrent runs: os.cpus().length - 1 or os.availableParallelism() - 1 (if this function is supported).
Note
Parallelization can speedup your build significantly and is therefore highly recommended.
Warning
If you use Circle CI or any other environment that doesn't provide the real available count of CPUs then you need to explicitly set up the number of CPUs to avoid
Error: Call retries were exceeded(see #143, #202).
Enable/disable multi-process parallel running.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
parallel: true,
}),
],
},
};Enable multi-process parallel running and set number of concurrent runs.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
parallel: 4,
}),
],
},
};Type:
type minifyFn = (
input: Record<string, string>,
sourceMap: import("@jridgewell/trace-mapping").SourceMapInput | undefined,
minifyOptions: {
module?: boolean | undefined;
ecma?: import("terser").ECMA | undefined;
},
extractComments:
| boolean
| "all"
| "some"
| RegExp
| ((
astNode: any,
comment: {
value: string;
type: "comment1" | "comment2" | "comment3" | "comment4";
pos: number;
line: number;
col: number;
},
) => boolean)
| {
condition?:
| boolean
| "all"
| "some"
| RegExp
| ((
astNode: any,
comment: {
value: string;
type: "comment1" | "comment2" | "comment3" | "comment4";
pos: number;
line: number;
col: number;
},
) => boolean)
| undefined;
filename?: string | ((fileData: any) => string) | undefined;
banner?:
| string
| boolean
| ((commentsFile: string) => string)
| undefined;
}
| undefined,
) => Promise<{
code: string;
map?: import("@jridgewell/trace-mapping").SourceMapInput | undefined;
errors?: (string | Error)[] | undefined;
warnings?: (string | Error)[] | undefined;
extractedComments?: string[] | undefined;
}>;
type minify = minifyFn | minifyFn[];Default: TerserPlugin.terserMinify
Allows you to override the default minify function. By default plugin uses terser package. Useful for using and testing unpublished versions or forks.
An array of functions can also be provided to chain multiple minimizers — the output of each minimizer is fed as input to the next. When an array is used, the minimizerOptions option may also be an array (index-paired with minify) or a single object that is reused for every minimizer.
Warning
Always use
requireinsideminifyfunction whenparalleloption enabled.
webpack.config.js
// Can be async
const minify = (input, sourceMap, minimizerOptions, extractsComments) => {
// The `minimizerOptions` argument contains options from the `minimizerOptions` plugin option
// You can use `minimizerOptions.myCustomOption`
// Custom logic for extract comments
const { map, code } = require("uglify-module") // Or require('./path/to/uglify-module')
.minify(input, {
/* Your options for minification */
});
return { map, code, warnings: [], errors: [], extractedComments: [] };
};
// Used to regenerate `fullhash`/`chunkhash` between different implementation
// Example: you fix a bug in custom minimizer/custom function, but unfortunately webpack doesn't know about it, so you will get the same fullhash/chunkhash
// to avoid this you can provide version of your custom minimizer
// You don't need if you use only `contenthash`
minify.getMinimizerVersion = () => {
let packageJson;
try {
packageJson = require("uglify-module/package.json");
} catch (error) {
// Ignore
}
return packageJson && packageJson.version;
};
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
minimizerOptions: {
myCustomOption: true,
},
minify,
}),
],
},
};If an array of functions is passed to the minify option, the output of each
minimizer is fed as input to the next one. The minimizerOptions option can be
either an array of option objects (index-paired with minify) or a single
object that will be shared by all minimizers. Warnings, errors and extracted
comments from all minimizers are merged together.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
minify: [TerserPlugin.terserMinify, TerserPlugin.swcMinify],
// `minimizerOptions` can be an array of options, one per `minify` entry
minimizerOptions: [
// Options for `TerserPlugin.terserMinify`
{ mangle: false },
// Options for `TerserPlugin.swcMinify`
{},
],
}),
],
},
};Type:
interface minimizerOptions {
compress?: boolean | CompressOptions;
ecma?: ECMA;
enclose?: boolean | string;
ie8?: boolean;
keep_classnames?: boolean | RegExp;
keep_fnames?: boolean | RegExp;
mangle?: boolean | MangleOptions;
module?: boolean;
nameCache?: object;
format?: FormatOptions;
/** @deprecated */
output?: FormatOptions;
parse?: ParseOptions;
safari10?: boolean;
sourceMap?: boolean | SourceMapOptions;
toplevel?: boolean;
}
type options = minimizerOptions | minimizerOptions[];Default: default
Options for the active minimizer. With the default Terser minify, see Terser's minify options.
When the minify option is an array of minimizers, minimizerOptions
can also be an array. Each element is passed to the minimizer at the same
index in the minify array. If a single object is provided instead, it is
reused for every minimizer.
Note
terserOptionsis kept as a deprecated alias ofminimizerOptionsfor backwards compatibility — passing either is equivalent. If both are set,minimizerOptionswins. PreferminimizerOptionsin new code.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
minimizerOptions: {
ecma: undefined,
parse: {},
compress: {},
mangle: true, // Note `mangle.properties` is `false` by default.
module: false,
// Deprecated
output: null,
format: null,
toplevel: false,
nameCache: null,
ie8: false,
keep_classnames: undefined,
keep_fnames: false,
safari10: false,
},
}),
],
},
};Type:
type extractComments =
| boolean
| string
| RegExp
| ((
astNode: any,
comment: {
value: string;
type: "comment1" | "comment2" | "comment3" | "comment4";
pos: number;
line: number;
col: number;
},
) => boolean)
| {
condition?:
| boolean
| "all"
| "some"
| RegExp
| ((
astNode: any,
comment: {
value: string;
type: "comment1" | "comment2" | "comment3" | "comment4";
pos: number;
line: number;
col: number;
},
) => boolean)
| undefined;
filename?: string | ((fileData: any) => string) | undefined;
banner?:
| string
| boolean
| ((commentsFile: string) => string)
| undefined;
};Default: true
Whether comments shall be extracted to a separate file, (see details).
By default, extract only comments using /^\**!|@preserve|@license|@cc_on/i RegExp condition and remove remaining comments.
If the original file is named foo.js, then the comments will be stored to foo.js.LICENSE.txt.
The minimizerOptions.format.comments option specifies whether the comment will be preserved - i.e., it is possible to preserve some comments (e.g. annotations) while extracting others, or even preserve comments that have already been extracted.
Enable/disable extracting comments.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
extractComments: true,
}),
],
},
};Extract all or some (use the /^\**!|@preserve|@license|@cc_on/i RegExp) comments.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
extractComments: "all",
}),
],
},
};All comments that match the given expression will be extracted to a separate file.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
extractComments: /@extract/i,
}),
],
},
};All comments that match the given expression will be extracted to a separate file.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
extractComments: (astNode, comment) => {
if (/@extract/i.test(comment.value)) {
return true;
}
return false;
},
}),
],
},
};Allows you to customize condition for extracting comments, and specify the extracted file name and banner.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
extractComments: {
condition: /^\**!|@preserve|@license|@cc_on/i,
filename: (fileData) =>
// The "fileData" argument contains object with "filename", "basename", "query" and "hash"
`${fileData.filename}.LICENSE.txt${fileData.query}`,
banner: (licenseFile) =>
`License information can be found in ${licenseFile}`,
},
}),
],
},
};Type:
type condition =
| boolean
| "all"
| "some"
| RegExp
| ((
astNode: any,
comment: {
value: string;
type: "comment1" | "comment2" | "comment3" | "comment4";
pos: number;
line: number;
col: number;
},
) => boolean)
| undefined;The condition that determines which comments should be extracted.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
extractComments: {
condition: "some",
filename: (fileData) =>
// The "fileData" argument contains object with "filename", "basename", "query" and "hash"
`${fileData.filename}.LICENSE.txt${fileData.query}`,
banner: (licenseFile) =>
`License information can be found in ${licenseFile}`,
},
}),
],
},
};Type:
type filename = string | ((fileData: any) => string) | undefined;Default: [file].LICENSE.txt[query]
Available placeholders: [file], [query] and [filebase] ([base] for webpack 5).
The file where the extracted comments will be stored.
Default is to append the suffix .LICENSE.txt to the original filename.
Warning
We highly recommend using the
.txtextension. Using.js/.cjs/.mjsextensions may conflict with existing assets, which leads to broken code.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
extractComments: {
condition: /^\**!|@preserve|@license|@cc_on/i,
filename: "extracted-comments.js",
banner: (licenseFile) =>
`License information can be found in ${licenseFile}`,
},
}),
],
},
};Type:
type banner = string | boolean | ((commentsFile: string) => string) | undefined;Default: /*! For license information please see ${commentsFile} */
The banner text that points to the extracted file and will be added at the top of the original file.
It can be false (no banner), a String, or a function<(string) -> String> that will be called with the filename where the extracted comments have been stored.
The banner will be wrapped in a comment.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
extractComments: {
condition: true,
filename: (fileData) =>
// The "fileData" argument contains object with "filename", "basename", "query" and "hash"
`${fileData.filename}.LICENSE.txt${fileData.query}`,
banner: (commentsFile) =>
`My custom banner about license information ${commentsFile}`,
},
}),
],
},
};Extract all legal comments (i.e. /^\**!|@preserve|@license|@cc_on/i) and preserve /@license/i comments.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
minimizerOptions: {
format: {
comments: /@license/i,
},
},
extractComments: true,
}),
],
},
};If you want to build without comments, use this config:
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
minimizerOptions: {
format: {
comments: false,
},
},
extractComments: false,
}),
],
},
};UglifyJS is a JavaScript parser, minifier, compressor and beautifier toolkit.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
minify: TerserPlugin.uglifyJsMinify,
// `minimizerOptions` will be passed to `uglify-js`
// Link to options - https://github.com/mishoo/UglifyJS#minify-options
minimizerOptions: {},
}),
],
},
};swc is a super-fast compiler written in Rust, producing widely supported JavaScript from modern standards and TypeScript.
Warning
extractCommentsis supported with@swc/core >= 1.15.30. Only serializable extract conditions are supported: booleans,"some","all", string patterns,RegExpvalues without flags, or object conditions that resolve to those forms. Function conditions and flagged regular expressions are not supported.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
minify: TerserPlugin.swcMinify,
// `minimizerOptions` will be passed to `swc` (`@swc/core`)
// Link to options - https://swc.rs/docs/config-js-minify
minimizerOptions: {},
}),
],
},
};esbuild is an extremely fast JavaScript bundler and minifier.
Warning
The
extractCommentsoption is not supported, and all legal comments (i.e. copyright, licenses and etc) will be preserved.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
minify: TerserPlugin.esbuildMinify,
// `minimizerOptions` will be passed to `esbuild`
// Link to options - https://esbuild.github.io/api/#minify
// Note: the `minify` options is true by default (and override other `minify*` options), so if you want to disable the `minifyIdentifiers` option (or other `minify*` options) please use:
// minimizerOptions: {
// minify: false,
// minifyWhitespace: true,
// minifyIdentifiers: false,
// minifySyntax: true,
// },
minimizerOptions: {},
}),
],
},
};Uses JSON.stringify() to minify your JSON files during the build process.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
// Keeps original terser plugin to minify JS files
"...",
// Will minify JSON files (they can come from copy-webpack-plugin or when you are using asset modules)
new TerserPlugin({
test: /\.json$/,
minify: TerserPlugin.jsonMinify,
// We are supporting `space` and `replacer` options, you can set them below
minimizerOptions: {},
}),
],
},
};The plugin can minify HTML assets too. Pick one of the bundled HTML
minimizers and set test to match your HTML files.
Available HTML minimizers:
TerserPlugin.htmlMinifierTerser— useshtml-minifier-terser.TerserPlugin.swcMinifyHtml— uses@swc/htmlfor full HTML documents (with doctype and<html>/<head>/<body>tags).TerserPlugin.swcMinifyHtmlFragment— uses@swc/htmlfor HTML fragments (e.g. content inside<template></template>or partial HTML strings).TerserPlugin.minifyHtmlNode— uses@minify-html/node.
The HTML minimizers are optional peer dependencies — install only the one you actually use:
npm install --save-dev html-minifier-terser
# or
npm install --save-dev @swc/html
# or
npm install --save-dev @minify-html/nodeNote
HTML assets typically come from plugins like
copy-webpack-plugin,html-webpack-plugin, or webpack's asset modules.
Note
Whitespace handling differs between tools (defaults):
@swc/html— removes/collapses whitespace only in safe places (aroundhtml/body, inside<head>, between<meta>/<script>/<link>etc.).html-minifier-terser— always collapses multiple whitespaces to a single space (never removes entirely); configurable via its options.@minify-html/node— see its whitespace docs.
html-minifier-terser is a JavaScript-based HTML minifier with no native dependency. It's the default HTML minimizer.
webpack.config.js
const TerserPlugin = require("terser-webpack-plugin");
module.exports = {
optimization: {
minimize: true,
minimizer: [
// Keeps the default Terser plugin for JS files
"...",
new TerserPlugin({
test: /\.html(\?.*)?$/i,
minify: TerserPlugin.htmlMinifierTerser,
// Options - https://github.com/terser/html-minifier-terser#options-quick-reference
minimizerOptions: {
collapseWhitespace: true,
removeComments: true,
},
}),
],
},
};Use swcMinifyHtml for complete HTML documents (i.e. with a doctype and <html>/<head>/<body> tags).
webpack.config.js
const TerserPlugin = require("terser-webpack-plugin");
module.exports = {
optimization: {
minimize: true,
minimizer: [
"...",
new TerserPlugin({
test: /\.html(\?.*)?$/i,
minify: TerserPlugin.swcMinifyHtml,
// Options - https://github.com/swc-project/bindings/blob/main/packages/html/index.ts
minimizerOptions: {},
}),
],
},
};Use swcMinifyHtmlFragment for partial HTML — for example, content of <template></template> tags or HTML strings that get injected into another document.
webpack.config.js
const TerserPlugin = require("terser-webpack-plugin");
module.exports = {
optimization: {
minimize: true,
minimizer: [
"...",
new TerserPlugin({
test: /\.template\.html$/i,
minify: TerserPlugin.swcMinifyHtmlFragment,
// Options - https://github.com/swc-project/bindings/blob/main/packages/html/index.ts
minimizerOptions: {},
}),
],
},
};Note
The difference between
swcMinifyHtmlandswcMinifyHtmlFragmentis the error reporting — invalid or broken syntax is reported at build time.
@minify-html/node is a Rust HTML minifier.
webpack.config.js
const TerserPlugin = require("terser-webpack-plugin");
module.exports = {
optimization: {
minimize: true,
minimizer: [
"...",
new TerserPlugin({
test: /\.html(\?.*)?$/i,
minify: TerserPlugin.minifyHtmlNode,
// Options - https://github.com/wilsonzlin/minify-html#minification
minimizerOptions: {},
}),
],
},
};You can also stack multiple TerserPlugin instances to compress different files with different minify functions in the same build (e.g. JS with terserMinify, HTML with htmlMinifierTerser, JSON with jsonMinify).
Override the default minify function - use uglify-js for minification.
webpack.config.js
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
minify: (file, sourceMap) => {
// https://github.com/mishoo/UglifyJS2#minify-options
const uglifyJsOptions = {
/* your `uglify-js` package options */
};
if (sourceMap) {
uglifyJsOptions.sourceMap = {
content: sourceMap,
};
}
return require("uglify-js").minify(file, uglifyJsOptions);
},
}),
],
},
};With default Terser minify function:
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin({
minimizerOptions: {
compress: true,
},
}),
],
},
};With built-in minify functions:
import { type JsMinifyOptions as SwcOptions } from "@swc/core";
import {
type FragmentOptions as SwcHtmlFragmentOptions,
type Options as SwcHtmlOptions,
} from "@swc/html";
import { type TransformOptions as EsbuildOptions } from "esbuild";
import { type Options as HtmlMinifierTerserOptions } from "html-minifier-terser";
import { type MinifyOptions as TerserOptions } from "terser";
import { type MinifyOptions as UglifyJSOptions } from "uglify-js";
module.exports = {
optimization: {
minimize: true,
minimizer: [
new TerserPlugin<SwcOptions>({
minify: TerserPlugin.swcMinify,
minimizerOptions: {
// `swc` options
},
}),
new TerserPlugin<UglifyJSOptions>({
minify: TerserPlugin.uglifyJsMinify,
minimizerOptions: {
// `uglif-js` options
},
}),
new TerserPlugin<EsbuildOptions>({
minify: TerserPlugin.esbuildMinify,
minimizerOptions: {
// `esbuild` options
},
}),
// Alternative usage:
new TerserPlugin<TerserOptions>({
minify: TerserPlugin.terserMinify,
minimizerOptions: {
// `terser` options
},
}),
// HTML minimizers
new TerserPlugin<HtmlMinifierTerserOptions>({
test: /\.html(\?.*)?$/i,
minify: TerserPlugin.htmlMinifierTerser,
minimizerOptions: {
// `html-minifier-terser` options
},
}),
new TerserPlugin<SwcHtmlOptions>({
test: /\.html(\?.*)?$/i,
minify: TerserPlugin.swcMinifyHtml,
minimizerOptions: {
// `@swc/html` options
},
}),
new TerserPlugin<SwcHtmlFragmentOptions>({
test: /\.template\.html$/i,
minify: TerserPlugin.swcMinifyHtmlFragment,
minimizerOptions: {
// `@swc/html` fragment options
},
}),
],
},
};We welcome all contributions! If you're new here, please take a moment to review our contributing guidelines before submitting issues or pull requests.