node-sass-middleware
Connect/Express middleware for node-sass .
Install
npm install node-sass-middleware copy
Usage
Recompile .scss or .sass files automatically for connect and express based http servers.
Connect example
const connect = require ( 'connect' )
const sassMiddleware = require ( 'node-sass-middleware' )
const server = connect. createServer (
sassMiddleware ({
/* Options */
src: __dirname
, dest: __dirname + '/public'
, debug: true
, outputStyle: 'compressed'
, prefix: '/prefix' // Where prefix is at <link rel="stylesheets" href="prefix/style.css"/>
}),
connect. static ( '/prefix' , __dirname + '/public' )
); copy
There is an example connect app here: https://github.com/andrew/node-sass-example
Heavily inspired by https://github.com/LearnBoost/stylus
Express example
const express = require ( 'express' );
const sassMiddleware = require ( 'node-sass-middleware' );
const path = require ( 'path' );
const app = express ();
app. use ( sassMiddleware ({
/* Options */
src: __dirname,
dest: path. join (__dirname, 'public' ),
debug: true ,
outputStyle: 'compressed' ,
prefix: '/prefix' // Where prefix is at <link rel="stylesheets" href="prefix/style.css"/>
}));
// Note: you must place sass-middleware *before* `express.static` or else it will
// not work.
app. use
Connect with other middleware example
const connect = require ( 'connect' );
const sassMiddleware = require ( 'node-sass-middleware' );
const postcssMiddleware = require ( 'postcss-middleware' );
const autoprefixer = require ( 'autoprefixer' );
const path = require ( 'path' );
const http = require ( 'http' );
const app = connect ();
const destPath = __dirname + '/public' ;
app. use ( sassMiddleware ({
/* Options */
Options
src - (String) Source directory used to find .scss or .sass files.
Optional configurations
beepOnError - Enable beep on error, false by default.
debug - [true | false], false by default. Output debugging information.
dest - (String) Destination directory used to output .css files (when undefined defaults to src).
error - A function to be called when something goes wrong.
force - [true | false], false by default. Always re-compile.
indentedSyntax - [true | false], false by default. If true compiles files with the .sass extension instead of .scss in the src directory.
log - function(severity, key, val, message), used to log data instead of the default console.error. "severity" matches Winston severity levels.
maxAge - MaxAge to be passed in Cache-Control header.
prefix - (String) It will tell the sass middleware that any request file will always be prefixed with <prefix> and this prefix should be ignored.
response - , true by default. To write output directly to response instead of to a file.
Express example with custom log function
const express = require ( 'express' );
const sassMiddleware = require ( 'node-sass-middleware' );
const path = require ( 'path' );
const winston = require ( 'winston' );
const app = express ();
winston.level = 'debug' ;
app. use ( sassMiddleware ({
/* Options */
src: __dirname,
dest: path. join (__dirname, 'public' ),
debug: true ,
log : function (severity, key, value) { winston. log (severity,
Contributors
We <3 our contributors! A special thanks to all those who have clocked in some dev time on this project, we really appreciate your hard work. You can find a full list of those people here .
Building and Testing
git clone git@github.com:sass/node-sass-middleware
cd node-sass-middleware
npm install
npm test copy
Note on Patches/Pull Requests
Fork the project.
Make your feature addition or bug fix.
Add documentation if necessary.
Add tests for it. This is important so I don't break it in a future version unintentionally.
Send a pull request. Bonus points for topic branches.
Copyright
Copyright (c) 2013+ Andrew Nesbitt. See LICENSE for details.