Git Product home page Git Product logo

closure-compiler's Introduction

Build Status

The Closure Compiler is a tool for making JavaScript download and run faster. It is a true compiler for JavaScript. Instead of compiling from a source language to machine code, it compiles from JavaScript to better JavaScript. It parses your JavaScript, analyzes it, removes dead code and rewrites and minimizes what's left. It also checks syntax, variable references, and types, and warns about common JavaScript pitfalls.

Getting Started

Options for Getting Help

  1. Post in the Closure Compiler Discuss Group
  2. Ask a question on Stack Overflow
  3. Consult the FAQ

Building it Yourself

Note: The Closure Compiler requires Java 7 or higher.

Using Maven

  1. Download Maven.

  2. Add sonatype snapshots repository to ~/.m2/settings.xml:

    <profile>
      <id>allow-snapshots</id>
         <activation><activeByDefault>true</activeByDefault></activation>
      <repositories>
        <repository>
          <id>snapshots-repo</id>
          <url>https://oss.sonatype.org/content/repositories/snapshots</url>
          <releases><enabled>false</enabled></releases>
          <snapshots><enabled>true</enabled></snapshots>
        </repository>
      </repositories>
    </profile>
    
  3. Run mvn -DskipTests (omit the -DskipTests if you want to run all the unit tests too).

    This will produce a jar file called target/closure-compiler-1.0-SNAPSHOT.jar.

    Running mvn -DskipTests -pl externs/pom.xml,pom-main.xml,pom-main-shaded.xml will skip building the GWT version of the compiler. This can speed up the build process significantly.

Using Eclipse

  1. Download and open the Eclipse IDE.
  2. Run mvn eclipse:eclipse -DdownloadSources=true to download JARs and build Eclipse project configuration.
  3. Navigate to File > Import > Maven > Existing Maven Projects and browse to closure-compiler.
  4. Import both closure-compiler and the nested externs project.
  5. Disregard the warnings about maven-antrun-plugin and build errors.
  6. In Package Explorer, remove from the build path:
    • src/com/google/javascript/jscomp/debugger/DebuggerGwtMain.java
    • src/com/google/javascript/jscomp/gwt/
  7. See Using Maven above to build the JAR.

Running

On the command line, at the root of this project, type

java -jar target/closure-compiler-1.0-SNAPSHOT.jar

This starts the compiler in interactive mode. Type

var x = 17 + 25;

then hit "Enter", then hit "Ctrl-Z" (on Windows) or "Ctrl-D" (on Mac or Linux) and "Enter" again. The Compiler will respond:

var x=42;

The Closure Compiler has many options for reading input from a file, writing output to a file, checking your code, and running optimizations. To learn more, type

java -jar compiler.jar --help

More detailed information about running the Closure Compiler is available in the documentation.

Compiling Multiple Scripts

If you have multiple scripts, you should compile them all together with one compile command.

java -jar compiler.jar --js_output_file=out.js in1.js in2.js in3.js ...

You can also use minimatch-style globs.

# Recursively include all js files in subdirs
java -jar compiler.jar --js_output_file=out.js 'src/**.js'

# Recursively include all js files in subdirs, excluding test files.
# Use single-quotes, so that bash doesn't try to expand the '!'
java -jar compiler.jar --js_output_file=out.js 'src/**.js' '!**_test.js'

The Closure Compiler will concatenate the files in the order they're passed at the command line.

If you're using globs or many files, you may start to run into problems with managing dependencies between scripts. In this case, you should use the Closure Library. It contains functions for enforcing dependencies between scripts, and Closure Compiler will re-order the inputs automatically.

How to Contribute

Reporting a bug

  1. First make sure that it is really a bug and not simply the way that Closure Compiler works (especially true for ADVANCED_OPTIMIZATIONS).
  1. If you still think you have found a bug, make sure someone hasn't already reported it. See the list of known issues.
  2. If it hasn't been reported yet, post a new issue. Make sure to add enough detail so that the bug can be recreated. The smaller the reproduction code, the better.

Suggesting a Feature

  1. Consult the FAQ to make sure that the behaviour you would like isn't specifically excluded (such as string inlining).
  2. Make sure someone hasn't requested the same thing. See the list of known issues.
  3. Read up on what type of feature requests are accepted.
  4. Submit your request as an issue.

Submitting patches

  1. All contributors must sign a contributor license agreement (CLA). A CLA basically says that you own the rights to any code you contribute, and that you give us permission to use that code in Closure Compiler. You maintain the copyright on that code. If you own all the rights to your code, you can fill out an individual CLA. If your employer has any rights to your code, then they also need to fill out a corporate CLA. If you don't know if your employer has any rights to your code, you should ask before signing anything. By default, anyone with an @google.com email address already has a CLA signed for them.
  2. To make sure your changes are of the type that will be accepted, ask about your patch on the Closure Compiler Discuss Group
  3. Fork the repository.
  4. Make your changes. Check out our coding conventions for details on making sure your code is in correct style.
  5. Submit a pull request for your changes. A project developer will review your work and then merge your request into the project.

Closure Compiler License

Copyright 2009 The Closure Compiler Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Dependency Licenses

Rhino

Code Path src/com/google/javascript/rhino, test/com/google/javascript/rhino
URL http://www.mozilla.org/rhino
Version 1.5R3, with heavy modifications
License Netscape Public License and MPL / GPL dual license
Description A partial copy of Mozilla Rhino. Mozilla Rhino is an implementation of JavaScript for the JVM. The JavaScript parse tree data structures were extracted and modified significantly for use by Google's JavaScript compiler.
Local Modifications The packages have been renamespaced. All code not relevant to the parse tree has been removed. A JsDoc parser and static typing system have been added.

Args4j

URL https://args4j.dev.java.net/
Version 2.33
License MIT
Description args4j is a small Java class library that makes it easy to parse command line options/arguments in your CUI application.
Local Modifications None

Guava Libraries

URL https://github.com/google/guava
Version 20.0
License Apache License 2.0
Description Google's core Java libraries.
Local Modifications None

JSR 305

URL https://github.com/findbugsproject/findbugs
Version 3.0.1
License BSD License
Description Annotations for software defect detection.
Local Modifications None

JUnit

URL http://sourceforge.net/projects/junit/
Version 4.12
License Common Public License 1.0
Description A framework for writing and running automated tests in Java.
Local Modifications None

Protocol Buffers

URL https://github.com/google/protobuf
Version 3.0.2
License New BSD License
Description Supporting libraries for protocol buffers, an encoding of structured data.
Local Modifications None

Truth

URL https://github.com/google/truth
Version 0.30
License Apache License 2.0
Description Assertion/Proposition framework for Java unit tests
Local Modifications None

Ant

URL http://ant.apache.org/bindownload.cgi
Version 1.9.7
License Apache License 2.0
Description Ant is a Java based build tool. In theory it is kind of like "make" without make's wrinkles and with the full portability of pure java code.
Local Modifications None

GSON

URL https://github.com/google/gson
Version 2.7
License Apache license 2.0
Description A Java library to convert JSON to Java objects and vice-versa
Local Modifications None

Node.js Closure Compiler Externs

Code Path contrib/nodejs
URL https://github.com/dcodeIO/node.js-closure-compiler-externs
Version e891b4fbcf5f466cc4307b0fa842a7d8163a073a
License Apache 2.0 license
Description Type contracts for NodeJS APIs
Local Modifications Substantial changes to make them compatible with NpmCommandLineRunner.

closure-compiler's People

Contributors

alexeagle avatar aravind-pg avatar blickly avatar brad4d avatar chadkillingsworth avatar concavelenz avatar dimvar avatar dominator008 avatar erincoughlan avatar fredj avatar gkdn avatar jacksongl avatar jelbourn avatar jklein24 avatar joeltine avatar kevinoconnor7 avatar lukesandberg avatar matrixfrog avatar mknichel avatar mprobst avatar nicks avatar pauldraper avatar phistuck avatar shicks avatar slaks avatar stalcup avatar tadeegan avatar vobruba-martin avatar vrana avatar zwarts avatar

Watchers

 avatar

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.