node-sass

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:

Follow @nodesass on twitter for release updates: https://twitter.com/nodesass

Install

npm install node-sass

Some users have reported issues installing on Ubuntu due to node being registered to another package. Follow the official NodeJS docs to install NodeJS so that #!/usr/bin/env node correctly resolved.

Compiling versions 0.9.4 and above on Windows machines requires Visual Studio 2013 WD. If you have multiple VS versions, use ``npm install` with the `--msvs_version=2013` flag also use this flag when rebuilding the module with node-gyp or nw-gyp. **Having installation troubles? Check out our [Troubleshooting guide](/TROUBLESHOOTING.md).** ## Usage %%CODEBLOCK1%% ## Options ### file Type: String Default: null **Special**: file or data must be specified Path to a file for [libsass] to render. ### data Type: String Default: null **Special**: file or data must be specified A string to pass to [libsass] to render. It is recommended that you use includePaths in conjunction with this so that [libsass] can find files when using the @import directive. ### importer (>= v2.0.0) - _experimental_ **This is an experimental Libsass feature. Use with caution.** Type: Function | Function[] signature function(url, prev, done) Default: undefined Function Parameters and Information: * url (String) - the path in import **as-is**, which [libsass] encountered * prev (String) - the previously resolved path * done (Function) - a callback function to invoke on async completion, takes an object literal containing * file (String) - an alternate path for [libsass] to use **OR** * contents (String) - the imported contents (for example, read from memory or the file system) Handles when [libsass] encounters the @import directive. A custom importer allows extension of the [libsass] engine in both a synchronous and asynchronous manner. In both cases, the goal is to either return or call done() with an object literal. Depending on the value of the object literal, one of two things will happen. When returning or calling done() with { file: "String" }, the new file path will be assumed for the @import. It's recommended to be mindful of the value of prev in instances where relative path resolution may be required. When returning or calling done() with { contents: "String" }, the string value will be used as if the file was read in through an external source. Starting from v3.0.0: * this refers to a contextual scope for the immediate run of sass.render or sass.renderSync * importers can return error and LibSass will emit that error in repsonse. For instance: %%CODEBLOCK2%% * importer can be an array of functions, which will be called by libsass in the order of their occurance in array. This helps user specify special importer for particular kind of path (filesystem, http). If an importer does not want to handle a particular path, it should return sass.NULL. See [functions section](#functions--v300) for more details on Sass types. ### functions (>= v3.0.0) - _experimental_ **This is an experimental Libsass feature. Use with caution.** functions is an Object that holds a collection of custom functions that may be invoked by the sass files being compiled. They may take zero or more input parameters and must return a value either synchronously (return ...;) or asynchronously (done();). Those parameters will be instances of one of the constructors contained in the require('node-sass').types hash. The return value must be of one of these types as well. See the list of available types below: #### types.Number(value [, unit = ""]) * getValue()/ setValue(value) : gets / sets the numerical portion of the number * getUnit() / setUnit(unit) : gets / sets the unit portion of the number #### types.String(value) * getValue() / setValue(value) : gets / sets the enclosed string #### types.Color(r, g, b [, a = 1.0]) or types.Color(argb) * getR() / setR(value) : red component (integer from 0 to 255) * getG() / setG(value) : green component (integer from 0 to 255) * getB() / setB(value) : blue component (integer from 0 to 255) * getA() / setA(value) : alpha component (number from 0 to 1.0) Example: %%CODEBLOCK3%% #### types.Boolean(value) * getValue() : gets the enclosed boolean * types.Boolean.TRUE : Singleton instance of types.Boolean that holds "true" * types.Boolean.FALSE : Singleton instance of types.Boolean that holds "false" #### types.List(length [, commaSeparator = true]) * getValue(index) / setValue(index, value) : value must itself be an instance of one of the constructors in sass.types. * getSeparator() / setSeparator(isComma) : whether to use commas as a separator * getLength() #### types.Map(length) * getKey(index) / setKey(index, value) * getValue(index) / setValue(index, value) * getLength() #### types.Null() * types.Null.NULL : Singleton instance of types.Null. #### Example %%CODEBLOCK4%% ### includePaths Type: Array Default: [] An array of paths that [libsass] can look in to attempt to resolve your @import declarations. When using data, it is recommended that you use this. ### indentedSyntax Type: Boolean Default: false true values enable [Sass Indented Syntax](http://sass-lang.com/documentation/file.INDENTED_SYNTAX.html) for parsing the data string or file. ### indentType (>= v3.0.0) Type: String Default: space Used to determine whether to use space or tab character for indentation. ### indentWidth (>= v3.0.0) Type: Number Default: 2 Maximum: 10 Used to determine the number of spaces or tabs to be used for indentation. ### linefeed (>= v3.0.0) Type: String Default: lf Used to determine whether to use cr, crlf, lf or lfcr sequence for line break. ### omitSourceMapUrl Type: Boolean Default: false **Special:** When using this, you should also specify outFile to avoid unexpected behavior. true values disable the inclusion of source map information in the output file. ### outFile Type: String | null Default: null **Special:** Required when sourceMap is a truthy value Specify the intended location of the output file. Strongly recommended when outputting source maps so that they can properly refer back to their intended files. ### outputStyle Type: String Default: nested Values: nested, expanded, compact, compressed Determines the output format of the final CSS style. ### precision Type: Integer Default: 5 Used to determine how many digits after the decimal will be allowed. For instance, if you had a decimal number of 1.23456789 and a precision of 5, the result will be 1.23457 in the final CSS. ### sourceComments Type: Boolean Default: false true enables additional debugging information in the output file as CSS comments ### sourceMap Type: Boolean | String | undefined Default: undefined **Special:** Setting the sourceMap option requires also setting the outFile option Enables the outputting of a source map during render and renderSync. When sourceMap === true, the value of outFile is used as the target output location for the source map. When typeof sourceMap === "String", the value of sourceMap will be used as the writing location for the file. ### sourceMapContents Type: Boolean Default: false true includes the contents in the source map information ### sourceMapEmbed Type: Boolean Default: false true embeds the source map as a data URI ### sourceMapRoot Type: String Default: undefined the value will be emitted as sourceRoot in the source map information ## render Callback (>= v3.0.0) node-sass supports standard node style asynchronous callbacks with the signature of function(err, result). In error conditions, the error argument is populated with the error object. In success conditions, the result object is populated with an object describing the result of the render call. ### Error Object * message (String) - The error message. * line (Number) - The line number of error. * column (Number) - The column number of error. * status (Number) - The status code. * file (String) - The filename of error. In case file option was not set (in favour of data), this will reflect the value stdin. ### Result Object * css (Buffer) - The compiled CSS. Write this to a file, or serve it out as needed. * map (Buffer) - The source map * stats (Object) - An object containing information about the compile. It contains the following keys: * entry (String) - The path to the scss file, or data if the source was not a file * start (Number) - Date.now() before the compilation * end (Number) - Date.now() after the compilation * duration (Number) - *end* - *start* * includedFiles (Array) - Absolute paths to all related scss files in no particular order. ### Examples %%CODEBLOCK5%% ### Special behaviours * In the case that both file and data options are set, node-sass will give precedence to data and use file to calculate paths in sourcemaps. ### Version information (>= v2.0.0) Both node-sass and libsass version info is now exposed via the info method: %%CODEBLOCK6%% Since node-sass >=v3.0.0 libsass version is determined at run time. ## Integrations Listing of community uses of node-sass in build tools and frameworks. ### Brackets extension [@jasonsanjose](https://github.com/jasonsanjose) has created a [Brackets](http://brackets.io) extension based on node-sass: <https://github.com/jasonsanjose/brackets-sass>. When editing Sass files, the extension compiles changes on save. The extension also integrates with Live Preview to show Sass changes in the browser without saving or compiling. ### Brunch plugin [Brunch](http://brunch.io)'s official sass plugin uses node-sass by default, and automatically falls back to ruby if use of Compass is detected: <https://github.com/brunch/sass-brunch> ### Connect/Express middleware Recompile .scss files automatically for connect and express based http servers. This functionality has been moved to [node-sass-middleware](https://github.com/sass/node-sass-middleware) in node-sass v1.0.0 ### DocPad Plugin [@jking90](https://github.com/jking90) wrote a [DocPad](http://docpad.org/) plugin that compiles .scss files using node-sass: <https://github.com/jking90/docpad-plugin-nodesass> ### Duo.js extension [@stephenway](https://github.com/stephenway) has created an extension that transpiles Sass to CSS using node-sass with [duo.js](http://duojs.org/) <https://github.com/duojs/sass> ### Grunt extension [@sindresorhus](https://github.com/sindresorhus/) has created a set of grunt tasks based on node-sass: <https://github.com/sindresorhus/grunt-sass> ### Gulp extension [@dlmanning](https://github.com/dlmanning/) has created a gulp sass plugin based on node-sass: <https://github.com/dlmanning/gulp-sass> ### Harp [@sintaxi](https://github.com/sintaxi)’s Harp web server implicitly compiles .scss files using node-sass: <https://github.com/sintaxi/harp> ### Metalsmith plugin [@stevenschobert](https://github.com/stevenschobert/) has created a metalsmith plugin based on node-sass: <https://github.com/stevenschobert/metalsmith-sass> ### Meteor plugin [@fourseven](https://github.com/fourseven) has created a meteor plugin based on node-sass: <https://github.com/fourseven/meteor-scss> ### Mimosa module [@dbashford](https://github.com/dbashford) has created a Mimosa module for sass which includes node-sass: <https://github.com/dbashford/mimosa-sass> ## Example App There is also an example connect app here: <https://github.com/andrew/node-sass-example> ## Rebuilding binaries Node-sass includes pre-compiled binaries for popular platforms, to add a binary for your platform follow these steps: Check out the project: %%CODEBLOCK7%% ## 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. ### Usage node-sass [options] [output.css] cat | node-sass > output.css **Options:** %%CODEBLOCK8%% Pass a directory as the input to compile multiple files. For example: node-sass sass/ -o css/. The --output flag is required and must be a directory when using multi-file compilation. Also, note --importer takes the (absolute or relative to pwd) path to a js file, which needs to have a default module.exports set to the importer function. See our test [fixtures](https://github.com/sass/node-sass/tree/974f93e76ddd08ea850e3e663cfe64bb6a059dd3/test/fixtures/extras) for example. The source-map option accepts true as value, in which case it replaces destination extension with .css.map. It also accepts path to .map file and even path to the desired directory. In case of multi-file compilation path to .map` yields error.

Post-install Build

Install runs only two Mocha tests to see if your machine can use the pre-built [libsass] which will save some time during install. If any tests fail it will build from source.

Maintainers

This module is brought to you and maintained by the following people:

• Michael Mifsud - Project Lead (Github / Twitter)
• Andrew Nesbitt (Github / Twitter)
• Dean Mao (Github / Twitter)
• Brett Wilkins (Github / Twitter)
• Keith Cirkel (Github / Twitter)
• Laurent Goderre (Github / Twitter)
• Nick Schonning (Github / Twitter)
• Adam Yeats (Github / Twitter)
• Adeel Mujahid (Github / Twitter)

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.

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) 2015 Andrew Nesbitt. See LICENSE for details.