source: Dev/trunk/src/client/util/closureCompiler/README @ 529

Last change on this file since 529 was 483, checked in by hendrikvanantwerpen, 11 years ago

Added Dojo 1.9.3 release.
File size: 6.8 KB
Line 
1/*
2 * Copyright 2009 The Closure Compiler Authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *     http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17//
18// Contents
19//
20
21The Closure Compiler performs checking, instrumentation, and
22optimizations on JavaScript code. The purpose of this README is to
23explain how to build and run the Closure Compiler.
24
25The Closure Compiler requires Java 6 or higher.
26http://www.java.com/
27
28
29//
30// Building The Closure Compiler
31//
32
33There are three ways to get a Closure Compiler executable.
34
351) Use one we built for you.
36
37Pre-built Closure binaries can be found at
38http://code.google.com/p/closure-compiler/downloads/list
39
40
412) Check out the source and build it with Apache Ant.
42
43First, check out the full source tree of the Closure Compiler. There
44are instructions on how to do this at the project site.
45http://code.google.com/p/closure-compiler/source/checkout
46
47Apache Ant is a cross-platform build tool.
48http://ant.apache.org/
49
50At the root of the source tree, there is an Ant file named
51build.xml. To use it, navigate to the same directory and type the
52command
53
54ant jar
55
56This will produce a jar file called "build/compiler.jar".
57
58
593) Check out the source and build it with Eclipse.
60
61Eclipse is a cross-platform IDE.
62http://www.eclipse.org/
63
64Under Eclipse's File menu, click "New > Project ..." and create a
65"Java Project."  You will see an options screen. Give the project a
66name, select "Create project from existing source," and choose the
67root of the checked-out source tree as the existing directory. Verify
68that you are using JRE version 6 or higher.
69
70Eclipse can use the build.xml file to discover rules. When you
71navigate to the build.xml file, you will see all the build rules in
72the "Outline" pane. Run the "jar" rule to build the compiler in
73build/compiler.jar.
74
75
76//
77// Running The Closure Compiler
78//
79
80Once you have the jar binary, running the Closure Compiler is straightforward.
81
82On the command line, type
83
84java -jar compiler.jar
85
86This starts the compiler in interactive mode. Type
87
88var x = 17 + 25;
89
90then hit "Enter", then hit "Ctrl-Z" (on Windows) or "Ctrl-D" (on Mac or Linux)
91and "Enter" again. The Compiler will respond:
92
93var x=42;
94
95The Closure Compiler has many options for reading input from a file,
96writing output to a file, checking your code, and running
97optimizations. To learn more, type
98
99java -jar compiler.jar --help
100
101You can read more detailed documentation about the many flags at
102http://code.google.com/closure/compiler/docs/gettingstarted_app.html
103
104
105//
106// Compiling Multiple Scripts
107//
108
109If you have multiple scripts, you should compile them all together with
110one compile command.
111
112java -jar compiler.jar --js=in1.js --js=in2.js ... --js_output_file=out.js
113
114The Closure Compiler will concatenate the files in the order they're
115passed at the command line.
116
117If you need to compile many, many scripts together, you may start to
118run into problems with managing dependencies between scripts. You
119should check out the Closure Library. It contains functions for
120enforcing dependencies between scripts, and a tool called calcdeps.py
121that knows how to give scripts to the Closure Compiler in the right
122order.
123
124http://code.google.com/p/closure-library/
125
126//
127// Licensing
128//
129
130Unless otherwise stated, all source files are licensed under
131the Apache License, Version 2.0.
132
133
134-----
135Code under:
136src/com/google/javascript/rhino
137test/com/google/javascript/rhino
138
139URL: http://www.mozilla.org/rhino
140Version:  1.5R3, with heavy modifications
141License:  Netscape Public License and MPL / GPL dual license
142
143Description: A partial copy of Mozilla Rhino. Mozilla Rhino is an
144implementation of JavaScript for the JVM.  The JavaScript parser and
145the parse tree data structures were extracted and modified
146significantly for use by Google's JavaScript compiler.
147
148Local Modifications: The packages have been renamespaced. All code not
149relevant to parsing has been removed. A JsDoc parser and static typing
150system have been added.
151
152
153-----
154Code in:
155lib/rhino
156
157Rhino
158URL: http://www.mozilla.org/rhino
159Version:  Trunk
160License:  Netscape Public License and MPL / GPL dual license
161
162Description: Mozilla Rhino is an implementation of JavaScript for the JVM.
163
164Local Modifications: Minor changes to parsing JSDoc that usually get pushed
165up-stream to Rhino trunk.
166
167
168-----
169Code in:
170lib/args4j.jar
171
172Args4j
173URL: https://args4j.dev.java.net/
174Version: 2.0.16
175License: MIT
176
177Description:
178args4j is a small Java class library that makes it easy to parse command line
179options/arguments in your CUI application.
180
181Local Modifications: None.
182
183
184-----
185Code in:
186lib/guava.jar
187
188Guava Libraries
189URL: http://code.google.com/p/guava-libraries/
190Version:  14.0
191License: Apache License 2.0
192
193Description: Google's core Java libraries.
194
195Local Modifications: None.
196
197
198-----
199Code in:
200lib/jsr305.jar
201
202Annotations for software defect detection
203URL: http://code.google.com/p/jsr-305/
204Version: svn revision 47
205License: BSD License
206
207Description: Annotations for software defect detection.
208
209Local Modifications: None.
210
211
212-----
213Code in:
214lib/jarjar.jar
215
216Jar Jar Links
217URL: http://jarjar.googlecode.com/
218Version: 1.1
219License: Apache License 2.0
220
221Description:
222A utility for repackaging Java libraries.
223
224Local Modifications: None.
225
226
227----
228Code in:
229lib/junit.jar
230
231JUnit
232URL:  http://sourceforge.net/projects/junit/
233Version:  4.10
234License:  Common Public License 1.0
235
236Description: A framework for writing and running automated tests in Java.
237
238Local Modifications: None.
239
240
241---
242Code in:
243lib/protobuf-java.jar
244
245Protocol Buffers
246URL: http://code.google.com/p/protobuf/
247Version: 2.4.1
248License: New BSD License
249
250Description: Supporting libraries for protocol buffers,
251an encoding of structured data.
252
253Local Modifications: None
254
255
256---
257Code in:
258lib/ant.jar
259lib/ant-launcher.jar
260
261URL: http://ant.apache.org/bindownload.cgi
262Version: 1.8.1
263License: Apache License 2.0
264Description:
265  Ant is a Java based build tool. In theory it is kind of like "make"
266  without make's wrinkles and with the full portability of pure java code.
267
268Local Modifications: None
269
270
271---
272Code in:
273lib/json.jar
274URL: http://json.org/java/index.html
275Version: JSON version 20090211
276License: MIT license
277Description:
278JSON is a set of java files for use in transmitting data in JSON format.
279
280Local Modifications: None
281
282---
283Code in:
284tools/maven-ant-tasks-2.1.3.jar
285URL: http://maven.apache.org
286Version 2.1.3
287License: Apache License 2.0
288Description:
289  Maven Ant tasks are used to manage dependencies and to install/deploy to
290  maven repositories.
291
292Local Modifications: None
Note: See TracBrowser for help on using the repository browser.