README.md

grunt-scss-lint

Getting Started

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-scss-lint --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-scss-lint');

Scss-lint task

This task requires you to have Ruby, and scss-lint installed. If you're on OS X or Linux you probably already have Ruby installed; test with ruby -v in your terminal. When you've confirmed you have Ruby installed, run gem update --system && gem install scss-lint to install the scss-lint gem.

Options

bundleExec

Type: Boolean

Default: false

You can choose to have your gems installed via bundler and if so, set this option to true to use the local gems.

colorizeOutput

Type: Boolean

Default: true

Get some nice looking output.

For colors to work on Windows, you first need to install 2 extra gems. This is because of Rainbow, a dependency of scss-lint.

gem install windows-pr win32console

compact

Type: Boolean

Default: false

Group related linted files for more easier error review. XML output will still be default from scss-lint.

config

Type: String

Default: node_modules/grunt-scss-lint/.scss-lint.yml.

Specify a configuration file.

exclude

Type: String or Array

Default: null

Exclude one or more files from being linted.

reporterOutput

Type: String

Default: null

The jUnit XML file to save the output to. If you don't want this then set the option as null.