sprockets 2.6.0 → 4.2.2

data/README.md

@@ -3,68 +3,50 @@
 Sprockets is a Ruby library for compiling and serving web assets.
 It features declarative dependency management for JavaScript and CSS
 assets, as well as a powerful preprocessor pipeline that allows you to
-write assets in languages like CoffeeScript, Sass, SCSS and LESS.
+write assets in languages like CoffeeScript, Sass and SCSS.
 
-# Installation #
+## Installation
 
 Install Sprockets from RubyGems:
 
-    $ gem install sprockets
+``` sh
+$ gem install sprockets
+```
 
 Or include it in your project's `Gemfile` with Bundler:
 
-    gem 'sprockets', '~> 2.0'
+``` ruby
+gem 'sprockets', '~> 4.0'
+```
 
-# Understanding the Sprockets Environment #
+## Upgrading to Sprockets 4.x
 
-You'll need an instance of the `Sprockets::Environment` class to
-access and serve assets from your application. Under Rails 3.1 and
-later, `YourApp::Application.assets` is a preconfigured
-`Sprockets::Environment` instance. For Rack-based applications, create
-an instance in `config.ru`.
+These are the major features in Sprockets 4.x
 
-The Sprockets `Environment` has methods for retrieving and serving
-assets, manipulating the load path, and registering processors. It is
-also a Rack application that can be mounted at a URL to serve assets
-over HTTP.
+- Source Maps
+- Manifest.js
+- ES6 support
+- Deprecated processor interface in 3.x is removed in 4.x
 
-## The Load Path ##
+Read more about them by referencing [Upgrading document](UPGRADING.md)
 
-The *load path* is an ordered list of directories that Sprockets uses
-to search for assets.
+## Guides
 
-In the simplest case, a Sprockets environment's load path will consist
-of a single directory containing your application's asset source
-files. When mounted, the environment will serve assets from this
-directory as if they were static files in your public root.
+For most people interested in using Sprockets, you will want to see the README below.
 
-The power of the load path is that it lets you organize your source
-files into multiple directories -- even directories that live outside
-your application -- and combine those directories into a single
-virtual filesystem. That means you can easily bundle JavaScript, CSS
-and images into a Ruby library and import them into your application.
+If you are a framework developer that is using Sprockets, see [Building an Asset Processing Framework](guides/building_an_asset_processing_framework.md).
 
-### Manipulating the Load Path ###
+If you are a library developer who is extending the functionality of Sprockets, see [Extending Sprockets](guides/extending_sprockets.md).
 
-To add a directory to your environment's load path, use the
-`append_path` and `prepend_path` methods. Directories at the beginning
-of the load path have precedence over subsequent directories.
+If you want to work on Sprockets or better understand how it works read [How Sprockets Works](guides/how_sprockets_works.md)
 
-    environment = Sprockets::Environment.new
-    environment.append_path 'app/assets/javascripts'
-    environment.append_path 'lib/assets/javascripts'
-    environment.append_path 'vendor/assets/jquery'
+## Behavior Overview
 
-In general, you should append to the path by default and reserve
-prepending for cases where you need to override existing assets.
+You can interact with Sprockets primarily through directives and file extensions. This section covers how to use each of these things, and the defaults that ship with Sprockets.
 
-## Accessing Assets ##
+Since you are likely using Sprockets through another framework (such as the [the Rails asset pipeline](http://guides.rubyonrails.org/asset_pipeline.html)), there will be configuration options you can toggle that will change behavior such as what directories or files get compiled. For that documentation you should see your framework's documentation.
 
-Once you've set up your environment's load path, you can mount the
-environment as a Rack server and request assets via HTTP. You can also
-access assets programmatically from within your application.
-
-### Logical Paths ###
+#### Accessing Assets
 
 Assets in Sprockets are always referenced by their *logical path*.
 
@@ -74,391 +56,661 @@ contains the directory `app/assets/javascripts`:
 
 <table>
   <tr>
-    <th>Asset source file</th>
     <th>Logical path</th>
+    <th>Source file on disk</th>
   </tr>
   <tr>
-    <td>app/assets/javascripts/application.js</td>
     <td>application.js</td>
+    <td>app/assets/javascripts/application.js</td>
   </tr>
   <tr>
-    <td>app/assets/javascripts/models/project.js</td>
     <td>models/project.js</td>
+    <td>app/assets/javascripts/models/project.js</td>
+  </tr>
+  <tr>
+    <td>hello.js</td>
+    <td>app/assets/javascripts/hello.coffee</td>
   </tr>
 </table>
 
-In this way, all directories in the load path are merged to create a
-virtual filesystem whose entries are logical paths.
+> Note: For assets that are compiled or transpiled, you want to specify the extension that you want, not the extension on disk. For example we specified `hello.js` even if the file on disk is a coffeescript file, since the asset it will generate is javascript.
 
-### Serving Assets Over HTTP ###
+### Directives
 
-When you mount an environment, all of its assets are accessible as
-logical paths underneath the *mount point*. For example, if you mount
-your environment at `/assets` and request the URL
-`/assets/application.js`, Sprockets will search your load path for the
-file named `application.js` and serve it.
+Directives are special comments in your asset file and the main way of interacting with processors. What kind of interactions? You can use these directives to tell Sprockets to load other files, or specify dependencies on other assets.
 
-Under Rails 3.1 and later, your Sprockets environment is automatically
-mounted at `/assets`. If you are using Sprockets with a Rack
-application, you will need to mount the environment yourself. A good
-way to do this is with the `map` method in `config.ru`:
+For example, let's say you have custom JavaScript that you've written. You put this javascript in a file called `beta.js`. The javascript makes heavy use of jQuery, so you need to load that before your code executes. You could add a `require` directive to the top of `beta.js`:
 
-    require 'sprockets'
-    map '/assets' do
-      environment = Sprockets::Environment.new
-      environment.append_path 'app/assets/javascripts'
-      environment.append_path 'app/assets/stylesheets'
-      run environment
-    end
+```js
+//= require jquery
 
-    map '/' do
-      run YourRackApp
-    end
+$().ready({
+  // my custom code here
+})
+```
 
-### Accessing Assets Programmatically ###
+The directive processor understands comment blocks in three formats:
 
-You can use the `find_asset` method (aliased as `[]`) to retrieve an
-asset from a Sprockets environment. Pass it a logical path and you'll
-get a `Sprockets::BundledAsset` instance back:
+``` css
+/* Multi-line comment blocks (CSS, SCSS, JavaScript)
+ *= require foo
+ */
+```
 
-    environment['application.js']
-    # => #<Sprockets::BundledAsset ...>
+``` js
+// Single-line comment blocks (SCSS, JavaScript)
+//= require foo
+```
 
-Call `to_s` on the resulting asset to access its contents, `length` to
-get its length in bytes, `mtime` to query its last-modified time, and
-`pathname` to get its full path on the filesystem.
+``` coffee
+# Single-line comment blocks (CoffeeScript)
+#= require foo
+```
 
-# Using Engines #
+> Note: Directives are only processed if they come before any application code. Once you have a line that does not include a comment or whitespace then Sprockets will stop looking for directives. If you use a directive outside of the "header" of the document it will not do anything, and won't raise any errors.
 
-Asset source files can be written in another language, like SCSS or
-CoffeeScript, and automatically compiled to CSS or JavaScript by
-Sprockets. Compilers for these languages are called *engines*.
+Here is a list of the available directives:
 
-Engines are specified by additional extensions on the asset source
-filename. For example, a CSS file written in SCSS might have the name
-`layout.css.scss`, while a JavaScript file written in CoffeeScript
-might have the name `dialog.js.coffee`.
+- [`require`](#require) - Add the contents of a file to current
+- [`require_self`](#require_self) - Change order of where current contents are concatenated to current
+- [`require_directory`](#require_directory) - Add contents of each file in a folder to current
+- [`require_tree`](#require_tree) - Add contents of all files in all directories in a path to current
+- [`link`](#link) - Make target file compile and be publicly available without adding contents to current
+- [`link_directory`](#link_directory) - Make target directory compile and be publicly available without adding contents to current
+- [`link_tree`](#link_tree) - Make target tree compile and be publicly available without adding contents to current
+- [`depend_on`](#depend_on) - Recompile current file if target has changed
+- [`depend_on_directory`](#depend_on_directory) - Recompile current file if any files in target directory has changed
+- [`stub`](#stub) - Ignore target file
 
-## Styling with Sass and SCSS ##
+You can see what each of these does below.
 
-[Sass](http://sass-lang.com/) is a language that compiles to CSS and
-adds features like nested rules, variables, mixins and selector
-inheritance.
+### Specifying Processors through File Extensions
 
-If the `sass` gem is available to your application, you can use Sass
-to write CSS assets in Sprockets.
+Sprockets uses the filename extensions to determine what processors to run on your file and in what order. For example if you have a file:
 
-Sprockets supports both Sass syntaxes. For the original
-whitespace-sensitive syntax, use the extension `.css.sass`. For the
-new SCSS syntax, use the extension `.css.scss`.
+```
+application.scss
+```
 
-## Styling with LESS ##
+Then Sprockets will by default run the sass processor (which implements scss). The output file will be converted to css.
 
-[LESS](http://lesscss.org/) extends CSS with dynamic behavior such as
-variables, mixins, operations and functions.
+You can specify multiple processors by specifying multiple file extensions. For example you can use Ruby's [ERB template language](#invoking-ruby-with-erb) to embed content in your doc before running the sass processor. To accomplish this you would need to name your file
 
-If the `less` gem is available to your application, you can use LESS
-to write CSS assets in Sprockets. Note that the LESS compiler is
-written in JavaScript, and at the time of this writing, the `less` gem
-depends on `therubyracer` which embeds the V8 JavaScript runtime in
-Ruby.
+```
+application.scss.erb
+```
 
-To write CSS assets with LESS, use the extension `.css.less`.
+Processors are run from right to left (tail to head), so in the above example the processor associated with `erb` will be run before the processor associated with `scss` extension.
 
-## Scripting with CoffeeScript ##
+For a description of the processors that Sprockets has by default see the "default processors" section below. Other libraries may register additional processors.
 
-[CoffeeScript](http://jashkenas.github.com/coffee-script/) is a
-language that compiles to the "good parts" of JavaScript, featuring a
-cleaner syntax with array comprehensions, classes, and function
-binding.
+When "asking" for a compiled file, you always ask for the extension you want. For example if you're using Rails, to get the contents of `application.scss.erb` you would use
 
-If the `coffee-script` gem is available to your application, you can
-use CoffeeScript to write JavaScript assets in Sprockets. Note that
-the CoffeeScript compiler is written in JavaScript, and you will need
-an [ExecJS](https://github.com/sstephenson/execjs)-supported runtime
-on your system to invoke it.
+```
+asset_path("application.css")
+```
 
-To write JavaScript assets with CoffeeScript, use the extension
-`.js.coffee`.
+Sprockets understands that `application.scss.erb` will compile down to a `application.css`. Ask for what you need, not what you have.
 
-## JavaScript Templating with EJS and Eco ##
+If this isn't working like you expect, make sure you didn't typo an extension, and make sure the file is on a "load path" (see framework docs for adding new load paths).
 
-Sprockets supports *JavaScript templates* for client-side rendering of
-strings or markup. JavaScript templates have the special format
-extension `.jst` and are compiled to JavaScript functions.
+## File Order Processing
 
-When loaded, a JavaScript template function can be accessed by its
-logical path as a property on the global `JST` object. Invoke a
-template function to render the template as a string. The resulting
-string can then be inserted into the DOM.
+By default files are processed in alphabetical order. This behavior can impact your asset compilation when one asset needs to be loaded before another.
 
-    <!-- templates/hello.jst.ejs -->
-    <div>Hello, <span><%= name %></span>!</div>
+For example if you have an `application.js` and it loads another directory
 
-    // application.js
-    //= require templates/hello
-    $("#hello").html(JST["templates/hello"]({ name: "Sam" }));
+```js
+//= require_directory my_javascript
+```
 
-Sprockets supports two JavaScript template languages:
-[EJS](https://github.com/sstephenson/ruby-ejs), for embedded
-JavaScript, and [Eco](https://github.com/sstephenson/ruby-eco), for
-embedded CoffeeScript. Both languages use the familiar `<% … %>`
-syntax for embedding logic in templates.
+The files in that directory will be loaded in alphabetical order. If the directory looks like this:
 
-If the `ejs` gem is available to your application, you can use EJS
-templates in Sprockets. EJS templates have the extension `.jst.ejs`.
+```sh
+$ ls -1 my_javascript/
 
-If the `eco` gem is available to your application, you can use [Eco
-templates](https://github.com/sstephenson/eco) in Sprockets. Eco
-templates have the extension `.jst.eco`. Note that the `eco` gem
-depends on the CoffeeScript compiler, so the same caveats apply as
-outlined above for the CoffeeScript engine.
+alpha.js
+beta.js
+jquery.js
+```
 
-## Invoking Ruby with ERB ##
+Then `alpha.js` will be loaded before either of the other two. This can be a problem if `alpha.js` uses jquery. For this reason it is not recommend to use `require_directory` with files that are ordering dependent. You can either require individual files manually:
 
-Sprockets provides an ERB engine for preprocessing assets using
-embedded Ruby code. Append `.erb` to a CSS or JavaScript asset's
-filename to enable the ERB engine.
+```js
+//= require jquery
+//= require alpha
+//= require beta
+```
 
-**Note**: Sprockets processes multiple engine extensions in order from
-  right to left, so you can use multiple engines with a single
-  asset. For example, to have a CoffeeScript asset that is first
-  preprocessed with ERB, use the extension `.js.coffee.erb`.
+Or you can use index files to proxy your folders.
 
-Ruby code embedded in an asset is evaluated in the context of a
-`Sprockets::Context` instance for the given asset. Common uses for ERB
-include:
+### Index files are proxies for folders
 
-- embedding another asset as a Base64-encoded `data:` URI with the
-  `asset_data_uri` helper
-- inserting the URL to another asset, such as with the `asset_path`
-  helper provided by the Sprockets Rails plugin
-- embedding other application resources, such as a localized string
-  database, in a JavaScript asset via JSON
-- embedding version constants loaded from another file
+In Sprockets index files such as `index.js` or `index.css` files inside of a folder will generate a file with the folder's name. So if you have a `foo/index.js` file it will compile down to `foo.js`. This is similar to NPM's behavior of using [folders as modules](https://nodejs.org/api/modules.html#modules_folders_as_modules). It is also somewhat similar to the way that a file in `public/my_folder/index.html` can be reached by a request to `/my_folder`. This means that you cannot directly use an index file. For example this would not work:
 
-See the [Helper Methods](#FIXME) section for more information about
-interacting with `Sprockets::Context` instances via ERB.
+```erb
+<%= asset_path("foo/index.js") %>
+```
 
-### String Interpolation Syntax ###
+Instead you would need to use:
 
-If you need access to Ruby from an asset but cannot use ERB's `<% …
-%>` syntax, Sprockets also supports Ruby string interpolation syntax
-(`#{ … }`) with the `.str` engine extension.
+```erb
+<%= asset_path("foo.js") %>
+```
 
-# Managing and Bundling Dependencies #
+Why would you want to use this behavior?  It is common behavior where you might want to include an entire directory of files in a top level JavaScript. You can do this in Sprockets using `require_tree .`
 
-You can create *asset bundles* -- ordered concatenations of asset
-source files -- by specifying dependencies in a special comment syntax
-at the top of each source file.
+```js
+//= require_tree .
+```
 
-Sprockets reads these comments, called *directives*, and processes
-them to recursively build a dependency graph. When you request an
-asset with dependencies, the dependencies will be included in order at
-the top of the file.
+This has the problem that files are required alphabetically. If your directory has `jquery-ui.js` and `jquery.min.js` then Sprockets will require `jquery-ui.js` before `jquery` is required which won't work (because jquery-ui depends on jquery). Previously the only way to get the correct ordering would be to rename your files, something like `0-jquery-ui.js`. Instead of doing that you can use an index file.
 
-## The Directive Processor ##
+For example, if you have an `application.js` and want all the files in the `foo/` folder you could do this:
 
-Sprockets runs the *directive processor* on each CSS and JavaScript
-source file. The directive processor scans for comment lines beginning
-with `=` in comment blocks at the top of the file.
+```js
+//= require foo.js
+```
 
-    //= require jquery
-    //= require jquery-ui
-    //= require backbone
-    //= require_tree .
+Then create a file `foo/index.js` that requires all the files in that folder in any order you want using relative references:
 
-The first word immediately following `=` specifies the directive
-name. Any words following the directive name are treated as
-arguments. Arguments may be placed in single or double quotes if they
-contain spaces, similar to commands in the Unix shell.
+```js
+//= require ./foo.min.js
+//= require ./foo-ui.js
+```
 
-**Note**: Non-directive comment lines will be preserved in the final
-  asset, but directive comments are stripped after
-  processing. Sprockets will not look for directives in comment blocks
-  that occur after the first line of code.
+Now in your `application.js` will correctly load the `foo.min.js` before `foo-ui.js`. If you used `require_tree` it would not work correctly.
 
-### Supported Comment Types ###
+## Cache
 
-The directive processor understands comment blocks in three formats:
+Compiling assets is slow. It requires a lot of disk use to pull assets off of hard drives, a lot of RAM to manipulate those files in memory, and a lot of CPU for compilation operations. Because of this Sprockets has a cache to speed up asset compilation times. That's the good news. The bad news, is that sprockets has a cache and if you've found a bug it's likely going to involve the cache.
 
-    /* Multi-line comment blocks (CSS, SCSS, JavaScript)
-     *= require foo
-     */
+By default Sprockets uses the file system to cache assets. It makes sense that Sprockets does not want to generate assets that already exist on disk in `public/assets`, what might not be as intuitive is that Sprockets needs to cache "partial" assets.
 
-    // Single-line comment blocks (SCSS, JavaScript)
-    //= require foo
+For example if you have an `application.js` and it is made up of `a.js`, `b.js`, all the way to `z.js`
 
-    # Single-line comment blocks (CoffeeScript)
-    #= require foo
+```js
+//= require a.js
+//= require b.js
+# ...
+//= require z.js
+```
 
-## Sprockets Directives ##
+The first time this file is compiled the `application.js` output will be written to disk, but also intermediary compiled files for `a.js` etc. will be written to the cache directory (usually `tmp/cache/assets`).
 
-You can use the following directives to declare dependencies in asset
-source files.
+So, if `b.js` changes it will get recompiled. However instead of having to recompile the other files from `a.js` to `z.js` since they did not change, we can use the prior intermediary files stored in the cached values . If these files were expensive to generate, then this "partial" asset cache strategy can save a lot of time.
 
-For directives that take a *path* argument, you may specify either a
-logical path or a relative path. Relative paths begin with `./` and
-reference files relative to the location of the current file.
+Directives such as `require`, `link`, `depend_on`, and `depend_on_directory` tell Sprockets what assets need to be re-compiled when a file changes. Files are considered "fresh" based on their mtime on disk and a combination of cache keys.
 
-### The `require` Directive ###
+On Rails you can force a "clean" install by clearing the `public/assets` and `tmp/cache/assets` directories.
+
+
+## Default Directives
+
+Directives take a path or a path to a file. Paths for directive can be relative to the current file, for example:
+
+```js
+//= require ../foo.js
+```
+
+This would load the file up one directory and named `foo.js`. However this isn't required if `foo.js` is on one of Sprocket's load paths. You can simply use
+
+```js
+//= require foo.js
+```
+
+Without any prepended dots and sprockets will search for the asset. If the asset is on a sub-path of the load path, you can specify it without using a relative path as well:
+
+```js
+//= require sub/path/foo.js
+```
+
+You can also use an absolute path, but this is discouraged unless you know the directory structure of every machine you plan on running code on.
+
+Below is a section for each of the built in directive types supported by Sprockets.
+
+### require
 
 `require` *path* inserts the contents of the asset source file
 specified by *path*. If the file is required multiple times, it will
 appear in the bundle only once.
 
-### The `include` Directive ###
+**Example:**
+
+If you've got an `a.js`:
+
+```js
+var a = "A";
+```
+
+and a `b.js`;
+
+```js
+var b = "B";
+```
+
+Then you could require both of these in an `application.js`
+
+```js
+//= require a.js
+//= require b.js
+```
+
+Which would generate one concatenated file:
+
+```js
+var a = "A";
+var b = "B";
+```
+
+### require_self
+
+`require_self` tells Sprockets to insert the body of the current
+source file before any subsequent `require` directives.
+
+**Example:**
 
-`include` *path* works like `require`, but inserts the contents of the
-specified source file even if it has already been included or
-required.
+If you've got an `a.js`:
 
-### The `require_directory` Directive ###
+```js
+var a = "A";
+```
+
+And an `application.js`
+
+```js
+//= require_self
+//= require 'a.js'
+
+var app_name = "Sprockets";
+```
+
+Then this will take the contents of `application.js` (that come after the last require) and put them at the beginning of the file:
+
+```js
+var app_name = "Sprockets";
+var a = "A";
+```
+
+### require_directory
 
 `require_directory` *path* requires all source files of the same
 format in the directory specified by *path*. Files are required in
 alphabetical order.
 
-### The `require_tree` Directive ###
+**Example:**
+
+If we've got a directory called `alphabet` with an `a.js` and `b.js` files like before, then our `application.js`
+
+```js
+//= require_directory alphabet
+```
+
+Would produce:
+
+```js
+var a = "A";
+var b = "B";
+```
+
+You can also see [Index files are proxies for folders](#index-files-are-proxies-for-folders) for another method of organizing folders that will give you more control.
+
+### require_tree
 
 `require_tree` *path* works like `require_directory`, but operates
 recursively to require all files in all subdirectories of the
 directory specified by *path*.
 
-### The `require_self` Directive ###
+### link
 
-`require_self` tells Sprockets to insert the body of the current
-source file before any subsequent `require` or `include` directives.
+`link` *path* declares a dependency on the target *path* and adds it to a list
+of subdependencies to be compiled when the asset is written out to
+disk.
+
+Example:
+
+If you've got a `manifest.js` file and you want to specify that a `admin.js` source file should be
+generated and made available to the public you can link it by including this in the `manifest.js` file:
+
+```
+//= link admin.js
+```
+
+The argument to `link` is a _logical path_, that is it will be resolved according to the
+configured asset load paths. See [Accessing Assets](#accessing-assets) above. A path relative to
+the current file won't work, it must be a logical path.
+
+**Caution**: the "link" directive should always have an explicit extension on the end.
+
+`link` can also be used to include manifest files from mounted Rails engines:
+
+```
+//= link my_engine_manifest
+```
+
+This would find a manifest file at `my_engine/app/assets/config/my_engine_manifest.js` and include its directives.
+
+### link_directory
 
-### The `depend_on` Directive ###
+`link_directory` *path* links all the files inside the directory specified by the *path*. By "link", we mean they are specified as compilation targets to be written out to disk, and made available to be served to user-agents.
+
+Files in subdirectories will not be linked (Compare to [link_tree](#link_tree)).
+
+The *path* argument to `link_directory` is _not_ a logical path (it does not use the asset load paths), but is a path relative to the file the `link_directory` directive is found in, and can use `..` to  . For instance, you might want:
+
+```js
+//= link_directory ../stylesheets
+```
+
+`link_directory` can take an optional second argument with an extension or content-type, with the
+two arguments separated by a space:
+
+```js
+//= link_directory ../stylesheets text/css
+//= link_directory ../more_stylesheets .css
+```
+
+This will limit the matching files to link to only files recognized as that type. An extension is
+just a shortcut for the type referenced, it does not need to match the source file exactly, but
+instead identifies the content-type the source file must be recognized as.
+
+### link_tree
+
+`link_tree` *path* works like [link_directory](#link_directory), but operates
+recursively to link all files in all subdirectories of the
+directory specified by *path*.
+
+Example:
+
+```js
+//= link_tree ./path/to/folder
+```
+
+Like `link_directory`, the argument is path relative to the current file, it is *not* a 'logical path' tresolved against load paths.
+
+
+As with `link_directory`, you can also specify a second argument -- separated by a space --  so any extra files not matching the content-type specified will be ignored:
+
+```js
+//= link_tree ./path/to/folder text/javascript
+//= link_tree ./path/to/other_folder .js
+```
+
+
+### depend_on
 
 `depend_on` *path* declares a dependency on the given *path* without
 including it in the bundle. This is useful when you need to expire an
 asset's cache in response to a change in another file.
 
-### The `stub` Directive ###
+**Example:**
+
+If you have a file such as `bar.data` and you're using data from that file in another file, then
+you need to tell sprockets that it needs to re-compile the file if `bar.data` changes:
+
+```js
+//= depend_on "bar.data"
+
+var bar = '<%= File.read("bar.data") %>'
+```
+
+To depend on an entire directory containing multiple files, use `depend_on_directory`
+
+### depend_on_asset
+
+`depend_on_asset` *path* works like `depend_on`, but operates
+recursively reading the file and following the directives found. This is automatically implied if you use `link`, so consider if it just makes sense using `link` instead of `depend_on_asset`.
 
-`stub` *path* allows dependency to be excluded from the asset bundle.
+### depend_on_directory
+
+`depend_on_directory` *path* declares all files in the given *path* without
+including them in the bundle. This is useful when you need to expire an
+asset's cache in response to a change in multiple files in a single directory.
+
+All paths are relative to your declaration and must begin with `./`
+
+Also, your must include these directories in your [load path](guides/building_an_asset_processing_framework.md#the-load-path).
+
+**Example:**
+
+If we've got a directory called `data` with files `a.data` and `b.data`
+
+```
+// ./data/a.data
+A
+```
+
+```
+// ./data/b.data
+B
+```
+
+```
+// ./file.js.erb
+//= depend_on_directory ./data
+var a = '<% File.read('data/a.data') %>'
+var b = '<% File.read('data/b.data') %>'
+```
+
+Would produce:
+
+```js
+var a = "A";
+var b = "B";
+```
+
+You can also see [Index files are proxies for folders](#index-files-are-proxies-for-folders) for another method of organizing folders that will give you more control.
+
+### stub
+
+`stub` *path* excludes that asset and its dependencies from the asset bundle.
 The *path* must be a valid asset and may or may not already be part
-of the bundle. Once stubbed, it is blacklisted and can't be brought
-back by any other `require`.
+of the bundle. `stub` should only be used at the top level bundle, not
+within any subdependencies.
 
-# Development #
+### Invoking Ruby with ERB
 
-## Contributing ##
+Sprockets provides an ERB engine for preprocessing assets using
+embedded Ruby code. Append `.erb` to a CSS or JavaScript asset's
+filename to enable the ERB engine.
 
-The Sprockets source code is [hosted on
-GitHub](https://github.com/sstephenson/sprockets). You can check out a
-copy of the latest code using Git:
+For example if you have an `app/application/javascripts/app_name.js.erb`
+you could have this in the template
 
-    $ git clone https://github.com/sstephenson/sprockets.git
+```js
+var app_name = "<%= ENV['APP_NAME'] %>";
+```
 
-If you've found a bug or have a question, please open an issue on the
-[Sprockets issue
-tracker](https://github.com/sstephenson/sprockets/issues). Or, clone
-the Sprockets repository, write a failing test case, fix the bug and
-submit a pull request.
+Generated files are cached. If you're using an `ENV` var then
+when you change then ENV var the asset will be forced to
+recompile. This behavior is only true for environment variables,
+if you are pulling a value from somewhere else, such as a database,
+you must manually invalidate the cache to see the change.
 
-## Version History ##
+If you're using Rails, there are helpers you can use such as `asset_url`
+that will cause a recompile if the value changes.
 
-**2.6.0** (September 19, 2012)
+For example if you have this in your `application.css`
 
-* Added bower component.json require support
+``` css
+.logo {
+  background: url(<%= asset_url("logo.png") %>)
+}
+```
 
-**2.5.0** (September 4, 2012)
+When you modify the `logo.png` on disk, it will force `application.css` to be
+recompiled so that the fingerprint will be correct in the generated asset.
 
-* Fixed Ruby 2.0 RegExp warning
-* Provide stubbed implementation of context *_path helpers
-* Add SassCompressor
+You can manually make sprockets depend on any other file that is generated
+by sprockets by using the `depend_on` or `depend_on_directory` directive. Rails
+implements the above feature by auto calling `depend_on` on the original asset
+when the `asset_url` is used inside of an asset.
 
-**2.4.5** (July 10, 2012)
+### Styling with Sass and SCSS
 
-* Tweaked some logger levels
+[Sass](http://sass-lang.com/) is a language that compiles to CSS and
+adds features like nested rules, variables, mixins and selector
+inheritance.
 
-**2.4.4** (July 2, 2012)
+If the `sass` gem is available to your application, you can use Sass
+to write CSS assets in Sprockets.
 
-* Canonicalize logical path extensions
-* Check absolute paths passed to depend_on
+Sprockets supports both Sass syntaxes. For the original
+whitespace-sensitive syntax, use the extension `.sass`. For the
+new SCSS syntax, use the extension `.scss`.
 
-**2.4.3** (May 16, 2012)
+In Rails if you have `app/application/stylesheets/foo.scss` it can
+be referenced with `<%= asset_path("foo.css") %>`. When referencing
+an asset in Rails, always specify the extension you want. Sprockets will
+convert `foo.scss` to `foo.css`.
 
-* Exposed :sprockets in sass options
-* Include dependency paths in asset mtime
+### Scripting with CoffeeScript
 
-**2.4.2** (May 7, 2012)
+[CoffeeScript](http://jashkenas.github.io/coffeescript/) is a
+language that compiles to the "good parts" of JavaScript, featuring a
+cleaner syntax with array comprehensions, classes, and function
+binding.
+
+If the `coffee-script` gem is available to your application, you can
+use CoffeeScript to write JavaScript assets in Sprockets. Note that
+the CoffeeScript compiler is written in JavaScript, and you will need
+an [ExecJS](https://github.com/rails/execjs)-supported runtime
+on your system to invoke it.
+
+To write JavaScript assets with CoffeeScript, use the extension
+`.coffee`.
+
+In Rails if you have `app/application/javascripts/foo.coffee` it can
+be referenced with `<%= asset_path("foo.js") %>`. When referencing
+an asset in Rails, always specify the extension you want. Sprockets will
+convert `foo.coffee` to `foo.js`.
+
+
+## ES6 Support
+
+Sprockets 4 ships with a Babel processor. This allows you to transpile ECMAScript6 to JavaScript just like you would transpile CoffeeScript to JavaScript. To use this, modify your Gemfile:
+
+```ruby
+gem 'babel-transpiler'
+```
+
+Any asset with the extension `es6` will be treated as an ES6 file:
+
+```es6
+// app/assets/javascript/application.es6
+
+var square = (n) => n * n
+
+console.log(square);
+```
+
+Start a Rails server in development mode and visit `localhost:3000/assets/application.js`, and this asset will be transpiled to JavaScript:
+
+```js
+var square = function square(n) {
+  return n * n;
+};
+
+console.log(square);
+```
 
-* Fixed MultiJson feature detect
 
-**2.4.1** (April 26, 2012)
+### JavaScript Templating with EJS and Eco
 
-* Fixed MultiJson API change
-* Fixed gzip mtime
+Sprockets supports *JavaScript templates* for client-side rendering of
+strings or markup. JavaScript templates have the special format
+extension `.jst` and are compiled to JavaScript functions.
 
-**2.4.0** (March 27, 2012)
+When loaded, a JavaScript template function can be accessed by its
+logical path as a property on the global `JST` object. Invoke a
+template function to render the template as a string. The resulting
+string can then be inserted into the DOM.
+
+```
+<!-- templates/hello.jst.ejs -->
+<div>Hello, <span><%= name %></span>!</div>
+
+// application.js
+//= require templates/hello
+$("#hello").html(JST["templates/hello"]({ name: "Sam" }));
+```
+
+Sprockets supports two JavaScript template languages:
+[EJS](https://github.com/sstephenson/ruby-ejs), for embedded
+JavaScript, and [Eco](https://github.com/sstephenson/ruby-eco), for
+embedded CoffeeScript. Both languages use the familiar `<% … %>`
+syntax for embedding logic in templates.
 
-* Added global path registry
-* Added global processor registry
+If the `ejs` gem is available to your application, you can use EJS
+templates in Sprockets. EJS templates have the extension `.jst.ejs`.
 
-**2.3.2** (March 26, 2012)
+If the `eco` gem is available to your application, you can use [Eco
+templates](https://github.com/sstephenson/eco) in Sprockets. Eco
+templates have the extension `.jst.eco`. Note that the `eco` gem
+depends on the CoffeeScript compiler, so the same caveats apply as
+outlined above for the CoffeeScript engine.
 
-* Fix Context#logical_path with dots
+### Minifying Assets
 
-**2.3.1** (February 11, 2012)
+Several JavaScript and CSS minifiers are available through shorthand.
 
-* Added bytesize to manifest
-* Added Asset#bytesize alias
-* Security: Check path for forbidden access after unescaping
+In Rails you will specify them with:
 
-**2.3.0** (January 16, 2012)
+```ruby
+config.assets.js_compressor  = :terser
+config.assets.css_compressor = :scss
+```
 
-* Added special Sass importer that automatically tracks any `@import`ed files.
+If you're not using Rails, configure this directly on the "environment".
 
-**2.2.0** (January 10, 2012)
+``` ruby
+environment.js_compressor  = :terser
+environment.css_compressor = :scss
+```
 
-* Added `sprockets` command line utility.
-* Added rake/sprocketstask.
-* Added json manifest log of compiled assets.
-* Added `stub` directive that allows you to exclude files from the bundle.
-* Added per environment external encoding (Environment#default_external_encoding). Defaults to UTF-8. Fixes issues where LANG is not set correctly and Rubys default external is set to ASCII.
+If you are using Sprockets directly with a Rack app, don't forget to add
+the `terser` and `sass` gems to your Gemfile when using above options.
 
-**2.1.2** (November 20, 2011)
+### Gzip
 
-* Disabled If-Modified-Since server checks. Fixes some browser caching issues when serving the asset body only. If-None-Match caching is sufficent.
+By default when Sprockets generates a compiled asset file it will also produce a gzipped copy of that file. Sprockets only gzips non-binary files such as CSS, javascript, and SVG files.
 
-**2.1.1** (November 18, 2011)
+For example if Sprockets is generating
 
-* Fix windows absolute path check bug.
+```
+application-12345.css
+```
 
-**2.1.0** (November 11, 2011)
+Then it will also generate a compressed copy in
 
-* Directive comment lines are now turned into empty lines instead of removed. This way line numbers in
-  CoffeeScript syntax errors are correct.
-* Performance and caching bug fixes.
+```
+application-12345.css.gz
+```
 
-**2.0.3** (October 17, 2011)
+This behavior can be disabled, refer to your framework specific documentation.
 
-* Detect format extensions from right to left.
-* Make JST namespace configurable.
+### Serving Assets
 
-**2.0.2** (October 4, 2011)
+In production you should generate your assets to a directory on disk and serve them either via Nginx or a feature like Rail's `config.public_file_server.enabled = true`.
 
-* Fixed loading stale cache from bundler gems.
+On Rails you can generate assets by running:
 
-**2.0.1** (September 30, 2011)
+```term
+$ RAILS_ENV=production rake assets:precompile
+```
 
-* Fixed bug with fingerprinting file names with multiple dots.
-* Decode URIs as default internal.
-* Fix symlinked asset directories.
+In development Rails will serve assets from `Sprockets::Server`.
 
-**2.0.0** (August 29, 2011)
+## Contributing to Sprockets
 
-* Initial public release.
+Sprockets is the work of hundreds of contributors. You're encouraged to submit pull requests, propose
+features and discuss issues.
 
-# License #
+See [CONTRIBUTING](CONTRIBUTING.md).
 
-Copyright &copy; 2011 Sam Stephenson <<sstephenson@gmail.com>>
+### Version History
 
-Copyright &copy; 2011 Joshua Peek <<josh@joshpeek.com>>
+Please see the [CHANGELOG](https://github.com/rails/sprockets/tree/master/CHANGELOG.md)
 
-Sprockets is distributed under an MIT-style license. See LICENSE for
-details.
+## License
+Sprockets is released under the [MIT License](MIT-LICENSE).