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
.styl(Stylus) as compiled
.css(with nib baked in when available)
.cssfiles directly from the same directory, if you want.
To keep your project clean and avoid redundant git diffs, connect-assets stores the compiled output in memory rather than writing it to the disk.
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:
Serving and compiling assets
assets directory in your project and throw all your
.styl files in there. Bam! Files get served like so:
assets/js/script.coffee is compiled and served when you go to
assets/css/style.styl is compiled and served at
connect-assets provides a couple of helper functions for use in your markup. In a Jade template, for instance, you might write
link(rel='stylesheet', href='/css/normalize.css') script(src='/js/jquery.js')
But with connect-assets, you can just write
!= css('normalize') != js('jquery')
!= is Jade's syntax for running JS and putting its output directly in the markup). Thecss` function just emits a string like
<link rel='stylesheet' href='/css/normalize.css'>
js function, on the other hand, is more powerful...
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're in production mode (
If you want to bring in a whole folder of scripts, use
#= require_tree dir
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
You can also set the "root path" on the
js helper functions (by default,
- Error-handling needs to be improved.
- Code needs to be better structured and made more extensible.
This is still a young project, and feedback of all kinds is much appreciated.
©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.