sass-resolve

Resolves all sass files in current project and all dependencies to create on sourcemapped css file fromt them.

npm install sass-resolve
6 downloads in the last week
41 downloads in the last month

sass-resolve build status

Resolves all sass files in current project and all dependencies to create on sourcemapped css file fromt them.

var sassResolve =  require('sass-resolve');
var path        =  require('path');

var projectPath =  path.join(__dirname, 'fixtures');

sassResolve(
    projectPath    
  , { inlineSourceMap: false }
  , function (err, res) {
      if (err) return console.error(err);
      console.log(res.css);
      console.log(res.map);
    }
);

Installation

npm install sass-resolve

Note

sass-resolve >= v2 generates css using libsass. This eases deployment (npm install is all you need) and compiles much faster (20x faster on our project) than Ruby sass.

If you run into problems and need to use Ruby sass, please npm install sass-resolve@1 and review the relevant docs (the API has changed somewhat).

API

package.json

In order for resolve-sass to be able to find your .scss files you need to specify an .scss entry file via the main.scss field in the package.json of each project that has .scss files.

The entry .scss file should specify an @import for each .scss file you want to include.

Example

// package.json
{
  [..]
  "main.scss": "sass/index.scss",
  [..]
}
// sass/index.scss
@import "foo";
@import "bar";

Please investigate these fixtures for more information.

To get a better understanding of what options to set, please consult these tests.

sassResolve(root, opts, cb)

Resolves paths to all .scss files from the current package and its dependencies. The location of these sass files is indicated in the "main.scss" field inside packags.json. It then generates the css file including all the rules found in the resolved .scss files. Additionally it generates a .css.map file to enable sass source maps if so desired.

Parameters:
Name Type Argument Description
root string

path to the current package

opts Object <optional>

configure if and how source maps are created and if a css file is written

Properties
Name Type Argument Description
debug boolean <optional>

(default: true) generate source maps

inlineSourceMap boolean <optional>

(default: true) inline entire source map info into the .css file instead of referring to an external .scss.map file

imports function <optional>

allows overriding how imports are resolved (see: resolveScssFiles and importsFromScssFiles)

mapFileName string <optional>

(default: 'transpiled.css.map') name of the source map file to be included at the bottom of the generated css (not relevant when source maps are inlined)

cb function

function (err, res]) {}, called when all scss files have been transpiled, when nowrite is true, res contains generated css and map (if sourcemaps were enabled and not inlined)

Source:

sassResolve::imports(root, cb)

Resolves all paths of all .scss files of this project and its dependencies and generates the sass imports for them

Parameters:
Name Type Description
root String

full path to the project whose sass files to resolve

cb function

called back with imports for the .scss files or an error if one occurred

Source:

sassResolve::resolveScssFiles(root, cb)

Resolves paths to all .scss files from the current package and its dependencies. The location of these sass files is indicated in the "main.scss" field inside packags.json.

Parameters:
Name Type Description
root String

full path to the project whose scss files to resolve

cb function

called back with a list of paths to .scss files or an error if one occurred

Source:

sassResolve::scssFilesToImports(scssFiles) → {String}

Creates a .scss import string from the previously resolved sass paths (see: resolveScssFiles) This function is called by imports and exposed as an advanced api if more manual tweaking is needed.

Parameters:
Name Type Description
scssFiles Array

paths to resolved .scss files

Source:
Returns:

of @import statements for each .scss file

Type
String

generated with docme

Examples

debug: true, inlineSourceMap: false, mapFileName: 'my.css.map'

Will generate source maps and inline the sources of all original files.

These source map is returned as res.map which you'll have to serve as /my.css.map.

debug: true, inlineSourceMap: true

Will generate source maps and instead of referring to a separate res.map. all source map data is inlined at the bottom of the css. Therefore you don't have to serve the source map, but keep in mind that now it adds to the size of the css loaded, so only use this option in development.

License

MIT

npm loves you