Node-jeet-sass NPM

node-jeet-sass

*This is a node-sass port of the Jeet library (version 6.1.2).

Requirements

Installation

To install as a development dependency, run:

npm install --save-dev node-jeet-sass

If you need it in production, replace --save-dev with --save.

Usage

Basic Usage

To use node-jeet-sass with tools like gulp.js, Grunt, or directly with node-sass, provide the path to Jeet in your Sass config. There are a couple of convenience methods for this, depending on whether you want Sass to include additional directories or not.

with() Function

The with() function will include any additional paths you pass as arguments.

Returns an array of paths.

var jeet = require('node-jeet-sass');
// Any of these will return an array of Jeet paths plus your custom path(s)
jeet.with('path/to/stylesheets')
jeet.with('path/to/stylesheets1', 'path/to/stylesheets2')
jeet.with(['path/to/stylesheets1', 'path/to/stylesheets2'])

includePaths Property

The includePaths property returns an array of Jeet's paths to use in your config.

var jeet = require('node-jeet-sass');
jeet.includePaths // Array of Jeet paths

Stylesheet usage

Use either method above with the Sass config for your chosen tool (gulp.js, Grunt, etc.), then it's business as usual for Jeet in your stylesheet:

@import "jeet";

gulp.js Usage

Using the gulp-sass plugin.

var gulp = require('gulp');
var sass = require('gulp-sass');

gulp.task('sass', function () {
  gulp.src('path/to/input.scss')
    .pipe(sass({
      // includePaths: require('node-jeet-sass').with('other/path', 'another/path')
      // - or -
      includePaths: require('node-jeet-sass').includePaths
    }))
    .pipe(gulp.dest('path/to/output.css'));
});

Grunt Usage

Using grunt-sass

The grunt-sass task uses node-sass (LibSass) underneath, and is the recommended way to use Grunt with node-jeet-sass.

Example config:

grunt.initConfig({
  sass: {
    dist: {
      options: {
        // includePaths: require('node-jeet-sass').with('other/path', 'another/path')
        // - or -
        includePaths: require('node-jeet-sass').includePaths
      },
      files: {
        'path/to/output.css': 'path/to/input.scss'
      }
    }
  }
});

Using grunt-contrib-sass

If you are using the Ruby version of Sass with node-jeet-sass, then you will need to use the grunt-contrib-sass task instead.

Note that node-jeet-sass is NOT tested against the Ruby version – only against LibSass.

Example config:

grunt.initConfig({
  sass: {
    dist: {
      options: {
        // loadPath: require('node-jeet-sass').with('other/path', 'another/path')
        // - or -
        loadPath: require('node-jeet-sass').includePaths
      },
      files: {
        'path/to/output.css': 'path/to/input.scss'
      }
    }
  }
});

node-sass Usage

Using it directly with node-sass.

var sass    = require('node-sass')
var jeet = require('node-jeet-sass');

sass.render({
  file: './application.scss',
  success: function(css){
    console.log(css);
  },
  error: function(error) {
    console.log(error);
  },
  // includePaths: jeet.with('other/path', 'another/path'),
  // - or -
  includePaths: jeet.includePaths,
  outputStyle: 'compressed'
});