Connect middleware for hem
CoffeeScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
src
test
.gitignore
Cakefile
LICENSE
README.md
package.json

README.md

Introduction

Hem is a project for compiling JavaScript CommonJS modules. It acts as either a server, or a compiler for static sites. Sometimes when using hem you would like to use Node.js to write server logic. connect-hem provides the benefits of hem from within a connect or express application

Installation

npm install connect-hem

Usage

Example using express:

hem = require('connect-hem');
app = require('express').createServer();

app.use(hem({
  jsPath: '/js/main.js',         // JavaScript ill be served at /js/main.js
  slug: __dirname + "/slug.json" // Load configuration from hem slug file
}));

app.listen(80);

The middleware builder takes one argument, options, which is an Object

  • jsPath: The path which will seve the compiled JavaScript: Default: '/application.js'
  • slug: Path to slug.json file. Default: './slug.json'
  • libs: Array of additional static js files to include. Default: []
  • paths: Array of paths to locations of your script files. Default: ['./app']
  • dependencies: Array of depenent modules to include in your app. Default: []

If slug is defined, and it is './slug.json' by default, the file will be loaded, and any options in the slug will override any default options or options passed to the middleware

Running Tests

Install development dependencies npm --dev install

Run Tests

cake test

To build js from coffee

cake build

To build and run tests

cake build test