Documentation

You are viewing the documentation for the 2.2.x release series. The latest stable release series is 2.6.x.

§Using Google Closure Compiler

The Closure Compiler is a tool for making JavaScript download and run faster. It is a true compiler for JavaScript - though instead of compiling from a source language to machine code, it compiles JavaScript to better JavaScript. It parses your JavaScript, analyzes it, removes dead code and rewrites and minimizes what’s left.

Any JavaScript file present in app/assets will be parsed by Google Closure compiler, checked for errors and dependencies and minified if activated in the build configuration.

§Check JavaScript sanity

JavaScript code is compiled during the compile command, as well as automatically when modified. Error are shown in the browser just like any other compilation error.

§Minification

A minified file is also generated, where .js is replaced by .min.js. In our example, it would be test.min.js. If you want to use the minified file instead of the regular file, you need to change the script source attribute in your HTML.

§Entry Points

By default, any JavaScript file not prepended by an underscore will be compiled. This behavior can be changed in build.sbt by overriding the javascriptEntryPoints key. This key holds a PathFinder.

For example, to compile only .js file from the app/assets/javascripts/main directory:

javascriptEntryPoints <<= baseDirectory(base =>
    base / "app" / "assets" / "javascripts" / "main" ** "*.js"
)

The default definition is:

javascriptEntryPoints <<= (sourceDirectory in Compile)(base =>
   ((base / "assets" ** "*.js") --- (base / "assets" ** "_*")).get
)

§Options

ClosureCompiler compilation can be configured in your project’s build.sbt file. There are several currently supported options:

Example:

closureCompilerOptions += "ecmascript5"

Next: Using require.js to manage dependencies


Found an error in this documentation? The source code for this page can be found here. After reading the documentation guidelines, please feel free to contribute a pull request.