Node-sass is a library that provides binding for Node.js to libsass, the C version of the popular stylesheet preprocessor, Sass.
It allows you to natively compile .scss files to css at incredible speed and automatically via a connect middleware.
Find it on npm: https://npmjs.org/package/node-sass
npm install node-sass
var sass = ;sass;// ORvar css = sass;
The API for using node-sass has changed, so that now there is only one variable - an options hash. Some of these options are optional, and in some circumstances some are mandatory.
file is a
String of the path to an
scss file for libsass to render. One of this or
data options are required, for both render and renderSync.
data is a
String containing the scss to be rendered by libsass. One of this or
file options are required, for both render and renderSync. It is recommended that you use the
includePaths option in conjunction with this, as otherwise libsass may have trouble finding files imported via the
success is a
Function to be called upon successful rendering of the scss to css. This option is required but only for the render function. If provided to renderSync it will be ignored.
error is a
Function to be called upon occurance of an error when rendering the scss to css. This option is optional, and only applies to the render function. If provided to renderSync it will be ignored.
includePaths is an
Array of path
Strings to look for any
@imported files. It is recommended that you use this option if you are using the
data option and have any
@import directives, as otherwise libsass may not find your depended-on files.
outputStyle is a
String to determine how the final CSS should be rendered. Its value should be one of
'nested', 'expanded', 'compact', 'compressed'.
[Important: currently the argument
outputStyle has some problem which may cause the output css becomes nothing because of the libsass, so you should not use it now!]
sourceComments is a
String to determine what debug information is included in the output file. Its value should be one of
'none', 'normal', 'map'. The default is
souceComments is only supported when using the
file option, and does nothing when using
var sass = ;sass;// ORconsole
- In the case that both
dataoptions are set, node-sass will only attempt to honour the
.scss files automatically for connect and express based http servers
var server = connect;
Heavily inspired by https://github.com/LearnBoost/stylus
@sindresorhus has created a set of grunt tasks based on node-sass: https://github.com/sindresorhus/grunt-sass
There is also an example connect app here: https://github.com/andrew/node-sass-example
Node-sass includes pre-compiled binaries for popular platforms, to add a binary for your platform follow these steps:
Check out the project:
git clone https://github.com/andrew/node-sass.git cd node-sass npm install npm install -g node-gyp git submodule init git submodule update node-gyp rebuild
Replace the prebuild binary with your newly generated one
cp build/Release/binding.node precompiled/*your-platform*/binding.node
Command Line Interface
The interface for command-line usage is fairly simplistic at this stage, as seen in the following usage section.
Output will be saved with the same name as input SASS file into the current working directory if it's omitted.
node-sass [options] <input.scss> [<output.css>]
--output-style CSS output style (nested|expanded|compact|compressed) [default: "nested"] --source-comments Include debug info in output (none|normal|map) [default: "none"] --include-path Path to look for @import-ed files [default: cwd] --help, -h Print usage info
Special thanks to the following people for submitting patches:
Dean Mao Brett Wilkins litek gonghao
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 (c) 2013 Andrew Nesbitt. See LICENSE for details.