justinseiter / node-sass-endpoint

Easily server a SASS file from express.

node-sass-endpoint

Easily serve a SASS file as CSS from an express endpoint. No grunt/gulp, no build files, no required configuration – just pure data.

Dependencies

• node-sass (taken care of by npm install)
• ES6 Object.assign (either use node v4.0+ or a polyfill)

Installation

$ npm install node-sass-endpoint --save

Usage - Easy Version

Assuming you have the following directory structure:

client/
└── app.scss

server/
└── index.js

package.json

Then you can write the following as your server/index.js:

// server.js
var express = require('express');
var sass = require('node-sass-endpoint');
var app  = express();

app.get('/app.css',
  sass.serve('./client/app.scss'));

console.log("Listening on port 5555...");
app.listen(5555);

And run node server/index.js.

Now any GET request to localhost:5555/app.css will compile and serve the SASS file located at ./client/app.scss. Any @import statements within app.scss will also be included in the final output.

Advanced Usage

app.get(
  '/app.css',
  sass.serve('./client/app.scss', {

    // (dev only) defaults to parent folder of scss file.
    // Any sass file changes in this directory will clear the output cache.
    watchDir: './client/',

    // Defaults to parent folder of scss file.
    // The node_modules/ is always included.
    includePaths: ['./client/'],

    // defaults to false
    debug: false
  })
);