Google Closure Compiler

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.

Important Caveats

1. Compilation modes other than ADVANCED were always an afterthought and we

1. Closure Compiler is not suitable for arbitrary JavaScript. For ADVANCED

1. Closure Compiler is a "whole world" optimizer. It expects to directly see or

It will aggressively remove and rename variables and properties in order to make the output code as small as possible. This will result in broken output JS, if uses of global variables or properties are hidden from it.

Although one can write custom externs files to tell the compiler to leave some names unchanged so they can safely be accessed by code that is not part of the compilation, this is often tedious to maintain.

1. Closure Compiler property renaming requires you to consistently access a

When you access a property with square brackets (e.g. obj[p]) or using some other indirect method like let {p} = obj; this hides the literal name of the property being referenced from the compiler. It cannot know if obj.propName is referring to the same property as obj[p]. In some cases it will notice this problem and stop the compilation with an error. In other cases it will rename propName to something shorter, without noticing this problem, resulting in broken output JS code.

1. Closure Compiler aggressively inlines global variables and flattens chains

It tries to either back off from doing this or halt with an error when doing it will generate broken JS output, but there are cases where it will fail to recognize the problem and simply generate broken JS without warning. This is much more likely to happen in code that was not explicitly written with Closure Compiler in mind.

1. Closure compiler and the externs it uses by default assume that the target

WebWorkers are supported also, but the compiler will likely fail to warn you if you try to use features that aren't actually available to a WebWorker.

Some externs files and features have been added to Closure Compiler to support the NodeJS environment, but they are not actively supported and never worked very well.

1. JavaScript that does not use the goog.module() and goog.require() from

The ECMAScript import and export syntax did not exist until 2015. Closure compiler and closure-library developed their own means for declaring and using modules, and this remains the only well supported way of defining modules.

The compiler does implement some understanding of ECMAScript modules, but changing Google's projects to use the newer syntax has never offered a benefit that was worth the cost of the change. Google's TypeScript code uses ECMAScript modules, but they are converted to goog.module() syntax before closure-compiler sees them. So, effectively the ECMAScript modules support is unused within Google. This means we are unlikely to notice or fix bugs in the support for ECMAScript modules.

Support for CommonJS modules as input was added in the past, but is not used within Google, and is likely to be entirely removed sometime in 2024.

Supported uses

Closure Compiler is used by Google projects to:

• Drastically reduce the code size of very large JavaScript applications

• Check the JS code for errors and for conformance to general and/or

• Define user-visible messages in a way that makes it possible to replace

• Transpile newer JS features into a form that will run on browsers that

• Break the output application into chunks that may be individually loaded

NOTE: These chunks are plain JavaScript scripts. They do not use the ECMAScript import and export syntax.

To achieve these goals closure compiler places many restrictions on its input:

• Use goog.module() and goog.require() to declare and use modules.

• Use annotations in comments to declare type information and provide

• Either use only dot-access (e.g. object.property) or only use dynamic

Mixing these will hide some uses of a property from the compiler, resulting in broken output code when it renames the property.

• In general the compiler expects to see an entire application as a single

The compiler assumes it can see all uses of all variables and properties and will freely rename them or remove them if they appear unused.

• Use externs files to inform the compiler of any variables or properties

There are default externs files declaring the standard JS and DOM global APIs. More externs files are necessary if you are using less common APIs or expect some external JavaScript code to access an API in the code you are compiling.

Getting Started

IMPORTANT: The NPM packages are not built and distributed by Google. They are an Open Source contribution from ChadKillingsworth, who manages and builds them from a separate repository at https://github.com/ChadKillingsworth/closure-compiler-npm.

The easiest way to install the compiler is with NPM or Yarn:

yarn global add google-closure-compiler
OR
npm i -g google-closure-compiler

The package manager will link the binary for you, and you can access the compiler with:

google-closure-compiler

This starts the compiler in interactive mode. Type:

var x = 17 + 25;

Hit Enter, then Ctrl+Z (on Windows) or Ctrl+D (on Mac/Linux), then Enter again. The Compiler will respond with the compiled output (using SIMPLE mode by default):

var x=42;

Downloading from Maven Repository

A pre-compiled release of the compiler is also available via Maven.

Web-based tooling

https://jscompressor.treblereel.dev/ is a web-based UI and REST API for Closure Compiler, developed and maintained by at https://github.com/treblereel/jscompressor.

Basic usage

The Closure Compiler has many options for reading input from a file, writing output to a file, checking your code, and running optimizations. Here is a simple example of compressing a JS program:

google-closure-compiler --js file.js --js_output_file file.out.js

We get the most benefit from the compiler if we give it **all of our source code** (see Compiling Multiple Scripts), which allows us to use ADVANCED optimizations:

google-closure-compiler -O ADVANCED rollup.js --js_output_file rollup.min.js

NOTE: The output below is just an example and not kept up-to-date. The Flags and Options wiki page is updated during each release.

To see all of the compiler's options, type:

google-closure-compiler --help

See the Google Developers Site for documentation including instructions for running the compiler from the command line.

NodeJS API

You can access the compiler in a JS program by importing google-closure-compiler:

import closureCompiler from 'google-closure-compiler';
const { compiler } = closureCompiler;
new compiler({
  js: 'file-one.js',
  compilation_level: 'ADVANCED'
});

This package will provide programmatic access to the native Graal binary in most cases, and will fall back to the Java version otherwise.

Please see the closure-compiler-npm repository for documentation on accessing the compiler in JS.

Compiling Multiple Scripts

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

google-closure-compiler in1.js in2.js in3.js --js_output_file out.js

You can also use minimatch-style globs.

# Recursively include all js files in subdirs
google-closure-compiler 'src/**.js' --js_output_file out.js
Recursively include all js files in subdirs, excluding test files.
Use single-quotes, so that bash doesn't try to expand the '!'
google-closure-compiler 'src/.js' '!_test.js' --js_output_file out.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 included lib/base.js that provides functions for enforcing dependencies between scripts (namely goog.module and goog.require). Closure Compiler will re-order the inputs automatically.

Closure JavaScript Library

The Closure Compiler releases with lib/base.js that provides JavaScript functions and variables that serve as primitives enabling certain features of the Closure Compiler. This file is a derivative of the identically named base.js in the soon-to-be deprecated Closure Library. This base.js will be supported by Closure Compiler going forward and may receive new features. It was designed to only retain its perceived core parts.

Getting Help

1. Post in the

1. Ask a question on

1. Consult the FAQ.

Building the Compiler

To build the compiler yourself, you will need the following:

Prerequisite | Description -------------------------------------------------------------------------- | ----------- Java 21 or later | Used to compile the compiler's source code. NodeJS | Used to generate resources used by Java compilation Git | Used by Bazel to download dependencies. Bazelisk | Used to build the various compiler targets.

Installing Bazelisk

Bazelisk is a wrapper around Bazel that dynamically loads the appropriate version of Bazel for a given repository. Using it prevents spurious errors that result from using the wrong version of Bazel to build the compiler, as well as makes it easy to use different Bazel versions for other projects.

Bazelisk is available through many package managers. Feel free to use whichever you're most comfortable with.

Instructions for installing Bazelisk.

Building from a terminal

$ bazelisk build //:compiler_uberjar_deploy.jar
OR to build everything
$ bazelisk build //:all

Testing from a terminal

Tests can be executed in a similar way. The following command will run all tests in the repo.

$ bazelisk test //:all

There are hundreds of individual test targets, so it will take a few minutes to run all of them. While developing, it's usually better to specify the exact tests you're interested in.

bazelisk test //:$path_to_test_file

Building from an IDE

See Bazel IDE Integrations.

Running

Once the compiler has been built, the compiled JAR will be in the bazel-bin/ directory. You can access it with a call to java -jar ... or by using the package.json script:

# java -jar bazel-bin/compiler_uberjar_deploy.jar [...args]
yarn compile [...args]

Running using Eclipse

1. Open the class src/com/google/javascript/jscomp/CommandLineRunner.java or

1. Run the class in Eclipse.
2. See the instructions above on how to use the interactive mode - but beware

Contributing

Contributor code of conduct

However you choose to contribute, please abide by our code of conduct to keep our community a healthy and welcoming place.

Reporting a bug

1. First make sure that it is really a bug and not simply the way that Closure

1. If you still think you have found a bug, make sure someone hasn't already

1. If it hasn't been reported yet, post a new issue. Make sure to add enough

Suggesting a feature

1. Consult the FAQ to

1. Make sure someone hasn't requested the same thing. See the list of

1. Read up on

1. Submit your request as an issue.

Submitting patches

1. All contributors must sign a contributor license agreement (CLA). A CLA

1. To make sure your changes are of the type that will be accepted, ask about

1. Fork the repository.
2. Make your changes. Check out our

1. Submit a pull request for your changes. A project developer will review your

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

Args4j

Guava Libraries

JSR 305

JUnit

Protocol Buffers

RE2/J

Truth

Ant

GSON

Node.js Closure Compiler Externs