sass-stream v0.1.8

#sass-stream Streaming interface for node-sass - supports .sass files.

##Installation Add to your devDependencies:

  "dependencies": {...},
  "devDependencies": {
    "sass-stream": "~0.1.8"
  },
  ...

or install directly:

npm install --save-dev sass-stream

then import in your build script:

var sass = require('sass-stream');

##Usage As a simple streaming compiler:

var sass = require('sass-stream'),
  fs = require('fs');

// As an intermediary step in a flow
fs.createReadStream('path/to/scss/src')
  .pipe(sass())
  .pipe(fs.createWriteStream('path/to/styles.css'));

// As the terminus in a flow
fs.createReadStream('path/to/sass/src')
  .pipe(sass({
    output: 'path/to/styles.css'
  }));

##Javascript API

var writableStream = sass(options);

options is an optional object with three optional properties:

• main - pass a path to indicate the main sass module.
• output - a filename to additionally write output to.
• compileOptions - a map of options to pass to node-sass.

Returns a Writable stream, can handle string or file stream input.

##Command Line API

node_modules/.bin/sass-stream path/to/sass/or/scss --output path/to/css/file.css [--main main.sass] [--outputStyle=compressed...]

The main argument, the path to sass source, can be a directory or file. --output is the target output for compile. --main optionally accepts a path (relative to the sass source path) to indicate the main sass file. If the passed source is a file, this will override any passed value for --main.

For compilation options, pass --optionName=value - these will be passed directly to node-sass. For options with array values (e.g. includePaths) pass each possibility as a value and they will be gathered: --includePaths=path/to/includes/dir --includePaths=path/to/other/includes/dir. See the node-sass docs for more details on compile-time options.

##TODO Sourcemaps.