Giter Club home page Giter Club logo

esmangle's Introduction

esmangle NPM version Build Status Dependency Status

esmangle (esmangle) is mangler / minifier for Parser API AST.

Install

esmangle can be used in a web browser: Download

<script src="esmangle.js"></script>

Node.js application via the package manager:

npm install esmangle

If you would like to use latest esmangle in a browser, you can build build/esmangle.min.js:

npm run-script build

Usage

A simple example: the program

var ast = esprima.parse(code);
var result = esmangle.mangle(ast);  // gets mangled AST
console.log(escodegen.generate(result));  // dump AST

Or you can simply use this esmangle command in the shell.

$ esmangle file.js

Get more compressed result: (in Node.js)

var ast = esprima.parse(code);
// Get optimized AST
var optimized = esmangle.optimize(ast, null);
// gets mangled AST
var result = esmangle.mangle(optimized);
console.log(escodegen.generate(result, {
    format: {
        renumber: true,
        hexadecimal: true,
        escapeless: true,
        compact: true,
        semicolons: false,
        parentheses: false
    }
}));  // dump AST

Design

Slide is here. This resolution algorithm is based on my bytecode compiler iv / lv5 / railgun.

License

Copyright (C) 2012 Yusuke Suzuki (twitter: @Constellation) and other contributors.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

esmangle's People

Contributors

albin3 avatar ariya avatar constellation avatar dvdotsenko avatar ikarienator avatar jaens avatar magalhas avatar mathiasbynens avatar michaelficarra avatar mooz avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

esmangle's Issues

Bring some information over passes

For example, we can use constant folding result value to determine target branch is dead or not.

var s = 10;
if (!s) {  // this is dead code
   ...
}

But folding simply, sometimes we generate more codes...

var s = 10000000000000000000000000000000000;  // too big number
s,s,s,s,s,

So I think we attach some information to AST node like __$esmangle_constant to store calculated result.

constant folding

Just a general reminder to do constant folding.

  • "a" + "b" -> "ab"
  • 0 + 1 -> 1
  • typeof function(){} -> "function"
  • etc.

Convenience use in the browser

While it's not the primary use case, a browser-based version is very useful to quickly check different kind of transformation. I see two possible solutions:

  • A specialized build for the browser, much like the current demo (browserify?). This requires a build step but that's likely needed only for each version and not every commit.
  • Modify the code so that all the requires to escope, estraverse, etc are not needed in a browser environment. Here we assume that the user should already make them available as the dependencies.

hoist variable declarations to parameters in IIFEs that don't mention `arguments`

(function(something){
    var a, b;
    sideEffect(a(b));
})(somethingElse)

is a common pattern that can be shortened with a step that provides the following transformation:

(function(something, a, b){
    sideEffect(a(b));
})(somethingElse)

You just have to watch out for arguments references within the function body (but not nested under other functions).

inlining pass

We can provide inlining optimize pass optionally.

dead code elimination: non-rightmost sequence members without side effects

If an expression in a sequence does not have side effects and it's not the rightmost expression, it can be eliminated.

  • 0, 1, 2 -> empty program
  • f(), 1, 2 -> f()
  • f(), 1, g() -> f(), g()
  • f((0, 1, 2)) -> f(2)
  • f((g(), 1, 2)) -> f((g(), 2)) (or, fancier: g(),f(2))

Be careful to preserve indirect eval, though:

  • (999, eval)(str) -> (0, eval)(str)

Fails to minify raphael.js

wget http://github.com/DmitryBaranovskiy/raphael/raw/master/raphael.js
esmangle.js raphael.js

โ†’

/.../esmangle/node_modules/escodegen/escodegen.js:354
    throw new Error('Numeric literal whose value is negative');

I'm filing it on Esmangle, but it's possibly an Escodegen issue.

Add --output option to bin/esmangle.js

Hi, and thanks for your work.

I'd like to use esmangle in my project, but because I have to do dirty hacks to actually get messages from node when running from PHP (2>&1), I can't get the source from the result, so I'd like to be able to pass an --output (-o) directive to tell esmangle where to save the minified file.

(this might be as easy as to add this : - but I don't know if this is how you'd want it to work / how optimist works

//generated is basically all the files concatened
if (argv['output'] == null) {
  console.log(generated);
} else {
  fs.writeFile(argv['output'], generated);
}

Thanks!

run tests using only the applicable rule{,s}

Tests that are currently passing may be invalidated by introducing additional, advanced rewriting rules. For example, in the same way we don't apply the name mangling to the tests, we also shouldn't apply the boolean rewriting to tests where that optimisation isn't involved in what we're testing. Maybe a JSON file with a mapping from test names to a list of the applicable rules would be a better solution.

push preceding expressions inside `for`'s initialiser

This can allow us to reduce more blocks. Taken from UglifyJS2. See this test case:

if (foo) {
    a = x();
    b = y();
    for (; a < b; ++a) console.log(a);
}

to

if (foo) for (a = x(), b = y(); a < b; ++a) console.log(a);

expose a function that uses all passes

This way, consumers of this tool that want to take advantage of as many transformations as possible don't need to keep updating how they invoke esmangle when new passes are added. This is the function that would be used in bin/esmangle.js.

`typeof X == "undefined"` to `X === void 0` for some X

As long as X is not an identifier, this is safe. If X is an identifier, but we can determine that it will be in scope (and not a global), it is safe. Otherwise, it is unsafe. Test cases:

  • transform

    (function(){
      return typeof x() == "undefined";
    }())

    to

    (function(){
      return x() === void 0;
    }())
  • transform

    (function(){
      var x;
      return function(){
        return typeof x === 'undefined';
      };
    }()

    to

    (function(){
      var x;
      return function(){
        return x === void 0;
      };
    }()

pin packages

Please pin the dependencies to the exact version not >= or ~

It makes a big difference for people with deployed code to have the same versions deployed if they are depending on your packages. By using >= or really anything except exact pinning you open yourself and your users to broken packages when versions change.

remove wasted return statement

function t() {
  if (a) {
    ...
  }
  return;
}

should be transformed to

function t() {
  if (a) {
    ...
  }
}
function f() {
  return void 0;
}

to

function t() { }

We should check control flow and eliminate wasted return statement.

README clarification

According to the README this is how you use esmangle:

 var ast = esprima.parse(code);
 var result = esmangle.mangle(ast);  // gets mangled result

But when I tried this, I get an Object back and not a string.

Then I browsed the CLI script and saw this:

https://github.com/Constellation/esmangle/blob/master/bin/esmangle.js#L55-68

It runs though these steps:

  • esprima.parse
  • esmangle.optimize
  • esmangle.mangle
  • escodegen.generate

Can you update the README to document the proper way to take a string of JSCode and minify it into a string worth writing into a file?

Maybe add som sugar so that I can require esmangle and not have to require esmangle, esprima and escodegen?

More flexible pipeline construction

We should provide more flexible pipeline construction.
For example,

esmangle.optimize(tree, [
[
  'pre-passes'
],
[
  'passes'
],
[
  'post-passes'
]
]);

Add minifying passes

We should add more minifying passes.

Like,

  • remove blocks
  • reordering statements (for minifying, like function declaration)

drop unused assignemnts

Drop unused assignments

function test() {
  var i;
  i = 20;
}

to

function test() {
  var i;
  20;
}

and then

function test() {
  var i;
}

and finally

function test() { }

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.