ClosureCompiler 0.1 (beta)

A command line interface to the Closure Compiler onlineservice.

Required Parameters

--jscode <code>, -j <code> The code option must be a string containing JavaScript, such as:

alert('hello').

--codeurl <url>, -u <url> The --codeurl option must contain the URL of a JavaScript file. You can include multiple codeurl option to specify multiple input files.

You must include at least one of --jscode or --codeurl options and you can include both multiples times.

--level <level>, -l <level> The degree of compression and optimization to apply to your JavaScript. There are three possible compilation levels:

whitespace Just removes whitespace and comments from your JavaScript.

simple Performs compression and optimization that does not interfere with the interaction between the compiled JavaScript and other JavaScript. This level renames only local variables. See `Communicating with the API`_ for more information about compiling with simple optimizations.

advanced Achieves the highest level of compression by renaming symbols in your JavaScript. When using advanced optimizations compilation you must perform extra steps to preserve references to external symbols. See `Advanced Compilation and Externs`_ for more information about advanced optimizations.

Defaults to a value of simple.

--format <format>, -f <format> The format for the Closure Compiler service's output. There are three possible output formats:

xml The xml output format wraps the requested information in valid XML.

The XML output looks like this:

<compilationResult>
<compiledCode>var a="hello";alert(a);</compiledCode>
<statistics>
<originalSize>98</originalSize>
<compressedSize>35</compressedSize>
<compileTime>0</compileTime>
</statistics>
</compilationResult>

The compiledCode section contains the compressed JavaScript that the Closure Compiler service produced. This section only appears if you use the --info option with a value of compiled_code. Similarly, the statistics section only appears if you use --info option with a value of statistics.

If you use --info option with a value of warnings and the compiler produces a warning, the output will include a warnings tag:

<compilationResult>

... <warnings> <warning type="JSC_NO_SIDE_EFFECT" file="default.js" lineno="12" charno="3" line="delete 1;">warning 1</warning> <warning type="JSC_UNUSED_VAR" file="default.js" lineno="13" charno="13" line="delete 1;">warning 2 </warning> </warnings> ... </compilationResult>

If you use --info with a value of errors, the Closure Compiler service will include an errors tag if your code contains a syntax error or other problem that prevents compilation. The errors tag looks like this:

<compilationResult>

... <errors> <error type="JSC_NO_SIDE_EFFECT" file="default.js" lineno="12" charno="3" line="var x=-'hello';">error 1 </error> <error type="JSC_UNUSED_VAR" file="default.js" lineno="13" charno="13" line="var x=-'hello'">error 2 </error> </errors> ... </compilationResult>

The file, line, and col attributes of the error and warning tags indicate where the Closure Compiler service encountered the error.

If the Closure Compiler service encounters an error that prevents the processing of your input, the output looks like this:

<compilationResult>
<serverErrors>
<error code="1">Over quota</error>
</serverErrors>
</compilationResult>

json The json output format wraps the requested information in a JavaScript Object Notation (JSON) string. Evaluation of this string as JavaScript returns a JavaScript Object.

The JSON output looks like this:

{

"compiledCode":/* raw code here */, {"errors": [ {"charno":4321, "error":"ERROR: You failed.", "lineno":1234, "file":"default.js", "type":"ERROR_TYPE", "line":"var x=-'hello';"}], "warnings": [ {"charno":4321, "lineno":1234, "file":"default.js", "type":"ERROR_TYPE", "warning":"Warning: You did something wrong!", "line":"delete 1;"}] "serverErrors":[ {"code":123,"error":"Over quota"} ], "statistics":{ "originalSize":10, "compressedSize":3000 "compileTime":10 } }

The JSON format is similar to the XML format: every tag in the XML output corresponds to a property of the same name in the JSON object

text The text output format returns raw text without tags or JSON brackets. If the --info includes compiled_code, the text contains JavaScript. If the --info includes warnings, the text contains warning messages. If the --info includes statistics, the text contains statistics.

The format option defaults to a value of text.

--info <type>, -i <type> Indicates the kind of output you want from the compiler. There are four possible kinds of output:

compiled_code A compressed and optimized version of your input JavaScript.

warnings Messages that indicate possible bugs in your JavaScript.

errors Messages that indicate syntax errors or other errors in your JavaScript.

statistics Information about the degree of compression that the Closure Compiler achieves. For xml output, the Closure Compiler service returns statistics in the following format:

<compilationResult>

... <statistics> <firstStatisticName>24</firstStatisticName> <secondStatisticName>15</secondStatisticName> </statistics> </compilationResult>

Optional Parameters

--externs <code>, -x <code> The value of this option must be JavaScript code that declares function names or other symbols. Use --externs to preserve symbols that are defined outside of the code you are compiling. The --externs option only has an effect if you are using a --level of advanced. See `Advanced Compilation`_ for more information.

--externurl <url>, -e <url> The value of this option must be the URL of a file containing JavaScript that declares function names or other symbols. The symbols declared in this file are preserved in exactly the same way as symbols listed directly in the --externs option. The --externurl option only has an effect if you are using a --level of advanced. See `Advanced Compilation`_ for more information.

You can specify this option multiple times if you have multiple externs files.

--nodefault By default, the Closure Compiler service uses a standard externs file that declares common externally defined symbols like document and all its methods. If you do NOT want to use these common externs, use this option.

See `Advanced Compilation and Externs`_ for more information about externs.

--filename <name>, -f <name> If present, the Closure Compiler service caches the compiled code for one hour and makes it available through a special URL. During this hour you can test the compiled code by pointing your browser to this URL. The URL has this form:

http://closure-compiler.appspot.com/code/[sesssion]/[name]

--formatting If present, this option must have a value of pretty_print or print_input_delimiter. You can provide multiple --formatting options in the. The pretty_print and print_input_delimiter values affect different aspects of the formatting, so you can include both without affecting the way either works.

pretty_print Te Closure Compiler service adds line breaks and indentation to its output code to make the code easier for humans to read. For example, output with pretty_print turned on looks like this:

function hello(a) { alert("Hello, " + a) } hello("New user");

Output with pretty_print turned off looks like this:

function hello(a){alert("Hello, "+a)}hello("New user");

print_input_delimiter The Closure Compiler service adds a separator between the compiler outputs for each file you compile. For example, if you compile two files together, the output looks like this:

// Input 0

alert("hi"); // Input 1 alert("bye");

The compiler inserts the // Input X delimiters to mark the boundaries between files. Note that the delimiters are comments, so they do not interfere with the execution of the JavaScript.

Each JavaScript file you provide with a --codeurl parameter has a corresponding delimited section in the compiler output. The Closure Compiler service treats all input from --jscode options as if it comes from a single file.

Input delimiters have many potential uses, including helping you to figure out which inputs are contributing the most to the size of the compiled code.

--closure If you use this option the compiler looks for goog.require() statements in the source code and supplies the Closure Library code requested by any such statements. It also performs optimizations designed specifically for Closure Library code. See the `Closure Library documentation`_ for more information about the Closure Library. See `Finding Your Way around the Closure Library`_ for more information about the goog.require() function.

Defaults to false.

--warning <level>, -w <level> Indicates the amount of information you want from the compiler about possible problems in your code. The --warning parameter only has an effect when an --info parameter with a value of warnings is also supplied. There are three possible warning levels:

QUIET Outputs only syntax error messages and warnings generated by the optimization passes included in the --level for the current compiler run.

DEFAULT In addition to syntax errors and warnings generated by optimization passes, outputs warnings generated by selected code-checking passes.

VERBOSE In addition to syntax errors and warnings generated by optimization passes, outputs warnings generated by all code-checking passes.

Defaults to a value of DEFAULT.