node-neat-2

v1.0.3

Published

3 years ago

node-sass wrapper for thoughtbot's bourbon neat library

Downloads

0High
0Medium
0Low

schady4

sass css

*This is a port of https://github.com/lacroixdesign/node-neat updating to version 3.0.1 use at your own risk. I am not avail for help. I just needed an updated version.

This is a node-sass port of the Neat library. If you are looking for the original Ruby/Rails version, you can find it here.

Requirements

node
gulp.js -or- Grunt -or- node-sass

Installation

To install as a development dependency, run:

npm install --save-dev node-neat-2

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

Usage

Basic Usage

To use node-neat-2 with tools like gulp.js, Grunt, or directly with node-sass, provide the path to Neat 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 neat = require('node-neat-2');
// Any of these will return an array of Neat & Bourbon's paths plus your custom path(s)
neat.with('path/to/stylesheets')
neat.with('path/to/stylesheets1', 'path/to/stylesheets2')
neat.with(['path/to/stylesheets1', 'path/to/stylesheets2'])

includePaths Property

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

var neat = require('node-neat-2');
neat.includePaths // Array of Neat 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 Neat & Bourbon in your stylesheet:

@import "neat";

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-neat-2').with('other/path', 'another/path')
      // - or -
      includePaths: require('node-neat-2').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-neat-2.

Example config:

grunt.initConfig({
  sass: {
    dist: {
      options: {
        // includePaths: require('node-neat-2').with('other/path', 'another/path')
        // - or -
        includePaths: require('node-neat-2').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-neat-2, then you will need to use the grunt-contrib-sass task instead.

Note that node-neat-2 is NOT tested against the Ruby version – only against LibSass.

Example config:

grunt.initConfig({
  sass: {
    dist: {
      options: {
        // loadPath: require('node-neat-2').with('other/path', 'another/path')
        // - or -
        loadPath: require('node-neat-2').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 neat = require('node-neat-2');

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

Getting Help

Again this is not the original project so use at your own risk.

Below is the original project and maintainer. Feel free to tweet me with questions @iamlacroix, or open a ticket on GitHub.

Testing

node-neat-2 is tested against the examples provided in the Neat documentation. The tests check for compile errors, so if a feature compiles but the expected output is incorrect, be sure to open a ticket.

Run the tests with:

make test

Credits

Michael LaCroix's original port of this project is here node-neat

This port of node-neat is maintained by Jarett Schadlich, credit goes to Michael LaCroix, however all credits for the Bourbon library go to thoughtbot, inc:

Neat is maintained and funded by thoughtbot, inc. Tweet your questions or suggestions at @kaishin and @kylefiedler.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Contents