Overview

tfm

i figured i'd just label the code as tfm since it's pretty basic code and all your questions about what the code is capable of doing will be answered by reading tfm.

lib/

the interesting code. this is where you'll find the code that does stuff.

lib/jsgi/

jsgi applications and middleware.

there are a lot of files/folders in here because heroku needs everything to be included. the following files are the ones which i've written.

lib/jsgi/sass.js

exports.Sass implements a constructor for a jsgi application that wraps sass.js. the constructor takes an optional options object. options can have the following properties:

  • extension - the file extension of files to be parsed as sass. by default this is '.sass'
  • root - the path to the root directory where sass files are located. by default this is 'sass'

these options can also be defined by providing them as the sass property of local.json

{
    "sass": {
        "extension": ".sass",
        "root": "sass"
    }
}

if no options are defined via the constructor or via local.json then the defaults will be used.

lib/jsgi/static.js

exports.Static implements pintura's jsgi static application in a way which is compatible with node before v0.1.95 (ie node without buffers).

lib/index.js

kind of a demo server to demonstrate the code being used.

public/

the root directory of the static files served by the demo server.

sass/

some raw sass files. comment.sass, continuation.sass and properties.nested.invalid.sass are test fixtures from sass.js

local.json

an application configuration file. you can access the contents of this file as an object via

settings = require('commonjs-utils/settings');

package.json

a commonjs package descriptor file. this file is used by nodules to find the mappings for all the dependencies of this package.