@r-spacex/rocketsass v1.0.4

RocketSass

A smart Sass compiler that compiles each file to a specific target destination.

Installation

For installing for use as a command line utility, install globally:

$ npm install -g rocketsass

To install for use in node scripts, install locally as a development dependency:

$ npm install --save-dev rocketsass

Or as a standard dependency:

$ npm install --save rocketsass

Usage

In each Sass/SCSS file, add a comment header that looks like this:

/* compileDest = ./out/css/style.css */

You can also add options separated by commas:

/* compileDest = ./out/css/style.css, style = compressed */

It must start on the first line.

Then, simply run rocketsass from the command line:

$ rocketsass [path]
$ rocketsass css/scss                   # Compile Sass from css/scss
$ rocketsass module1/scss module2/scss  # Compile Sass from both module1/scss and module2/scss

where [path] is the path or a list of paths to your sass directory, eg. ./scss/. The default path is ./css/scss/.

Usage from scripts

// Import RocketSass
const rocketsass = require('rocketsass');

// Compile all sass files in a directory
rocketsass.compile(['./scss/'], {
  // Ignore files starting with this string, optional
  ignore: '_',
  // CSS output style (see below), optional
  style: 'nested',
  // Base directory for relative URLs, optional
  projectDir: 'dist/'
}, console); // Logger - where to log output to, optional.

Options

By default, RocketSass ignores Sass/SCSS files starting with '_'. You can override that by passing the option -i or --ignore.

$ rocketsass [path] -i ''           # Include all files
$ rocketsass [path] -i exclude_     # Ignore all files starting with 'exclude_'
$ rocketsass [path] -i '.'          # Ignore dotfiles

Passing rocketsass the option -s or --style can also set the output style of the CSS which takes one of the standard Sass output styles. This value overridden by the style set in a file's header. By default, the style is nested.

Passing rocketsass the option -q or --silent will mute all output, including errors.

$ rocketsass [path] -q              # No output
$ rocketsass [path]