• Stars
    star
    613
  • Rank 70,873 (Top 2 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 13 years ago
  • Updated 6 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Ruby wrapper for UglifyJS JavaScript compressor.

Uglifier

Ruby wrapper for UglifyJS JavaScript compressor.

UglifyJS only works with ES5. If you need to compress ES6, ruby-terser is a better option.

Rails

When used in Rails, replace

config.assets.js_compressor = :uglifier

with

config.assets.js_compressor = Uglifier.new(harmony: true)

in config/environments/production.rb.

Installation

Uglifier is available as a ruby gem.

$ gem install uglifier

Ensure that your environment has a JavaScript interpreter supported by ExecJS. Using therubyracer gem is a safe choice if a runtime isn't already present. Note that while JScript built-in Windows 7 and older works, it is extremely slow.

Usage

require 'uglifier'

Uglifier.new.compile(File.read("source.js"))
# => js file minified

# Or alternatively
Uglifier.compile(File.read("source.js"))

Uglifier also supports generating source maps:

uglified, source_map = Uglifier.new.compile_with_map(source)

When initializing UglifyJS, you can tune the behavior of UglifyJS by passing options. For example, if you want disable variable name mangling:

Uglifier.new(:mangle => false).compile(source)

# Or
Uglifier.compile(source, :mangle => false)

Available options and their defaults are

{
  :output => {
    :ascii_only => true,        # Escape non-ASCII characters
    :comments => :copyright,    # Preserve comments (:all, :jsdoc, :copyright, :none, Regexp (see below))
    :inline_script => false,    # Escape occurrences of </script in strings
    :quote_keys => false,       # Quote keys in object literals
    :max_line_len => 32 * 1024, # Maximum line length in minified code
    :bracketize => false,       # Bracketize if, for, do, while or with statements, even if their body is a single statement
    :semicolons => true,        # Separate statements with semicolons
    :preserve_line => false,    # Preserve line numbers in outputs
    :beautify => false,         # Beautify output
    :indent_level => 4,         # Indent level in spaces
    :indent_start => 0,         # Starting indent level
    :width => 80,               # Specify line width when beautifier is used (only with beautifier)
    :preamble => nil,           # Preamble for the generated JS file. Can be used to insert any code or comment.
    :wrap_iife => false,        # Wrap IIFEs in parenthesis. Note: this disables the negate_iife compression option.
    :shebang => true,           # Preserve shebang (#!) in preamble (shell scripts)
    :quote_style => 0,          # Quote style, possible values :auto (default), :single, :double, :original
    :keep_quoted_props => false # Keep quotes property names
  },
  :mangle => {
    :eval => false,             # Mangle names when eval of when is used in scope
    :reserved => ["$super"],    # Argument names to be excluded from mangling
    :sort => false,             # Assign shorter names to most frequently used variables. Often results in bigger output after gzip.
    :toplevel => false,         # Mangle names declared in the toplevel scope
    :properties => false,       # Mangle property names
    :keep_fnames => false       # Do not modify function names
  },                            # Mangle variable and function names, set to false to skip mangling
  :mangle_properties => {
    :regex => nil,              # A regular expression to filter property names to be mangled
    :ignore_quoted => false,    # Only mangle unquoted property names
    :debug => false,            # Mangle names with the original name still present
  },                            # Mangle property names, disabled by default
  :compress => {
    :sequences => true,         # Allow statements to be joined by commas
    :properties => true,        # Rewrite property access using the dot notation
    :dead_code => true,         # Remove unreachable code
    :drop_debugger => true,     # Remove debugger; statements
    :unsafe => false,           # Apply "unsafe" transformations
    :unsafe_comps => 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_math => false,      # Optimize numerical expressions like 2 * x * 3 into 6 * x, which may give imprecise floating point results.
    :unsafe_proto => false,     # Optimize expressions like Array.prototype.slice.call(a) into [].slice.call(a)
    :conditionals => true,      # Optimize for if-s and conditional expressions
    :comparisons => true,       # Apply binary node optimizations for comparisons
    :evaluate => true,          # Attempt to evaluate constant expressions
    :booleans => true,          # Various optimizations to boolean contexts
    :loops => true,             # Optimize loops when condition can be statically determined
    :unused => true,            # Drop unreferenced functions and variables
    :toplevel => false,         # Drop unreferenced top-level functions and variables
    :top_retain => [],          # prevent specific toplevel functions and variables from `unused` removal
    :hoist_funs => true,        # Hoist function declarations
    :hoist_vars => false,       # Hoist var declarations
    :if_return => true,         # Optimizations for if/return and if/continue
    :join_vars => true,         # Join consecutive var statements
    :collapse_vars => false,    # Collapse single-use var and const definitions when possible.
    :reduce_funcs => false,     # Inline single-use functions as function expressions. Depends on reduce_vars.
    :reduce_vars => false,      # Collapse variables assigned with and used as constant values.
    :negate_iife => true,       # Negate immediately invoked function expressions to avoid extra parens
    :pure_getters => false,     # Assume that object property access does not have any side-effects
    :pure_funcs => nil,         # List of functions without side-effects. Can safely discard function calls when the result value is not used
    :drop_console => false,     # Drop calls to console.* functions
    :keep_fargs => false,       # Preserve unused function arguments
    :keep_fnames => false,      # Do not drop names in function definitions
    :passes => 1,               # Number of times to run compress. Raising the number of passes will increase compress time, but can produce slightly smaller code.
    :keep_infinity => false,    # Prevent compression of Infinity to 1/0
    :side_effects => true,      # Pass false to disable potentially dropping functions marked as "pure" using pure comment annotation. See UglifyJS documentation for details.
    :switches => true,          # de-duplicate and remove unreachable switch branches
  },                            # Apply transformations to code, set to false to skip
  :parse => {
    :bare_returns => false,     # Allow top-level return statements.
    :expression => false,       # Parse a single expression, rather than a program (for parsing JSON).
    :html5_comments => true,    # Ignore HTML5 comments in input
    :shebang => true,           # support #!command as the first line
    :strict => false
  },
  :define => {},                # Define values for symbol replacement
  :enclose => false,            # Enclose in output function wrapper, define replacements as key-value pairs
  :keep_fnames => false,        # Generate code safe for the poor souls relying on Function.prototype.name at run-time. Sets both compress and mangle keep_fanems to true.
  :source_map => {
    :map_url => false,          # Url for source mapping to be appended in minified source
    :url => false,              # Url for original source to be appended in minified source
    :sources_content => false,  # Include original source content in map
    :filename => nil,           # The filename of the input file
    :root => nil,               # The URL of the directory which contains :filename
    :output_filename => nil,    # The filename or URL where the minified output can be found
    :input_source_map => nil    # The contents of the source map describing the input
  },
  :error_context_lines => 8,    # How many context lines surrounding the error line. Env var ERROR_CONTEXT_LINES overrides this option
  :harmony => false             # Enable ES6/Harmony mode (experimental). Disabling mangling and compressing is recommended with Harmony mode.
}

When passing a regular expression to the output => comments option, be sure to pass a valid Ruby Regexp. The beginning and ending of comments are removed and cannot be matched (/*, */, //). For example: When matching

/*!
 * comment
 */

use Uglifier.new(output: {comments: /^!/}).

Development

Tests are run using

bundle exec rake

See CONTRIBUTING for details about working on and contributing to Uglifier.

Copyright

© Ville Lautanala. Released under MIT license, see LICENSE for details.

More Repositories

1

piperator

Composable pipelines for Enumerators.
Ruby
204
star
2

refined-github-safari

(Deprecated) Safari version of the Refined Github extension
Swift
126
star
3

ruuvitag-listener

Listen to RuuviTag measurements and output in Telegraf compatible format
Rust
30
star
4

rollup-plugin-coffee-script

Integration between Rollup and CoffeeScript.
JavaScript
22
star
5

unicode-substring

Unicode-aware substring for JavaScript
JavaScript
22
star
6

rollup-plugin-browserify-transform

Use Browserify transforms with Rollup
JavaScript
21
star
7

redis-rails-instrumentation

Railtie to include Redis commands in Rails logging.
Ruby
16
star
8

emojie

Image fallback for emoji
JavaScript
16
star
9

rscsv

Experiments combining Ruby, Rust, and CSV
Ruby
16
star
10

bacontrap

Keyboard shortcuts with Bacon.js
JavaScript
11
star
11

excon-rails

Railtie to include Excon HTTP requests in Rails logging.
Ruby
6
star
12

cec-alsa-volume

Sync HDMI CEC volume events with ALSA mixer
JavaScript
6
star
13

encrypted_form_fields

Encrypted form fields for Rails apps.
Ruby
5
star
14

lisp-prolog

Implementation of a toy Lisp using Prolog
Prolog
4
star
15

socket-io-rails

Socket.IO-client in Rails asset pipeline
Ruby
4
star
16

sweet_notifications

Syntactic sugar for ActiveSupport::LogSubscribers
Ruby
3
star
17

terraform-kubernetes-influxdb-grafana

Terraform Kubernetes example with InfluxDB and Grafana
HCL
3
star
18

dotfiles

This is how I roll
Shell
2
star
19

bacon-jest-test

An example of using Bacon.js with Jest
JavaScript
2
star
20

wtf8

UTF-8 encoder and decoder for Node
JavaScript
2
star
21

hot-shots-deux

Hot Shots (Node.js StatsD client) wrapper with key-value Datadog/Telegraf tags
TypeScript
2
star
22

emojie-iphone

Emoji images for incompatible browsers using Emojie
JavaScript
2
star
23

plex-yle-areena

Yle Areena plugin for Plex Media Center
Python
1
star
24

rack-inflater

Decompress body of incoming HTTP requests.
Ruby
1
star
25

scala-tmbundle

My hacks on the "official" TextMate Scala bundle
Ruby
1
star