third_party/WebKit/Source/devtools/scripts/closure/README.md

   1 # [Google Closure Compiler](https://developers.google.com/closure/compiler/)
   2
   3 [![Build Status](https://travis-ci.org/google/closure-compiler.svg?branch=master)](https://travis-ci.org/google/closure-compiler)
   4
   5 The [Closure Compiler](https://developers.google.com/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.
   6
   7 ## Getting Started
   8  * [Download the latest version](http://dl.google.com/closure-compiler/compiler-latest.zip) ([Release details here](https://github.com/google/closure-compiler/wiki/Releases))
   9  * [Download a specific version](https://github.com/google/closure-compiler/wiki/Binary-Downloads)
  10  * See the [Google Developers Site](https://developers.google.com/closure/compiler/docs/gettingstarted_app) for documentation including instructions for running the compiler from the command line.
  11
  12 ## Options for Getting Help
  13 1. Post in the [Closure Compiler Discuss Group](https://groups.google.com/forum/#!forum/closure-compiler-discuss)
  14 2. Ask a question on [Stack Overflow](http://stackoverflow.com/questions/tagged/google-closure-compiler)
  15 3. Consult the [FAQ](https://github.com/google/closure-compiler/wiki/FAQ)
  16
  17 ## Building it Yourself
  18
  19 Note: The Closure Compiler requires [Java 7 or higher](http://www.java.com/).
  20
  21 ### Using [Ant](http://ant.apache.org/)
  22
  23 1. Download the [Ant build tool](http://ant.apache.org/bindownload.cgi).
  24
  25 2. At the root of the source tree, there is an Ant file named ```build.xml```.
  26    To use it, navigate to the same directory and type the command
  27
  28     ```
  29     ant jar
  30     ```
  31
  32     This will produce a jar file called ```build/compiler.jar```.
  33
  34 ### Using [Eclipse](http://www.eclipse.org/)
  35
  36 1. Download and open the [Eclipse IDE](http://www.eclipse.org/).
  37 2. Navigate to ```File > New > Project ...``` and create a Java Project. Give
  38    the project a name.
  39 3. Select ```Create project from existing source``` and choose the root of the
  40    checked-out source tree as the existing directory.
  41 3. Navigate to the ```build.xml``` file. You will see all the build rules in
  42    the Outline pane. Run the ```jar``` rule to build the compiler in
  43    ```build/compiler.jar```.
  44
  45 ## Running
  46
  47 On the command line, at the root of this project, type
  48
  49 ```
  50 java -jar build/compiler.jar
  51 ```
  52
  53 This starts the compiler in interactive mode. Type
  54
  55 ```javascript
  56 var x = 17 + 25;
  57 ```
  58
  59 then hit "Enter", then hit "Ctrl-Z" (on Windows) or "Ctrl-D" (on Mac or Linux)
  60 and "Enter" again. The Compiler will respond:
  61
  62 ```javascript
  63 var x=42;
  64 ```
  65
  66 The Closure Compiler has many options for reading input from a file, writing
  67 output to a file, checking your code, and running optimizations. To learn more,
  68 type
  69
  70 ```
  71 java -jar compiler.jar --help
  72 ```
  73
  74 More detailed information about running the Closure Compiler is available in the
  75 [documentation](http://code.google.com/closure/compiler/docs/gettingstarted_app.html).
  76
  77 ## Compiling Multiple Scripts
  78
  79 If you have multiple scripts, you should compile them all together with one
  80 compile command.
  81
  82 ```bash
  83 java -jar compiler.jar --js_output_file=out.js in1.js in2.js in3.js ...
  84 ```
  85
  86 You can also use minimatch-style globs.
  87
  88 ```bash
  89 # Recursively include all js files in subdirs
  90 java -jar compiler.jar --js_output_file=out.js 'src/**.js'
  91
  92 # Recursively include all js files in subdirs, exclusing test files.
  93 # Use single-quotes, so that bash doesn't try to expand the '!'
  94 java -jar compiler.jar --js_output_file=out.js 'src/**.js' '!**_test.js'
  95 ```
  96
  97 The Closure Compiler will concatenate the files in the order they're passed at
  98 the command line.
  99
 100 If you're using globs or many files, you may start to run into
 101 problems with managing dependencies between scripts. In this case, you should
 102 use the [Closure Library](https://developers.google.com/closure/library/). It
 103 contains functions for enforcing dependencies between scripts, and Closure Compiler
 104 will re-order the inputs automatically.
 105
 106 ## How to Contribute
 107 ### Reporting a bug
 108 1. First make sure that it is really a bug and not simply the way that Closure Compiler works (especially true for ADVANCED_OPTIMIZATIONS).
 109  * Check the [official documentation](https://developers.google.com/closure/compiler/)
 110  * Consult the [FAQ](https://github.com/google/closure-compiler/wiki/FAQ)
 111  * Search on [Stack Overflow](http://stackoverflow.com/questions/tagged/google-closure-compiler) and in the [Closure Compiler Discuss Group](https://groups.google.com/forum/#!forum/closure-compiler-discuss)
 112 2. If you still think you have found a bug, make sure someone hasn't already reported it. See the list of [known issues](https://github.com/google/closure-compiler/issues).
 113 3. 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.
 114
 115 ### Suggesting a Feature
 116 1. Consult the [FAQ](https://github.com/google/closure-compiler/wiki/FAQ) to make sure that the behaviour you would like isn't specifically excluded (such as string inlining).
 117 2. Make sure someone hasn't requested the same thing. See the list of [known issues](https://github.com/google/closure-compiler/issues).
 118 3. Read up on [what type of feature requests are accepted](https://github.com/google/closure-compiler/wiki/FAQ#how-do-i-submit-a-feature-request-for-a-new-type-of-optimization).
 119 4. Submit your reqest as an issue.
 120
 121 ### Submitting patches
 122 1. All contributors must sign a contributor license agreement. See the [CONTRIBUTORS](https://raw.githubusercontent.com/google/closure-compiler/master/CONTRIBUTORS) file for details.
 123 2. To make sure your changes are of the type that will be accepted, ask about your patch on the [Closure Compiler Discuss Group](https://groups.google.com/forum/#!forum/closure-compiler-discuss)
 124 3. Fork the repository.
 125 4. Make your changes.
 126 5. Submit a pull request for your changes. A project developer will review your work and then merge your request into the project.
 127
 128 ## Closure Compiler License
 129
 130 Copyright 2009 The Closure Compiler Authors.
 131
 132 Licensed under the Apache License, Version 2.0 (the "License");
 133 you may not use this file except in compliance with the License.
 134 You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
 135
 136 Unless required by applicable law or agreed to in writing, software
 137 distributed under the License is distributed on an "AS IS" BASIS,
 138 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 139 See the License for the specific language governing permissions and
 140 limitations under the License.
 141
 142 ## Dependency Licenses
 143
 144 ### Rhino
 145
 146 <table>
 147   <tr>
 148     <td>Code Path</td>
 149     <td>
 150       <code>src/com/google/javascript/rhino</code>, <code>test/com/google/javascript/rhino</code>
 151     </td>
 152   </tr>
 153
 154   <tr>
 155     <td>URL</td>
 156     <td>http://www.mozilla.org/rhino</td>
 157   </tr>
 158
 159   <tr>
 160     <td>Version</td>
 161     <td>1.5R3, with heavy modifications</td>
 162   </tr>
 163
 164   <tr>
 165     <td>License</td>
 166     <td>Netscape Public License and MPL / GPL dual license</td>
 167   </tr>
 168
 169   <tr>
 170     <td>Description</td>
 171     <td>A partial copy of Mozilla Rhino. Mozilla Rhino is an
 172 implementation of JavaScript for the JVM.  The JavaScript
 173 parse tree data structures were extracted and modified
 174 significantly for use by Google's JavaScript compiler.</td>
 175   </tr>
 176
 177   <tr>
 178     <td>Local Modifications</td>
 179     <td>The packages have been renamespaced. All code not
 180 relevant to the parse tree has been removed. A JsDoc parser and static typing
 181 system have been added.</td>
 182   </tr>
 183 </table>
 184
 185 ### Args4j
 186
 187 <table>
 188   <tr>
 189     <td>Code Path</td>
 190     <td><code>lib/args4j.jar</code></td>
 191   </tr>
 192
 193   <tr>
 194     <td>URL</td>
 195     <td>https://args4j.dev.java.net/</td>
 196   </tr>
 197
 198   <tr>
 199     <td>Version</td>
 200     <td>2.0.26</td>
 201   </tr>
 202
 203   <tr>
 204     <td>License</td>
 205     <td>MIT</td>
 206   </tr>
 207
 208   <tr>
 209     <td>Description</td>
 210     <td>args4j is a small Java class library that makes it easy to parse command line
 211 options/arguments in your CUI application.</td>
 212   </tr>
 213
 214   <tr>
 215     <td>Local Modifications</td>
 216     <td>None</td>
 217   </tr>
 218 </table>
 219
 220 ### Guava Libraries
 221
 222 <table>
 223   <tr>
 224     <td>Code Path</td>
 225     <td><code>lib/guava.jar</code></td>
 226   </tr>
 227
 228   <tr>
 229     <td>URL</td>
 230     <td>https://github.com/google/guava</td>
 231   </tr>
 232
 233   <tr>
 234     <td>Version</td>
 235     <td>18.0</td>
 236   </tr>
 237
 238   <tr>
 239     <td>License</td>
 240     <td>Apache License 2.0</td>
 241   </tr>
 242
 243   <tr>
 244     <td>Description</td>
 245     <td>Google's core Java libraries.</td>
 246   </tr>
 247
 248   <tr>
 249     <td>Local Modifications</td>
 250     <td>None</td>
 251   </tr>
 252 </table>
 253
 254 ### JSR 305
 255
 256 <table>
 257   <tr>
 258     <td>Code Path</td>
 259     <td><code>lib/jsr305.jar</code></td>
 260   </tr>
 261
 262   <tr>
 263     <td>URL</td>
 264     <td>http://code.google.com/p/jsr-305/</td>
 265   </tr>
 266
 267   <tr>
 268     <td>Version</td>
 269     <td>svn revision 47</td>
 270   </tr>
 271
 272   <tr>
 273     <td>License</td>
 274     <td>BSD License</td>
 275   </tr>
 276
 277   <tr>
 278     <td>Description</td>
 279     <td>Annotations for software defect detection.</td>
 280   </tr>
 281
 282   <tr>
 283     <td>Local Modifications</td>
 284     <td>None</td>
 285   </tr>
 286 </table>
 287
 288 ### JUnit
 289
 290 <table>
 291   <tr>
 292     <td>Code Path</td>
 293     <td><code>lib/junit.jar</code></td>
 294   </tr>
 295
 296   <tr>
 297     <td>URL</td>
 298     <td>http://sourceforge.net/projects/junit/</td>
 299   </tr>
 300
 301   <tr>
 302     <td>Version</td>
 303     <td>4.11</td>
 304   </tr>
 305
 306   <tr>
 307     <td>License</td>
 308     <td>Common Public License 1.0</td>
 309   </tr>
 310
 311   <tr>
 312     <td>Description</td>
 313     <td>A framework for writing and running automated tests in Java.</td>
 314   </tr>
 315
 316   <tr>
 317     <td>Local Modifications</td>
 318     <td>None</td>
 319   </tr>
 320 </table>
 321
 322 ### Protocol Buffers
 323
 324 <table>
 325   <tr>
 326     <td>Code Path</td>
 327     <td><code>lib/protobuf-java.jar</code></td>
 328   </tr>
 329
 330   <tr>
 331     <td>URL</td>
 332     <td>http://code.google.com/p/protobuf/</td>
 333   </tr>
 334
 335   <tr>
 336     <td>Version</td>
 337     <td>2.5.0</td>
 338   </tr>
 339
 340   <tr>
 341     <td>License</td>
 342     <td>New BSD License</td>
 343   </tr>
 344
 345   <tr>
 346     <td>Description</td>
 347     <td>Supporting libraries for protocol buffers,
 348 an encoding of structured data.</td>
 349   </tr>
 350
 351   <tr>
 352     <td>Local Modifications</td>
 353     <td>None</td>
 354   </tr>
 355 </table>
 356
 357 ### Truth
 358
 359 <table>
 360   <tr>
 361     <td>Code Path</td>
 362     <td><code>lib/truth.jar</code></td>
 363   </tr>
 364
 365   <tr>
 366     <td>URL</td>
 367     <td>https://github.com/google/truth</td>
 368   </tr>
 369
 370   <tr>
 371     <td>Version</td>
 372     <td>0.24</td>
 373   </tr>
 374
 375   <tr>
 376     <td>License</td>
 377     <td>Apache License 2.0</td>
 378   </tr>
 379
 380   <tr>
 381     <td>Description</td>
 382     <td>Assertion/Proposition framework for Java unit tests</td>
 383   </tr>
 384
 385   <tr>
 386     <td>Local Modifications</td>
 387     <td>None</td>
 388   </tr>
 389 </table>
 390
 391 ### Ant
 392
 393 <table>
 394   <tr>
 395     <td>Code Path</td>
 396     <td>
 397       <code>lib/ant.jar</code>, <code>lib/ant-launcher.jar</code>
 398     </td>
 399   </tr>
 400
 401   <tr>
 402     <td>URL</td>
 403     <td>http://ant.apache.org/bindownload.cgi</td>
 404   </tr>
 405
 406   <tr>
 407     <td>Version</td>
 408     <td>1.8.1</td>
 409   </tr>
 410
 411   <tr>
 412     <td>License</td>
 413     <td>Apache License 2.0</td>
 414   </tr>
 415
 416   <tr>
 417     <td>Description</td>
 418     <td>Ant is a Java based build tool. In theory it is kind of like "make"
 419 without make's wrinkles and with the full portability of pure java code.</td>
 420   </tr>
 421
 422   <tr>
 423     <td>Local Modifications</td>
 424     <td>None</td>
 425   </tr>
 426 </table>
 427
 428 ### GSON
 429
 430 <table>
 431   <tr>
 432     <td>Code Path</td>
 433     <td><code>lib/gson.jar</code></td>
 434   </tr>
 435
 436   <tr>
 437     <td>URL</td>
 438     <td>https://code.google.com/p/google-gson/</td>
 439   </tr>
 440
 441   <tr>
 442     <td>Version</td>
 443     <td>2.2.4</td>
 444   </tr>
 445
 446   <tr>
 447     <td>License</td>
 448     <td>Apache license 2.0</td>
 449   </tr>
 450
 451   <tr>
 452     <td>Description</td>
 453     <td>A Java library to convert JSON to Java objects and vice-versa</td>
 454   </tr>
 455
 456   <tr>
 457     <td>Local Modifications</td>
 458     <td>None</td>
 459   </tr>
 460 </table>
 461
 462 ### Node.js Closure Compiler Externs
 463
 464 <table>
 465   <tr>
 466     <td>Code Path</td>
 467     <td><code>contrib/nodejs</code></td>
 468   </tr>
 469
 470   <tr>
 471     <td>URL</td>
 472     <td>https://github.com/dcodeIO/node.js-closure-compiler-externs</td>
 473   </tr>
 474
 475   <tr>
 476     <td>Version</td>
 477     <td>e891b4fbcf5f466cc4307b0fa842a7d8163a073a</td>
 478   </tr>
 479
 480   <tr>
 481     <td>License</td>
 482     <td>Apache 2.0 license</td>
 483   </tr>
 484
 485   <tr>
 486     <td>Description</td>
 487     <td>Type contracts for NodeJS APIs</td>
 488   </tr>
 489
 490   <tr>
 491     <td>Local Modifications</td>
 492     <td>Substantial changes to make them compatible with NpmCommandLineRunner.</td>
 493   </tr>
 494 </table>