Transparent file compilation and dependency management for Node's connect framework in the spirit of the Rails 3.1 asset pipeline.
.coffee(CoffeeScript) files as compiled
.jstogether using Snockets
.styl(Stylus) as compiled
.css(with nib baked in when available)
- Serve files with an MD5 hash suffix and use a far-future expires header for maximum efficiency
- Avoid redundant git diffs by storing compiled
.cssfiles in memory rather than writing them to the disk—except when you want them (e.g. for deployment to a CDN).
First, install it in your project's directory:
npm install connect-assets
Also install any specific compilers you'll need, e.g.:
npm install coffee-script npm install stylus npm install nib
Then add this line to your app's configuration:
Finally, create an
assets directory in your project and throw all your
.styl files in there
connect-assets provides two global functions named
css. Use them in your views. They tell connect-assets to do any necessary compilation, then return the markup you need. For instance, in a Jade template, the code
!= css('normalize') != js('jquery')
(where `!= is Jade's syntax for running JS and displaying its output) results in the markup
<link rel='stylesheet' href='/css/normalize.css'> <script src='/js/jquery.js'></script>
You can indicate dependencies in your CoffeeScript files using the Sprockets-style syntax
#= require dependency
js function at that file, two things can happen:
- By default, you'll get multiple
<script>tags out, in an order that gives you all of your dependencies.
- If you passed the
build: trueoption to connect-assets (enabled by default when
If you want to bring in a whole folder of scripts, use
#= require_tree dir
See Snockets for more information.
Note: CSS concatenation is not supported by connect-assets directly, because Stylus already does a fine job of this. Stylus is basically a superset of CSS, so just rename your
.css files to
.styl and learn about its @import syntax.
If you like, you can pass any of these options to the function returned by
'assets'): The directory assets will be read from
global): The object the
jshelper functions will attach to
- ... see the source (
src/assets.coffee) for more.
You can also set the "root path" on the
js helper functions (by default,
To override these roots, start a path with
'/'. So, for instance,
<link rel='stylesheet' href='/css/normalize.css'>
<link rel='stylesheet' href='/normalize.css'>
©2011 Trevor Burnham and available under the MIT license:
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.