Terser

JavaScript parser, mangler and compressor toolkit for ES6+

Code Parser
terser/terserterser.orgterser

README

Terser


  [![NPM Version][npm-image]][npm-url]
  [![NPM Downloads][downloads-image]][downloads-url]
  [![Travis Build][travis-image]][travis-url]
  [![Opencollective financial contributors][opencollective-contributors]][opencollective-url]

A JavaScript mangler/compressor toolkit for ES6+.

*note*: You can support this project on patreon: [link] **The Terser Patreon is shutting down in favor of opencollective**. Check out [PATRONS.md](https://github.com/terser/terser/blob/master/PATRONS.md) for our first-tier patrons.

Terser recommends you use RollupJS to bundle your modules, as that produces smaller code overall.

Beautification has been undocumented and is being removed from terser, we recommend you use prettier.

Find the changelog in CHANGELOG.md

[npm-image]: https://img.shields.io/npm/v/terser.svg
[npm-url]: https://npmjs.org/package/terser
[downloads-image]: https://img.shields.io/npm/dm/terser.svg
[downloads-url]: https://npmjs.org/package/terser
[travis-image]: https://app.travis-ci.com/terser/terser.svg?branch=master
[travis-url]: https://app.travis-ci.com/github/terser/terser
[opencollective-contributors]: https://opencollective.com/terser/tiers/badge.svg
[opencollective-url]: https://opencollective.com/terser

Why choose terser?

uglify-es is no longer maintained anduglify-js does not support ES6+.

terser is a fork of uglify-es that mostly retains API and CLI compatibility
with uglify-es and uglify-js@3.

Install

First make sure you have installed the latest version of node.js
(You may need to restart your computer after this step).

From NPM for use as a command line app:

    npm install terser -g

From NPM for programmatic use:

    npm install terser

Command line usage


    terser [input files] [options]

Terser can take multiple input files.  It's recommended that you pass the
input files first, then pass the options.  Terser will parse input files
in sequence and apply any compression options.  The files are parsed in the
same global scope, that is, a reference from a file to some
variable/function declared in another file will be matched properly.

Command line arguments that take options (like --parse, --compress, --mangle and
--format) can take in a comma-separated list of default option overrides. For
instance:

    terser input.js --compress ecma=2015,computed_props=false

If no input file is specified, Terser will read from STDIN.

If you wish to pass your options before the input files, separate the two with
a double dash to prevent input files being used as option arguments:

    terser --compress --mangle -- input.js

Command line options


  1. ```
  2.     -h, --help                  Print usage information.
  3.                                 `--help options` for details on available options.
  4.     -V, --version               Print version number.
  5.     -p, --parse <options>       Specify parser options:
  6.                                 `acorn`  Use Acorn for parsing.
  7.                                 `bare_returns`  Allow return outside of functions.
  8.                                                 Useful when minifying CommonJS
  9.                                                 modules and Userscripts that may
  10.                                                 be anonymous function wrapped (IIFE)
  11.                                                 by the .user.js engine `caller`.
  12.                                 `expression`  Parse a single expression, rather than
  13.                                               a program (for parsing JSON).
  14.                                 `spidermonkey`  Assume input files are SpiderMonkey
  15.                                                 AST format (as JSON).
  16.     -c, --compress [options]    Enable compressor/specify compressor options:
  17.                                 `pure_funcs`  List of functions that can be safely
  18.                                               removed when their return values are
  19.                                               not used.
  20.     -m, --mangle [options]      Mangle names/specify mangler options:
  21.                                 `reserved`  List of names that should not be mangled.
  22.     --mangle-props [options]    Mangle properties/specify mangler options:
  23.                                 `builtins`  Mangle property names that overlaps
  24.                                             with standard JavaScript globals and DOM
  25.                                             API props.
  26.                                 `debug`  Add debug prefix and suffix.
  27.                                 `keep_quoted`  Only mangle unquoted properties, quoted
  28.                                                properties are automatically reserved.
  29.                                                `strict` disables quoted properties
  30.                                                being automatically reserved.
  31.                                 `regex`  Only mangle matched property names.
  32.                                 `reserved`  List of names that should not be mangled.
  33.     -f, --format [options]      Specify format options.
  34.                                 `preamble`  Preamble to prepend to the output. You
  35.                                             can use this to insert a comment, for
  36.                                             example for licensing information.
  37.                                             This will not be parsed, but the source
  38.                                             map will adjust for its presence.
  39.                                 `quote_style`  Quote style:
  40.                                                0 - auto
  41.                                                1 - single
  42.                                                2 - double
  43.                                                3 - original
  44.                                 `wrap_iife`  Wrap IIFEs in parenthesis. Note: you may
  45.                                              want to disable `negate_iife` under
  46.                                              compressor options.
  47.                                 `wrap_func_args`  Wrap function arguments in parenthesis.
  48.     -o, --output <file>         Output file path (default STDOUT). Specify `ast` or
  49.                                 `spidermonkey` to write Terser or SpiderMonkey AST
  50.                                 as JSON to STDOUT respectively.
  51.     --comments [filter]         Preserve copyright comments in the output. By
  52.                                 default this works like Google Closure, keeping
  53.                                 JSDoc-style comments that contain e.g. "@license",
  54.                                 or start with "!". You can optionally pass one of the
  55.                                 following arguments to this flag:
  56.                                 - "all" to keep all comments
  57.                                 - `false` to omit comments in the output
  58.                                 - a valid JS RegExp like `/foo/` or `/^!/` to
  59.                                 keep only matching comments.
  60.                                 Note that currently not *all* comments can be
  61.                                 kept when compression is on, because of dead
  62.                                 code removal or cascading statements into
  63.                                 sequences.
  64.     --config-file <file>        Read `minify()` options from JSON file.
  65.     -d, --define <expr>[=value] Global definitions.
  66.     --ecma <version>            Specify ECMAScript release: 5, 2015, 2016, etc.
  67.     -e, --enclose [arg[:value]] Embed output in a big function with configurable
  68.                                 arguments and values.
  69.     --ie8                       Support non-standard Internet Explorer 8.
  70.                                 Equivalent to setting `ie8: true` in `minify()`
  71.                                 for `compress`, `mangle` and `format` options.
  72.                                 By default Terser will not try to be IE-proof.
  73.     --keep-classnames           Do not mangle/drop class names.
  74.     --keep-fnames               Do not mangle/drop function names.  Useful for
  75.                                 code relying on Function.prototype.name.
  76.     --module                    Input is an ES6 module. If `compress` or `mangle` is
  77.                                 enabled then the `toplevel` option will be enabled.
  78.     --name-cache <file>         File to hold mangled name mappings.
  79.     --safari10                  Support non-standard Safari 10/11.
  80.                                 Equivalent to setting `safari10: true` in `minify()`
  81.                                 for `mangle` and `format` options.
  82.                                 By default `terser` will not work around
  83.                                 Safari 10/11 bugs.
  84.     --source-map [options]      Enable source map/specify source map options:
  85.                                 `base`  Path to compute relative paths from input files.
  86.                                 `content`  Input source map, useful if you're compressing
  87.                                            JS that was generated from some other original
  88.                                            code. Specify "inline" if the source map is
  89.                                            included within the sources.
  90.                                 `filename`  Name and/or location of the output source.
  91.                                 `includeSources`  Pass this flag if you want to include
  92.                                                   the content of source files in the
  93.                                                   source map as sourcesContent property.
  94.                                 `root`  Path to the original source to be included in
  95.                                         the source map.
  96.                                 `url`  If specified, path to the source map to append in
  97.                                        `//# sourceMappingURL`.
  98.     --timings                   Display operations run time on STDERR.
  99.     --toplevel                  Compress and/or mangle variables in top level scope.
  100.     --wrap <name>               Embed everything in a big function, making the
  101.                                 “exports” and “global” variables available. You
  102.                                 need to pass an argument to this option to
  103.                                 specify the name that your module will take
  104.                                 when included in, say, a browser.
  105. ```

Specify --output (-o) to declare the output file.  Otherwise the output
goes to STDOUT.

CLI source map options


Terser can generate a source map file, which is highly useful for
debugging your compressed JavaScript.  To get a source map, pass
--source-map --output output.js (source map will be written out to
output.js.map).

Additional options:

- `--source-map "filename=''"` to specify the name of the source map.

- `--source-map "root=''"` to pass the URL where the original files can be found.

- `--source-map "url=''"` to specify the URL where the source map can be found.
  Otherwise Terser assumes HTTP X-SourceMap is being used and will omit the
  //# sourceMappingURL= directive.

For example:

    terser js/file1.js js/file2.js \
             -o foo.min.js -c -m \
             --source-map "root='http://foo.com/src',url='foo.min.js.map'"

The above will compress and mangle file1.js and file2.js, will drop the
output in foo.min.js and the source map in foo.min.js.map.  The source
mapping will refer to http://foo.com/src/js/file1.js and
http://foo.com/src/js/file2.js (in fact it will list http://foo.com/src
as the source map root, and the original files as js/file1.js and
js/file2.js).

Composed source map


When you're compressing JS code that was output by a compiler such as
CoffeeScript, mapping to the JS code won't be too helpful.  Instead, you'd
like to map back to the original code (i.e. CoffeeScript).  Terser has an
option to take an input source map.  Assuming you have a mapping from
CoffeeScript → compiled JS, Terser can generate a map from CoffeeScript →
compressed JS by mapping every token in the compiled JS to its original
location.

To use this feature pass --source-map "content='/path/to/input/source.map'"
or --source-map "content=inline" if the source map is included inline with
the sources.

CLI compress options


You need to pass --compress (-c) to enable the compressor.  Optionally
you can pass a comma-separated list of compress options.

Options are in the form foo=bar, or just foo (the latter implies
a boolean option that you want to set true; it's effectively a
shortcut for foo=true).

Example:

    terser file.js -c toplevel,sequences=false

CLI mangle options


To enable the mangler you need to pass --mangle (-m).  The following
(comma-separated) options are supported:

- toplevel (default false) -- mangle names declared in the top level scope.

- eval (default false) -- mangle names visible in scopes where eval or with are used.

When mangling is enabled but you want to prevent certain names from being
mangled, you can declare those names with --mangle reserved — pass a
comma-separated list of names.  For example:

    terser ... -m reserved=['$','require','exports']

to prevent the require, exports and $ names from being changed.

CLI mangling property names (--mangle-props)


Note: THIS WILL BREAK YOUR CODE. A good rule of thumb is not to use this unless you know exactly what you're doing and how this works and read this section until the end.

Mangling property names is a separate step, different from variable name mangling.  Pass
--mangle-props to enable it. The least dangerous
way to use this is to use the regex option like so:

  1. ```
  2. terser example.js -c -m --mangle-props regex=/_$/
  3. ```

This will mangle all properties that end with an
underscore. So you can use it to mangle internal methods.

By default, it will mangle all properties in the
input code with the exception of built in DOM properties and properties
in core JavaScript classes, which is what will break your code if you don't:

1. Control all the code you're mangling
2. Avoid using a module bundler, as they usually will call Terser on each file individually, making it impossible to pass mangled objects between modules.
3. Avoid calling functions like defineProperty or hasOwnProperty, because they refer to object properties using strings and will break your code if you don't know what you are doing.

An example:

  1. ``` js
  2. // example.js
  3. var x = {
  4.     baz_: 0,
  5.     foo_: 1,
  6.     calc: function() {
  7.         return this.foo_ + this.baz_;
  8.     }
  9. };
  10. x.bar_ = 2;
  11. x["baz_"] = 3;
  12. console.log(x.calc());
  13. ```
Mangle all properties (except for JavaScript builtins) (very unsafe):
  1. ``` sh
  2. $ terser example.js -c passes=2 -m --mangle-props
  3. ```
  1. ``` js
  2. var x={o:3,t:1,i:function(){return this.t+this.o},s:2};console.log(x.i());
  3. ```
Mangle all properties except for reserved properties (still very unsafe):
  1. ``` sh
  2. $ terser example.js -c passes=2 -m --mangle-props reserved=[foo_,bar_]
  3. ```
  1. ``` js
  2. var x={o:3,foo_:1,t:function(){return this.foo_+this.o},bar_:2};console.log(x.t());
  3. ```
Mangle all properties matching a regex (not as unsafe but still unsafe):
  1. ``` sh
  2. $ terser example.js -c passes=2 -m --mangle-props regex=/_$/
  3. ```
  1. ``` js
  2. var x={o:3,t:1,calc:function(){return this.t+this.o},i:2};console.log(x.calc());
  3. ```

Combining mangle properties options:
  1. ``` sh
  2. $ terser example.js -c passes=2 -m --mangle-props regex=/_$/,reserved=[bar_]
  3. ```
  1. ``` js
  2. var x={o:3,t:1,calc:function(){return this.t+this.o},bar_:2};console.log(x.calc());
  3. ```

In order for this to be of any use, we avoid mangling standard JS names and DOM
API properties by default (--mangle-props builtins to override).

A regular expression can be used to define which property names should be
mangled.  For example, --mangle-props regex=/^_/ will only mangle property
names that start with an underscore.

When you compress multiple files using this option, in order for them to
work together in the end we need to ensure somehow that one property gets
mangled to the same name in all of them.  For this, pass --name-cache filename.json
and Terser will maintain these mappings in a file which can then be reused.
It should be initially empty.  Example:

  1. ``` sh
  2. $ rm -f /tmp/cache.json  # start fresh
  3. $ terser file1.js file2.js --mangle-props --name-cache /tmp/cache.json -o part1.js
  4. $ terser file3.js file4.js --mangle-props --name-cache /tmp/cache.json -o part2.js
  5. ```

Now, part1.js and part2.js will be consistent with each other in terms
of mangled property names.

Using the name cache is not necessary if you compress all your files in a
single call to Terser.

Mangling unquoted names (--mangle-props keep_quoted)


Using quoted property name (o["foo"]) reserves the property name (foo)
so that it is not mangled throughout the entire script even when used in an
unquoted style (o.foo). Example:

  1. ``` js
  2. // stuff.js
  3. var o = {
  4.     "foo": 1,
  5.     bar: 3
  6. };
  7. o.foo += o.bar;
  8. console.log(o.foo);
  9. ```
  1. ``` sh
  2. $ terser stuff.js --mangle-props keep_quoted -c -m
  3. ```
  1. ``` js
  2. var o={foo:1,o:3};o.foo+=o.o,console.log(o.foo);
  3. ```

Debugging property name mangling


You can also pass --mangle-props debug in order to mangle property names
without completely obscuring them. For example the property o.foo
would mangle to o._$foo$_ with this option. This allows property mangling
of a large codebase while still being able to debug the code and identify
where mangling is breaking things.

  1. ``` sh
  2. $ terser stuff.js --mangle-props debug -c -m
  3. ```
  1. ``` js
  2. var o={_$foo$_:1,_$bar$_:3};o._$foo$_+=o._$bar$_,console.log(o._$foo$_);
  3. ```

You can also pass a custom suffix using --mangle-props debug=XYZ. This would then
mangle o.foo to o._$foo$XYZ_. You can change this each time you compile a
script to identify how a property got mangled. One technique is to pass a
random number on every compile to simulate mangling changing with different
inputs (e.g. as you update the input script with new properties), and to help
identify mistakes like writing mangled keys to storage.

API Reference


Assuming installation via NPM, you can load Terser in your application
like this:

  1. ``` js
  2. const { minify } = require("terser");
  3. ```

Or,

  1. ``` js
  2. import { minify } from "terser";
  3. ```

Browser loading is also supported:
  1. ``` html
  2. <script src="https://cdn.jsdelivr.net/npm/source-map@0.7.3/dist/source-map.js"></script>
  3. <script src="https://cdn.jsdelivr.net/npm/terser/dist/bundle.min.js"></script>
  4. ```

There is a single async high level function, async minify(code, options),
which will perform all minification phases in a configurable
manner. By default minify() will enable [compress](#compress-options)
and [mangle](#mangle-options). Example:
  1. ``` js
  2. var code = "function add(first, second) { return first + second; }";
  3. var result = await minify(code, { sourceMap: true });
  4. console.log(result.code);  // minified output: function add(n,d){return n+d}
  5. console.log(result.map);  // source map
  6. ```

You can minify more than one JavaScript file at a time by using an object
for the first argument where the keys are file names and the values are source
code:
  1. ``` js
  2. var code = {
  3.     "file1.js": "function add(first, second) { return first + second; }",
  4.     "file2.js": "console.log(add(1 + 2, 3 + 4));"
  5. };
  6. var result = await minify(code);
  7. console.log(result.code);
  8. // function add(d,n){return d+n}console.log(add(3,7));
  9. ```

The toplevel option:
  1. ``` js
  2. var code = {
  3.     "file1.js": "function add(first, second) { return first + second; }",
  4.     "file2.js": "console.log(add(1 + 2, 3 + 4));"
  5. };
  6. var options = { toplevel: true };
  7. var result = await minify(code, options);
  8. console.log(result.code);
  9. // console.log(3+7);
  10. ```

The nameCache option:
  1. ``` js
  2. var options = {
  3.     mangle: {
  4.         toplevel: true,
  5.     },
  6.     nameCache: {}
  7. };
  8. var result1 = await minify({
  9.     "file1.js": "function add(first, second) { return first + second; }"
  10. }, options);
  11. var result2 = await minify({
  12.     "file2.js": "console.log(add(1 + 2, 3 + 4));"
  13. }, options);
  14. console.log(result1.code);
  15. // function n(n,r){return n+r}
  16. console.log(result2.code);
  17. // console.log(n(3,7));
  18. ```

You may persist the name cache to the file system in the following way:
  1. ``` js
  2. var cacheFileName = "/tmp/cache.json";
  3. var options = {
  4.     mangle: {
  5.         properties: true,
  6.     },
  7.     nameCache: JSON.parse(fs.readFileSync(cacheFileName, "utf8"))
  8. };
  9. fs.writeFileSync("part1.js", await minify({
  10.     "file1.js": fs.readFileSync("file1.js", "utf8"),
  11.     "file2.js": fs.readFileSync("file2.js", "utf8")
  12. }, options).code, "utf8");
  13. fs.writeFileSync("part2.js", await minify({
  14.     "file3.js": fs.readFileSync("file3.js", "utf8"),
  15.     "file4.js": fs.readFileSync("file4.js", "utf8")
  16. }, options).code, "utf8");
  17. fs.writeFileSync(cacheFileName, JSON.stringify(options.nameCache), "utf8");
  18. ```

An example of a combination of minify() options:
  1. ``` js
  2. var code = {
  3.     "file1.js": "function add(first, second) { return first + second; }",
  4.     "file2.js": "console.log(add(1 + 2, 3 + 4));"
  5. };
  6. var options = {
  7.     toplevel: true,
  8.     compress: {
  9.         global_defs: {
  10.             "@console.log": "alert"
  11.         },
  12.         passes: 2
  13.     },
  14.     format: {
  15.         preamble: "/* minified */"
  16.     }
  17. };
  18. var result = await minify(code, options);
  19. console.log(result.code);
  20. // /* minified */
  21. // alert(10);"
  22. ```

An error example:
  1. ``` js
  2. try {
  3.     const result = await minify({"foo.js" : "if (0) else console.log(1);"});
  4.     // Do something with result
  5. } catch (error) {
  6.     const { message, filename, line, col, pos } = error;
  7.     // Do something with error
  8. }
  9. ```

Minify options


- ecma (default undefined) - pass 5, 2015, 2016, etc to override
  compress and format's ecma options.

- enclose (default false) - pass true, or a string in the format
  of "args[:values]", where args and values are comma-separated
  argument names and values, respectively, to embed the output in a big
  function with the configurable arguments and values.

- parse (default {}) — pass an object if you wish to specify some
  additional parse options.

- compress (default {}) — pass false to skip compressing entirely.
  Pass an object to specify custom compress options.

- mangle (default true) — pass false to skip mangling names, or pass
  an object to specify mangle options (see below).

  - mangle.properties (default false) — a subcategory of the mangle option.
    Pass an object to specify custom mangle property options.

- module (default false) — Use when minifying an ES6 module. "use strict"
  is implied and names can be mangled on the top scope. If compress or
  mangle is enabled then the toplevel option will be enabled.

- format or output (default null) — pass an object if you wish to specify
  additional format options.  The defaults are optimized
  for best compression.

- sourceMap (default false) - pass an object if you wish to specify
  source map options.

- toplevel (default false) - set to true if you wish to enable top level
  variable and function name mangling and to drop unused variables and functions.

- nameCache (default null) - pass an empty object {} or a previously
  used nameCache object if you wish to cache mangled variable and
  property names across multiple invocations of minify(). Note: this is
  a read/write property. minify() will read the name cache state of this
  object and update it during minification so that it may be
  reused or externally persisted by the user.

- ie8 (default false) - set to true to support IE8.

- keep_classnames (default: undefined) - pass true to prevent discarding or mangling
  of class names. Pass a regular expression to only keep class names matching that regex.

- keep_fnames (default: false) - pass true to prevent discarding or mangling
  of function names. Pass a regular expression to only keep function names matching that regex.
  Useful for code relying on Function.prototype.name. If the top level minify option
  keep_classnames is undefined it will be overridden with the value of the top level
  minify option keep_fnames.

- safari10 (default: false) - pass true to work around Safari 10/11 bugs in
  loop scoping and await. See safari10 options in [mangle](#mangle-options)
  and [format](#format-options) for details.

Minify options structure


  1. ``` js
  2. {
  3.     parse: {
  4.         // parse options
  5.     },
  6.     compress: {
  7.         // compress options
  8.     },
  9.     mangle: {
  10.         // mangle options

  12.         properties: {
  13.             // mangle property options
  14.         }
  15.     },
  16.     format: {
  17.         // format options (can also use `output` for backwards compatibility)
  18.     },
  19.     sourceMap: {
  20.         // source map options
  21.     },
  22.     ecma: 5, // specify one of: 5, 2015, 2016, etc.
  23.     enclose: false, // or specify true, or "args:values"
  24.     keep_classnames: false,
  25.     keep_fnames: false,
  26.     ie8: false,
  27.     module: false,
  28.     nameCache: null, // or specify a name cache object
  29.     safari10: false,
  30.     toplevel: false
  31. }
  32. ```

Source map options


To generate a source map:
  1. ``` js
  2. var result = await minify({"file1.js": "var a = function() {};"}, {
  3.     sourceMap: {
  4.         filename: "out.js",
  5.         url: "out.js.map"
  6.     }
  7. });
  8. console.log(result.code); // minified output
  9. console.log(result.map);  // source map
  10. ```

Note that the source map is not saved in a file, it's just returned in
result.map.  The value passed for sourceMap.url is only used to set
//# sourceMappingURL=out.js.map in result.code. The value of
filename is only used to set file attribute (see [the spec][sm-spec])
in source map file.

You can set option sourceMap.url to be "inline" and source map will
be appended to code.

You can also specify sourceRoot property to be included in source map:
  1. ``` js
  2. var result = await minify({"file1.js": "var a = function() {};"}, {
  3.     sourceMap: {
  4.         root: "http://example.com/src",
  5.         url: "out.js.map"
  6.     }
  7. });
  8. ```

If you're compressing compiled JavaScript and have a source map for it, you
can use sourceMap.content:
  1. ``` js
  2. var result = await minify({"compiled.js": "compiled code"}, {
  3.     sourceMap: {
  4.         content: "content from compiled.js.map",
  5.         url: "minified.js.map"
  6.     }
  7. });
  8. // same as before, it returns `code` and `map`
  9. ```

If you're using the X-SourceMap header instead, you can just omit sourceMap.url.

If you happen to need the source map as a raw object, set sourceMap.asObject to true.

Parse options


- bare_returns (default false) -- support top level return statements

- html5_comments (default true)

- shebang (default true) -- support #!command as the first line

- spidermonkey (default false) -- accept a Spidermonkey (Mozilla) AST

Compress options


- defaults (default: true) -- Pass false to disable most default
  enabled compress transforms. Useful when you only want to enable a few
  compress options while disabling the rest.

- arrows (default: true) -- Class and object literal methods are converted
  will also be converted to arrow expressions if the resultant code is shorter:
  m(){return x} becomes m:()=>x. To do this to regular ES5 functions which
  don't use this or arguments, see unsafe_arrows.

- arguments (default: false) -- replace arguments[index] with function
  parameter name whenever possible.

- booleans (default: true) -- various optimizations for boolean context,
  for example !!a ? b : c → a ? b : c

- booleans_as_integers (default: false) -- Turn booleans into 0 and 1, also
  makes comparisons with booleans use == and != instead of === and !==.

- collapse_vars (default: true) -- Collapse single-use non-constant variables,
  side effects permitting.

- comparisons (default: true) -- apply certain optimizations to binary nodes,
e.g. `!(a <= b) → a > b` (only when `unsafe_comps`), attempts to negate binary
  nodes, e.g. a = !b && !c && !d && !e → a=!(b||c||d||e) etc.

- computed_props (default: true) -- Transforms constant computed properties
  into regular ones: {["computed"]: 1} is converted to {computed: 1}.

- conditionals (default: true) -- apply optimizations for if-s and conditional
  expressions

- dead_code (default: true) -- remove unreachable code

- directives (default: true) -- remove redundant or non-standard directives

- drop_console (default: false) -- Pass true to discard calls to
  console.* functions. If you wish to drop a specific function call
  such as console.info and/or retain side effects from function arguments
  after dropping the function call then use pure_funcs instead.

- drop_debugger (default: true) -- remove debugger; statements

- ecma (default: 5) -- Pass 2015 or greater to enable compress options that
  will transform ES5 code into smaller ES6+ equivalent forms.

- evaluate (default: true) -- attempt to evaluate constant expressions

- expression (default: false) -- Pass true to preserve completion values
  from terminal statements without return, e.g. in bookmarklets.

- global_defs (default: {}) -- see conditional compilation

- hoist_funs (default: false) -- hoist function declarations

- hoist_props (default: true) -- hoist properties from constant object and
  array literals into regular variables subject to a set of constraints. For example:
  var o={p:1, q:2}; f(o.p, o.q); is converted to f(1, 2);. Note: hoist_props
  works best with mangle enabled, the compress option passes set to 2 or higher,
  and the compress option toplevel enabled.

- hoist_vars (default: false) -- hoist var declarations (this is false
  by default because it seems to increase the size of the output in general)

- if_return (default: true) -- optimizations for if/return and if/continue

- inline (default: true) -- inline calls to function with simple/return statement:
  - false -- same as 0
  - 0 -- disabled inlining
  - 1 -- inline simple functions
  - 2 -- inline functions with arguments
  - 3 -- inline functions with arguments and variables
  - true -- same as 3

- join_vars (default: true) -- join consecutive var statements

- keep_classnames (default: false) -- Pass true to prevent the compressor from
  discarding class names. Pass a regular expression to only keep class names matching
  that regex. See also: the keep_classnames mangle option.

- keep_fargs (default: true) -- Prevents the compressor from discarding unused
  function arguments.  You need this for code which relies on Function.length.

- keep_fnames (default: false) -- Pass true to prevent the
  compressor from discarding function names. Pass a regular expression to only keep
  function names matching that regex. Useful for code relying on Function.prototype.name.
  See also: the keep_fnames mangle option.

- keep_infinity (default: false) -- Pass true to prevent Infinity from
  being compressed into 1/0, which may cause performance issues on Chrome.

- loops (default: true) -- optimizations for do, while and for loops
  when we can statically determine the condition.

- module (default false) -- Pass true when compressing an ES6 module. Strict
  mode is implied and the toplevel option as well.

- negate_iife (default: true) -- negate "Immediately-Called Function Expressions"
  where the return value is discarded, to avoid the parens that the
  code generator would insert.

- passes (default: 1) -- The maximum number of times to run compress.
  In some cases more than one pass leads to further compressed code.  Keep in
  mind more passes will take more time.

- properties (default: true) -- rewrite property access using the dot notation, for
  example foo["bar"] → foo.bar

- pure_funcs (default: null) -- You can pass an array of names and
  Terser will assume that those functions do not produce side
  effects.  DANGER: will not check if the name is redefined in scope.
  An example case here, for instance var q = Math.floor(a/b).  If
  variable q is not used elsewhere, Terser will drop it, but will
  still keep the Math.floor(a/b), not knowing what it does.  You can
  pass pure_funcs: [ 'Math.floor' ] to let it know that this
  function won't produce any side effect, in which case the whole
  statement would get discarded.  The current implementation adds some
  overhead (compression will be slower).

- pure_getters (default: "strict") -- If you pass true for
  this, Terser will assume that object property access
  (e.g. foo.bar or foo["bar"]) doesn't have any side effects.
  Specify "strict" to treat foo.bar as side-effect-free only when
  foo is certain to not throw, i.e. not null or undefined.

- reduce_vars (default: true) -- Improve optimization on variables assigned with and
  used as constant values.

- reduce_funcs (default: true) -- Inline single-use functions when
  possible. Depends on reduce_vars being enabled.  Disabling this option
  sometimes improves performance of the output code.

- sequences (default: true) -- join consecutive simple statements using the
  comma operator.  May be set to a positive integer to specify the maximum number
  of consecutive comma sequences that will be generated. If this option is set to
  true then the default sequences limit is 200. Set option to false or 0
  to disable. The smallest sequences length is 2. A sequences value of 1
  is grandfathered to be equivalent to true and as such means 200. On rare
  occasions the default sequences limit leads to very slow compress times in which
  case a value of 20 or less is recommended.

- side_effects (default: true) -- Remove expressions which have no side effects
  and whose results aren't used.

- switches (default: true) -- de-duplicate and remove unreachable switch branches

- toplevel (default: false) -- drop unreferenced functions ("funcs") and/or
  variables ("vars") in the top level scope (false by default, true to drop
  both unreferenced functions and variables)

- top_retain (default: null) -- prevent specific toplevel functions and
  variables from unused removal (can be array, comma-separated, RegExp or
  function. Implies toplevel)

- typeofs (default: true) -- Transforms typeof foo == "undefined" into
  foo === void 0.  Note: recommend to set this value to false for IE10 and
  earlier versions due to known issues.

- unsafe (default: false) -- apply "unsafe" transformations
  (details).

- unsafe_arrows (default: false) -- Convert ES5 style anonymous function
  expressions to arrow functions if the function body does not reference this.
  Note: it is not always safe to perform this conversion if code relies on the
  the function having a prototype, which arrow functions lack.
  This transform requires that the ecma compress option is set to 2015 or greater.

- `unsafe_comps` (default: `false`) -- Reverse `<` and `<=` to `>` and `>=` to
  allow improved compression. This might be unsafe when an at least one of two
  operands is an object with computed values due the use of methods like get,
  or valueOf. This could cause change in execution order after operands in the
  comparison are switching. Compression only works if both comparisons and
  unsafe_comps are both set to true.

- unsafe_Function (default: false) -- compress and mangle Function(args, code)
  when both args and code are string literals.

- unsafe_math (default: false) -- optimize numerical expressions like
  `2 x 3 into 6 * x`, which may give imprecise floating point results.

- unsafe_symbols (default: false) -- removes keys from native Symbol
  declarations, e.g Symbol("kDog") becomes Symbol().

- unsafe_methods (default: false) -- Converts { m: function(){} } to
  { m(){} }. ecma must be set to 6 or greater to enable this transform.
  If unsafe_methods is a RegExp then key/value pairs with keys matching the
  RegExp will be converted to concise methods.
Note: if enabled there is a risk of getting a "`` is not a
  constructor" TypeError should any code try to new the former function.

- unsafe_proto (default: false) -- optimize expressions like
  Array.prototype.slice.call(a) into [].slice.call(a)

- unsafe_regexp (default: false) -- enable substitutions of variables with
  RegExp values the same way as if they are constants.

- unsafe_undefined (default: false) -- substitute void 0 if there is a
  variable named undefined in scope (variable name will be mangled, typically
  reduced to a single character)

- unused (default: true) -- drop unreferenced functions and variables (simple
  direct variable assignments do not count as references unless set to "keep_assign")

Mangle options


- eval (default false) -- Pass true to mangle names visible in scopes
  where eval or with are used.

- keep_classnames (default false) -- Pass true to not mangle class names.
  Pass a regular expression to only keep class names matching that regex.
  See also: the keep_classnames compress option.

- keep_fnames (default false) -- Pass true to not mangle function names.
  Pass a regular expression to only keep function names matching that regex.
  Useful for code relying on Function.prototype.name. See also: the keep_fnames
  compress option.

- module (default false) -- Pass true an ES6 modules, where the toplevel
  scope is not the global scope. Implies toplevel.

- nth_identifier (default: an internal mangler that weights based on character
  frequency analysis) -- Pass an object with a get(n) function that converts an
  ordinal into the nth most favored (usually shortest) identifier.
  Optionally also provide reset(), sort(), and consider(chars, delta) to
  use character frequency analysis of the source code.

- reserved (default []) -- Pass an array of identifiers that should be
  excluded from mangling. Example: ["foo", "bar"].

- toplevel (default false) -- Pass true to mangle names declared in the
  top level scope.

- safari10 (default false) -- Pass true to work around the Safari 10 loop
  iterator bug
  "Cannot declare a let variable twice".
  See also: the safari10 format option.

Examples:

  1. ``` js
  2. // test.js
  3. var globalVar;
  4. function funcName(firstLongName, anotherLongName) {
  5.     var myVariable = firstLongName +  anotherLongName;
  6. }
  7. ```
  1. ``` js
  2. var code = fs.readFileSync("test.js", "utf8");

  4. await minify(code).code;
  5. // 'function funcName(a,n){}var globalVar;'

  7. await minify(code, { mangle: { reserved: ['firstLongName'] } }).code;
  8. // 'function funcName(firstLongName,a){}var globalVar;'

  10. await minify(code, { mangle: { toplevel: true } }).code;
  11. // 'function n(n,a){}var a;'
  12. ```

Mangle properties options


- builtins (default: false) — Use true to allow the mangling of builtin
  DOM properties. Not recommended to override this setting.

- debug (default: false) — Mangle names with the original name still present.
  Pass an empty string "" to enable, or a non-empty string to set the debug suffix.

- keep_quoted (default: false) — How quoting properties ({"prop": ...} and obj["prop"]) controls what gets mangled.
  - "strict" (recommended) -- obj.prop is mangled.
  - false -- obj["prop"] is mangled.
  - true -- obj.prop is mangled unless there is obj["prop"] elsewhere in the code.

- nth_identifer (default: an internal mangler that weights based on character
  frequency analysis) -- Pass an object with a get(n) function that converts an
  ordinal into the nth most favored (usually shortest) identifier.
  Optionally also provide reset(), sort(), and consider(chars, delta) to
  use character frequency analysis of the source code.

- regex (default: null) — Pass a RegExp literal or pattern string to only mangle property matching the regular expression.

- reserved (default: []) — Do not mangle property names listed in the
  reserved array.

- undeclared (default: false) - Mangle those names when they are accessed
  as properties of known top level variables but their declarations are never
  found in input code. May be useful when only minifying parts of a project.
  See #397 for more details.

Format options


These options control the format of Terser's output code. Previously known
as "output options".

- ascii_only (default false) -- escape Unicode characters in strings and
  regexps (affects directives with non-ascii characters becoming invalid)

- beautify (default false) -- (DEPRECATED) whether to beautify the output.
  When using the legacy -b CLI flag, this is set to true by default.

- braces (default false) -- always insert braces in if, for,
  do, while or with statements, even if their body is a single
  statement.

- comments (default "some") -- by default it keeps JSDoc-style comments
  that contain "@license", "@copyright", "@preserve" or start with !, pass true
  or "all" to preserve all comments, false to omit comments in the output,
  a regular expression string (e.g. /^!/) or a function.

- ecma (default 5) -- set desired EcmaScript standard version for output.
  Set ecma to 2015 or greater to emit shorthand object properties - i.e.:
  {a} instead of {a: a}.  The ecma option will only change the output in
  direct control of the beautifier. Non-compatible features in your input will
  still be output as is. For example: an ecma setting of 5 will not
  convert modern code to ES5.

- indent_level (default 4)

- indent_start (default 0) -- prefix all lines by that many spaces

- inline_script (default true) -- escape HTML comments and the slash in
occurrences of `` in strings

- keep_numbers (default false) -- keep number literals as it was in original code
(disables optimizations like converting 1000000 into 1e6)

- keep_quoted_props (default false) -- when turned on, prevents stripping
  quotes from property names in object literals.

- max_line_len (default false) -- maximum line length (for minified code)

- preamble (default null) -- when passed it must be a string and
  it will be prepended to the output literally.  The source map will
  adjust for this text.  Can be used to insert a comment containing
  licensing information, for example.

- quote_keys (default false) -- pass true to quote all keys in literal
  objects

- quote_style (default 0) -- preferred quote style for strings (affects
  quoted property names and directives as well):
  - 0 -- prefers double quotes, switches to single quotes when there are
    more double quotes in the string itself. 0 is best for gzip size.
  - 1 -- always use single quotes
  - 2 -- always use double quotes
  - 3 -- always use the original quotes

- preserve_annotations -- (default false) -- Preserve Terser annotations in the output.

- safari10 (default false) -- set this option to true to work around
  the Safari 10/11 await bug.
  See also: the safari10 mangle option.

- semicolons (default true) -- separate statements with semicolons.  If
  you pass false then whenever possible we will use a newline instead of a
  semicolon, leading to more readable output of minified code (size before
  gzip could be smaller; size after gzip insignificantly larger).

- shebang (default true) -- preserve shebang #! in preamble (bash scripts)

- spidermonkey (default false) -- produce a Spidermonkey (Mozilla) AST

- webkit (default false) -- enable workarounds for WebKit bugs.
  PhantomJS users should set this option to true.

- wrap_iife (default false) -- pass true to wrap immediately invoked
  function expressions. See
  #640 for more details.

- wrap_func_args (default true) -- pass false if you do not want to wrap
  function expressions that are passed as arguments, in parenthesis. See
  OptimizeJS for more details.

Miscellaneous


Keeping copyright notices or other comments


You can pass --comments to retain certain comments in the output.  By
default it will keep comments starting with "!" and JSDoc-style comments that
contain "@preserve", "@copyright", "@license" or "@cc_on" (conditional compilation for IE).
You can pass --comments all to keep all the comments, or a valid JavaScript regexp to
keep only comments that match this regexp.  For example --comments /^!/
will keep comments like `/! Copyright Notice /`.

Note, however, that there might be situations where comments are lost.  For
example:
  1. ``` js
  2. function f() {
  3.     /** @preserve Foo Bar */
  4.     function g() {
  5.         // this function is never called
  6.     }
  7.     return something();
  8. }
  9. ```

Even though it has "@preserve", the comment will be lost because the inner
function g (which is the AST node to which the comment is attached to) is
discarded by the compressor as not referenced.

The safest comments where to place copyright information (or other info that
needs to be kept in the output) are comments attached to toplevel nodes.

The unsafe compress option


It enables some transformations that might break code logic in certain
contrived cases, but should be fine for most code.  It assumes that standard
built-in ECMAScript functions and classes have not been altered or replaced.
You might want to try it on your own code; it should reduce the minified size.
Some examples of the optimizations made when this option is enabled:

- new Array(1, 2, 3) or Array(1, 2, 3) → [ 1, 2, 3 ]
- Array.from([1, 2, 3]) → [1, 2, 3]
- new Object() → {}
- String(exp) or exp.toString() → "" + exp
- new Object/RegExp/Function/Error/Array (...) → we discard the new
- "foo bar".substr(4) → "bar"

Conditional compilation


You can use the --define (-d) switch in order to declare global
variables that Terser will assume to be constants (unless defined in
scope).  For example if you pass --define DEBUG=false then, coupled with
dead code removal Terser will discard the following from the output:
  1. ``` js
  2. if (DEBUG) {
  3.     console.log("debug stuff");
  4. }
  5. ```

You can specify nested constants in the form of --define env.DEBUG=false.

Another way of doing that is to declare your globals as constants in a
separate file and include it into the build.  For example you can have a
build/defines.js file with the following:
  1. ``` js
  2. var DEBUG = false;
  3. var PRODUCTION = true;
  4. // etc.
  5. ```

and build your code like this:

    terser build/defines.js js/foo.js js/bar.js... -c

Terser will notice the constants and, since they cannot be altered, it
will evaluate references to them to the value itself and drop unreachable
code as usual.  The build will contain the const declarations if you use
them. If you are targeting < ES6 environments which does not support const,
using var with reduce_vars (enabled by default) should suffice.

Conditional compilation API


You can also use conditional compilation via the programmatic API. With the difference that the
property name is global_defs and is a compressor property:

  1. ``` js
  2. var result = await minify(fs.readFileSync("input.js", "utf8"), {
  3.     compress: {
  4.         dead_code: true,
  5.         global_defs: {
  6.             DEBUG: false
  7.         }
  8.     }
  9. });
  10. ```

To replace an identifier with an arbitrary non-constant expression it is
necessary to prefix the global_defs key with "@" to instruct Terser
to parse the value as an expression:
  1. ``` js
  2. await minify("alert('hello');", {
  3.     compress: {
  4.         global_defs: {
  5.             "@alert": "console.log"
  6.         }
  7.     }
  8. }).code;
  9. // returns: 'console.log("hello");'
  10. ```

Otherwise it would be replaced as string literal:
  1. ``` js
  2. await minify("alert('hello');", {
  3.     compress: {
  4.         global_defs: {
  5.             "alert": "console.log"
  6.         }
  7.     }
  8. }).code;
  9. // returns: '"console.log"("hello");'
  10. ```

Annotations


Annotations in Terser are a way to tell it to treat a certain function call differently. The following annotations are available:

`/@__INLINE__/` - forces a function to be inlined somewhere.
`/@__NOINLINE__/` - Makes sure the called function is not inlined into the call site.
`/@__PURE__/` - Marks a function call as pure. That means, it can safely be dropped.

You can use either a @ sign at the start, or a #.

Here are some examples on how to use them:

  1. ``` js
  2. /*@__INLINE__*/
  3. function_always_inlined_here()

  5. /*#__NOINLINE__*/
  6. function_cant_be_inlined_into_here()

  8. const x = /*#__PURE__*/i_am_dropped_if_x_is_not_used()
  9. ```

ESTree / SpiderMonkey AST


Terser has its own abstract syntax tree format; for
practical reasons
we can't easily change to using the SpiderMonkey AST internally.  However,
Terser now has a converter which can import a SpiderMonkey AST.

For example [Acorn][acorn] is a super-fast parser that produces a
SpiderMonkey AST.  It has a small CLI utility that parses one file and dumps
the AST in JSON on the standard output.  To use Terser to mangle and
compress that:

    acorn file.js | terser -p spidermonkey -m -c

The -p spidermonkey option tells Terser that all input files are not
JavaScript, but JS code described in SpiderMonkey AST in JSON.  Therefore we
don't use our own parser in this case, but just transform that AST into our
internal AST.

spidermonkey is also available in minify as parse and format options to
accept and/or produce a spidermonkey AST.

Use Acorn for parsing


More for fun, I added the -p acorn option which will use Acorn to do all
the parsing.  If you pass this option, Terser will require("acorn").

Acorn is really fast (e.g. 250ms instead of 380ms on some 650K code), but
converting the SpiderMonkey tree that Acorn produces takes another 150ms so
in total it's a bit more than just using Terser's own parser.

[acorn]: https://github.com/ternjs/acorn
[sm-spec]: https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k

Terser Fast Minify Mode


It's not well known, but whitespace removal and symbol mangling accounts
for 95% of the size reduction in minified code for most JavaScript - not
elaborate code transforms. One can simply disable compress to speed up
Terser builds by 3 to 4 times.

d3.jssizegziptime
------:---:---:
original451,131108,733-
terser@3.7.5316,60085,2450.82
terser@3.7.5220,21672,7301.45
terser@3.7.5212,04670,9545.87
babili@0.1.4210,71372,14012.64
babel-minify@0.4.3210,32172,24248.67
babel-minify@0.5.0-alpha.01eac1c3210,42172,23814.17

To enable fast minify mode from the CLI use:
  1. ```
  2. terser file.js -m
  3. ```
To enable fast minify mode with the API use:
  1. ``` js
  2. await minify(code, { compress: false, mangle: true });
  3. ```

Source maps and debugging


Various compress transforms that simplify, rearrange, inline and remove code
are known to have an adverse effect on debugging with source maps. This is
expected as code is optimized and mappings are often simply not possible as
some code no longer exists. For highest fidelity in source map debugging
disable the compress option and just use mangle.

Compiler assumptions


To allow for better optimizations, the compiler makes various assumptions:

- .toString() and .valueOf() don't have side effects, and for built-in
  objects they have not been overridden.
- undefined, NaN and Infinity have not been externally redefined.
- arguments.callee, arguments.caller and Function.prototype.caller are not used.
- The code doesn't expect the contents of Function.prototype.toString() or
  Error.prototype.stack to be anything in particular.
- Getting and setting properties on a plain object does not cause other side effects
  (using .watch() or Proxy).
- Object properties can be added, removed and modified (not prevented with
  Object.defineProperty(), Object.defineProperties(), Object.freeze(),
  Object.preventExtensions() or Object.seal()).
- document.all is not == null
- Assigning properties to a class doesn't have side effects and does not throw.

Build Tools and Adaptors using Terser


https://www.npmjs.com/browse/depended/terser

Replacing uglify-es with terser in a project using yarn


A number of JS bundlers and uglify wrappers are still using buggy versions
of uglify-es and have not yet upgraded to terser. If you are using yarn
you can add the following alias to your project's package.json file:

  1. ``` js
  2.   "resolutions": {
  3.     "uglify-es": "npm:terser"
  4.   }
  5. ```

to use terser instead of uglify-es in all deeply nested dependencies
without changing any code.

Note: for this change to take effect you must run the following commands
to remove the existing yarn lock file and reinstall all packages:

  1. ```
  2. $ rm -rf node_modules yarn.lock
  3. $ yarn
  4. ```

Reporting issues


In the terser CLI we use source-map-support to produce good error stacks. In your own app, you're expected to enable source-map-support (read their docs) to have nice stack traces that will help you write good issues.

Obtaining the source code given to Terser


Because users often don't control the call to await minify() or its arguments, Terser provides a TERSER_DEBUG_DIR environment variable to make terser output some debug logs. If you're using a bundler or a project that includes a bundler and are not sure what went wrong with your code, pass that variable like so:

  1. ```
  2. $ TERSER_DEBUG_DIR=/path/to/logs command-that-uses-terser
  3. $ ls /path/to/logs
  4. terser-debug-123456.log
  5. ```

If you're not sure how to set an environment variable on your shell (the above example works in bash), you can try using cross-env:

  1. ```
  2. > npx cross-env TERSER_DEBUG_DIR=/path/to/logs command-that-uses-terser
  3. ```

README.md Patrons:


*note*: You can support this project on patreon: [link] **The Terser Patreon is shutting down in favor of opencollective**. Check out [PATRONS.md](https://github.com/terser/terser/blob/master/PATRONS.md) for our first-tier patrons.

These are the second-tier patrons. Great thanks for your support!

CKEditor undefined
38elements undefined

Contributors


Code Contributors


This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors


Become a financial contributor and help us sustain our community. [Contribute]

Individuals



Organizations


Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]