dobi-asset-wrap
v4.0.10
Published
Asset management framework for nodejs
Downloads
37
Maintainers
Keywords
Readme
Fork of https://www.npmjs.com/package/asset-wrap. This readme is out of date, this package now uses promises.
Asset-Wrap is a simple asset manager for node.
Goals
- build anytime (middleware or dynamically)
- css: support stylus, less, and sass
- js: support coffee-script
- use async whenever possible
- support cluster
- easily extendible
- watch for file changes
- serve files from s3 or cloudfiles or azure
Install
npm install asset-wrap
Asset
An asset representing a css or js file
asset = new wrap.Asset {
src: '/js/app.js'
}
Options
cache
: maxAge to set cache headerssrc
: the path to your source filedst
: the location to serve your file from (without the md5 appended)url
: the dst with the md5 appendedcdn
: cdn information to push assets todata
: the contentext
: the file extension of the wrapped assetmd5
: the md5 of the wrapped contenttag
: the full html tag to render
Events
complete
: Emitted after asset has content, headers, url, etc.compiled
: Emitted once asset.data is compilederror
: Emitted if there is an error compiling the asset
Creating a Custom Asset
class MyAsset extends wrap.Asset
ext: 'txt'
name: 'my-asset'
type: 'text/plain'
compile: ->
@data = 'hello world'
@emit 'compiled'
Assets
A group of Asset
s. Use when you're compiling multiple assets or for middleware
assets = new wrap.Assets [
new wrap.Snockets {
src: 'assets/hello.coffee'
}
new wrap.Stylus {
src: 'assets/hello.styl'
}
], {
compress: true
watch: true
}, (err) =>
throw err if err
Options
Options are the exact same as an asset. Any options given here are passed down to each asset.
Asset Types
- CSSAsset
- LessAsset
- SassAsset
- SnocketsAsset
- StylusAsset
Examples
Use as Middleware with ZappaJS
require('zappajs') ->
wrap = require 'asset-wrap'
assets = new wrap.Assets [
new wrap.Snockets {
src: 'assets/hello.coffee'
dst: '/js/hello.js'
}
new wrap.Stylus {
src: 'assets/hello.styl'
dst: '/css/hello.css'
}
], {
compress: true
watch: true
}, (err) =>
throw err if err
@use assets.middleware
@get '/': ->
@render index: {
assets: assets
}
@view index: ->
head ->
text @assets.tag '/css/hello.css'
text @assets.tag '/js/hello.js'
body ->
a href: @assets.url '/css/hello.css', ->
'View CSS'
pre ->
@assets.data '/css/hello.css'
a href: @assets.url '/js/hello.js', ->
'View Javascript'
pre ->
@assets.data '/js/hello.js'
Generate Asset Dynamically in ZappaJS
require('zappajs') ->
wrap = require 'asset-wrap'
@get '/': ->
asset = new wrap.Snockets {
src: 'assets/hello.coffee'
compress: true
}, (err) =>
@res.send 500, err if err
@res.setHeader 'ContentType', asset.type
@res.send asset.data
Generate Asset Dynamically With Cluster
cluster = require 'cluster'
os = require 'os'
if cluster.isMaster
# Fork workers
cluster.fork() for i in os.cpus()
cluster.on 'exit', (worker, code, signal) ->
console.log "worker #{worker.process.pid} died"
else
# Workers can share any TCP connection
require('zappajs') ->
wrap = require 'asset-wrap'
@get '/js/hello.js': ->
asset = new wrap.Snockets {
src: 'assets/hello.coffee'
dst: '/js/hello.js'
compress: true
}, (err) =>
@res.send 500, err if err
@res.setHeader 'ContentType', asset.type
@res.send asset.data
@get '/': ->
@render 'index': {layout: no}
@view index: ->
body ->
div ->
a href: '/js/hello.js', ->
'View Javascript'
Credit
Much inspiration from the other asset management tools out there.
- Brad Carleton's asset-rack
- Trevor Burnham's connect-assets
- the Rails Asset Pipeline
License
©2013 Bryant Williams 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.