Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 2.37 KB

README.md

File metadata and controls

64 lines (43 loc) · 2.37 KB
Raw

broccoli-sass

The broccoli-sass plugin compiles .scss and .sass files with libsass.

This is a fork of broccoli-sass that includes support for more options and provides (partial) support for source maps by embedding the content of the SASS source files in the source map using sourcesContent.

Be aware that the paths in the generated source map not correct, but this module does what I need until the underlying issue is resolved.

Installation

npm install --save-dev broccoli-sass-source-maps

Usage

var compileSass = require('broccoli-sass-source-maps');

var outputTree = compileSass(inputTrees, inputFile, outputFile, options);

  • inputTrees: An array of trees that act as the include paths for libsass. If you have a single tree, pass [tree].

  • inputFile: Relative path of the main .scss or .sass file to compile. Broccoli-sass expects to find this file in the first input tree (inputTrees[0]).

  • outputFile: Relative path of the output CSS file.

  • options: A hash of options for libsass and caching writer.

    • Supported options for libsass are: functions, indentedSyntax, omitSourceMapUrl, outputStyle, precision, sourceComments, sourceMap, sourceMapEmbed, and sourceMapContents.
    • Options for caching writer include: annotation, cacheInclude, and cacheExclude (see details here).

  • nodeSass: Allows a different version of node-sass to be used.

Example

var appCss = compileSass(['styles', 'vendor'], 'myapp/app.scss', 'assets/app.css');

Choosing the version of node-sass

You can specify which version of node-sass to use with the nodeSass option.

Add the version that you want to use to your package.json and then provide that version of the module using the nodeSass option:

var compileSass = require('broccoli-sass-source-maps');
var nodeSass = require('node-sass'); // loads the version in your package.json

var outputTree = compileSass(inputTrees, inputFile, outputFile, {
  nodeSass: nodeSass
});