wireapp/grunt-contrib-uglify

Name: grunt-contrib-uglify

Owner: Wire Swiss GmbH

Description: Minify files with UglifyJS.

Forked from: gruntjs/grunt-contrib-uglify

Created: 2017-03-16 14:38:28.0

Updated: 2017-10-07 16:31:21.0

Pushed: 2017-08-31 13:11:25.0

Homepage: http://gruntjs.com/

Size: 612

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

grunt-contrib-uglify v3.0.1 Build Status: Linux Build Status: Windows

Minify JavaScript files with UglifyJS

Getting Started

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

install grunt-contrib-uglify --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

t.loadNpmTasks('grunt-contrib-uglify');
Uglify task

Run this task with the grunt uglify command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Options

This task primarily delegates to UglifyJS, so please consider their documentation as required reading for advanced configuration.

Deprecated options from 2.x

Option | Replacement ———————– | ———– ASCIIOnly | output.ascii_only enclose | — exportAll | — expression | parse.expression indentLevel | output.indent_level mangleProperties | mangle.properties maxLineLen | output.max_line_len preserveComments | output.comments quoteStyle | output.quote_style screwIE8 | !ie8 sourceMapIncludeSources | sourceMap.includeSources sourceMapRoot | sourceMap.root sourceMapUrl | sourceMap.url

mangle

Type: Boolean Object
Default: {}

Turn on or off mangling with default options. If an Object is specified, it is passed directly to ast.mangle_names() and ast.compute_char_frequency() (mimicking command line behavior). View all options here.

compress

Type: Boolean Object
Default: {}

Turn on or off source compression with default options. If an Object is specified, it is passed as options to UglifyJS.Compressor(). View all options here.

beautify

Type: Boolean Object
Default: false

Turns on beautification of the generated source code. View all options here

parse.expression

Type: Boolean
Default: false

Parse a single expression, rather than a program (for parsing JSON)

report

Type: string
Choices: 'min', 'gzip'
Default: 'min'

Report minification result or both minification and gzip results. This is useful to see exactly how well uglify-js is performing but using 'gzip' will make the task take 5-10x longer to complete. Example output.

sourceMap

Type: Boolean
Default: false

If true, a source map file will be generated in the same directory as the dest file. By default it will have the same basename as the dest file, but with a .map extension.

sourceMapName

Type: String Function
Default: undefined

To customize the name or location of the generated source map, pass a string to indicate where to write the source map to. If a function is provided, the uglify destination is passed as the argument and the return value will be used as the file name.

sourceMapIn

Type: String Function
Default: undefined

The location of an input source map from an earlier compilation, e.g. from CoffeeScript. If a function is provided, the uglify source is passed as the argument and the return value will be used as the sourceMap name. This only makes sense when there's one source file.

sourceMap.includeSources

Type: Boolean
Default: false

Pass this flag if you want to include the content of source files in the source map as sourcesContent property.

sourceMap.root

Type: String
Default: undefined

With this option you can customize root URL that browser will use when looking for sources.

If the sources are not absolute URLs after prepending of the sourceMap.root, the sources are resolved relative to the source map.

sourceMap.url

Type: String
Default: undefined

Override the calculated value for sourceMappingURL in the source map. This is useful if the source map location is not relative to the base path of the minified file, i.e. when using a CDN

wrap

Type: String
Default: undefined

Wrap all of the code in a closure, an easy way to make sure nothing is leaking. For variables that need to be public exports and global variables are made available. The value of wrap is the global variable exports will be available as.

output.ascii_only

Type: Boolean
Default: false

Enables to encode non-ASCII characters as \uXXXX.

output.comments

Type: Boolean String Function
Default: undefined
Options: false 'all' 'some'

Turn on preservation of comments.

banner

Type: String
Default: ''

This string will be prepended to the minified output. Template strings (e.g. <%= config.value %> will be expanded automatically.

footer

Type: String
Default: ''

This string will be appended to the minified output. Template strings (e.g. <%= config.value %> will be expanded automatically.

ie8

Type: Boolean
Default: false

Set this to true if you still care about full compliance with Internet Explorer 6-8 quirks.

mangle.properties

Type: Boolean Object
Default: false

Turn on or off property mangling with default options. If an Object is specified, it is passed directly to ast.mangle_properties() (mimicking command line behavior). View all options here.

reserveDOMProperties

Type: Boolean
Default: false

Use this flag in conjunction with mangle.properties to prevent built-in browser object properties from being mangled.

exceptionsFiles

Type: Array
Default: []

Use this with mangle.properties to pass one or more JSON files containing a list of variables and object properties that should not be mangled. See the UglifyJS docs for more info on the file syntax.

nameCache

Type: String
Default: ''

A string that is a path to a JSON cache file that uglify will create and use to coordinate symbol mangling between multiple runs of uglify. Note: this generated file uses the same JSON format as the exceptionsFiles files.

output.quote_style

Type: Integer
Default: 0

Preserve or enforce quotation mark style.

Usage examples
Basic compression

This configuration will compress and mangle the input files using the default options.

roject configuration.
t.initConfig({
lify: {
my_target: {
  files: {
    'dest/output.min.js': ['src/input1.js', 'src/input2.js']
  }
}
No mangling

Specify mangle: false to prevent changes to your variable and function names.

roject configuration.
t.initConfig({
lify: {
options: {
  mangle: false
},
my_target: {
  files: {
    'dest/output.min.js': ['src/input.js']
  }
}
Reserved identifiers

You can specify identifiers to leave untouched with an reserved array in the mangle options.

roject configuration.
t.initConfig({
lify: {
options: {
  mangle: {
    reserved: ['jQuery', 'Backbone']
  }
},
my_target: {
  files: {
    'dest/output.min.js': ['src/input.js']
  }
}
Source maps

Generate a source map by setting the sourceMap option to true. The generated source map will be in the same directory as the destination file. Its name will be the basename of the destination file with a .map extension. Override these defaults with the sourceMapName attribute.

roject configuration.
t.initConfig({
lify: {
my_target: {
  options: {
    sourceMap: true,
    sourceMapName: 'path/to/sourcemap.map'
  },
  files: {
    'dest/output.min.js': ['src/input.js']
  }
}
Advanced source maps

Set the sourceMap.includeSources option to true to embed your sources directly into the map. To include a source map from a previous compilation pass it as the value of the sourceMapIn option.

roject configuration.
t.initConfig({
lify: {
my_target: {
  options: {
    sourceMap: {
      includeSources: true
    },
    sourceMapIn: 'example/coffeescript-sourcemap.js', // input sourcemap from a previous compilation
  },
  files: {
    'dest/output.min.js': ['src/input.js'],
  },
},

Refer to the UglifyJS SourceMap Documentation for more information.

Turn off console warnings

Specify drop_console: true as part of the compress options to discard calls to console.* functions. This will suppress warning messages in the console.

roject configuration.
t.initConfig({
lify: {
options: {
  compress: {
    drop_console: true
  }
},
my_target: {
  files: {
    'dest/output.min.js': ['src/input.js']
  }
}
Beautify

Specify beautify: true to beautify your code for debugging/troubleshooting purposes. Pass an object to manually configure any other output options.

See UglifyJS documentation for more information.

roject configuration.
t.initConfig({
lify: {
my_target: {
  options: {
    beautify: true
  },
  files: {
    'dest/output.min.js': ['src/input.js']
  }
},
my_advanced_target: {
  options: {
    beautify: {
      width: 80
    }
  },
  files: {
    'dest/output.min.js': ['src/input.js']
  }
}
Banner comments

In this example, running grunt uglify:my_target will prepend a banner created by interpolating the banner template string with the config object. Here, those properties are the values imported from the package.json file (which are available via the pkg config property) plus today's date.

Note: you don't have to use an external JSON file. It's also valid to create the pkg object inline in the config. That being said, if you already have a JSON file, you might as well reference it.

roject configuration.
t.initConfig({
g: grunt.file.readJSON('package.json'),
lify: {
options: {
  banner: '/*! <%= pkg.name %> - v<%= pkg.version %> - ' +
    '<%= grunt.template.today("yyyy-mm-dd") %> */'
},
my_target: {
  files: {
    'dest/output.min.js': ['src/input.js']
  }
}
Conditional compilation

You can also enable UglifyJS conditional compilation. This is commonly used to remove debug code blocks for production builds. This is equivalent to the command line --define option.

See UglifyJS global definitions documentation for more information.

roject configuration.
t.initConfig({
lify: {
options: {
  compress: {
    global_defs: {
      'DEBUG': false
    },
    dead_code: true
  }
},
my_target: {
  files: {
    'dest/output.min.js': ['src/input.js']
  }
}
Compiling all files in a folder dynamically

This configuration will compress and mangle the files dynamically.

roject configuration.
t.initConfig({
lify: {
my_target: {
  files: [{
    expand: true,
    cwd: 'src/js',
    src: '**/*.js',
    dest: 'dest/js'
  }]
}
Compiling all files separately on the each their path

This configuration will compress and mangle all js files separately in each folder.

Also exclude jQuery for mangling and ignore all *.min.js files.

roject configuration.
fy: {
v: {
options: {
  mangle: {
    reserved: ['jQuery']
  }
},
files: [{
  expand: true,
  src: ['dist/assets/js/*.js', '!dist/assets/js/*.min.js'],
  dest: 'dist/assets',
  cwd: '.',
  rename: function (dst, src) {
    // To keep the source js files and make new files as `*.min.js`:
    // return dst + '/' + src.replace('.js', '.min.js');
    // Or to override to src:
    return src;
  }
}]
Turn on object property name mangling

This configuration will turn on object property name mangling, but not mangle built-in browser object properties. Additionally, variables and object properties listed in the myExceptionsFile.json will be mangled. For more info, on the format of the exception file format please see the UglifyJS docs.

roject configuration.
t.initConfig({
lify: {
options: {
  mangle: {
    properties: true
  },
  reserveDOMCache: true,
  exceptionsFiles: [ 'myExceptionsFile.json' ]
},
my_target: {
  files: {
    'dest/output.min.js': ['src/input.js']
  }
}
Turn on use of name mangling cache

Turn on use of name mangling cache to coordinate mangled symbols between outputted uglify files. uglify will the generate a JSON cache file with the name provided in the options. Note: this generated file uses the same JSON format as the exceptionsFiles files.

roject configuration.
t.initConfig({
lify: {
options: {
  nameCache: '.tmp/grunt-uglify-cache.json',
},
my_target: {
  files: {
    'dest/output1.min.js': ['src/input1.js'],
    'dest/output2.min.js': ['src/input2.js']
  }
}
Release History

Task submitted by “Cowboy” Ben Alman

This file was generated on Sat May 20 2017 19:52:43.

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.