To install as a development dependency, run:
npm install --save-dev node-neat
If you need it in production, replace
node-neat 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 will include any additional paths you pass as arguments.
Returns an array of paths.
var neat = ;// Any of these will return an array of Neat & Bourbon's paths plus your custom path(s)neatneatneat
includePaths property returns an array of Neat & Bourbon's paths to use in your config.
var neat = ;neatincludePaths // Array of Neat paths
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:
Using the gulp-sass plugin.
var gulp = ;var sass = ;gulp;
If you are using the Ruby version of Sass with node-neat, then you will need to use the grunt-contrib-sass task instead.
Note that node-neat is NOT tested against the Ruby version – only against LibSass.
Using it directly with node-sass.
var sass =var neat = ;sass;
node-neat 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:
This node-sass port is maintained by Michael LaCroix, however all credits for the Bourbon Neat library go to thoughtbot, inc:
node-neat is Copyright © 2013-2014 Michael LaCroix. It is free software, and may be redistributed under the terms specified in the LICENSE file.