a-tarasyuk / broccoli-scss-lint

Broccoli plugin for validate .scss files

broccoli-scss-lint

Broccoli plugin for validate .scss files

Dependencies

1. Ruby (Ruby 1.9.3+)
2. scss-lint

Installation

npm install broccoli-scss-lint 

Options

config

Type: String
Default: ''

Specify a configuration file to use

####bundleExec Type: Boolean
Default: false

format

Type: String | Array
Default: Default

Output format (xml, config). If value of this option equals xml, option 'reportFile' cannot be empty. Also you can set format as array (['xml', 'default'], ['config', 'default'], ['config', 'default', 'xml']) in order to see errors in console and save result in xml file.

reportFile

Type: String
Default: ''

File where will be saved report

Examples

var scssLint = require('broccoli-scss-lint');

// Validate with custom config
files = scssLint(tree, {
  config: '.config.yml'
});

var scssLint = require('broccoli-scss-lint');

// Save xml report
files = scssLint(tree, {
  format: 'xml',
  reportFile: 'scss-lint-report.xml'
});

Release History

0.0.4 - Added option bundleExec.
0.0.3 - Bugfixes.
0.0.2 - Added opportunity set format as array, fix bugs.
0.0.1 - First release

broccoli-scss-lint's Issues

Incompatible with Broccoli 0.16.4

SCSSLint.prototype.processString passes this.inputTree.tmpDestDir to lint(), but (I think) the correct API is this.tmpDestDir.

When I correct that, I see scss_lint doing some linting, but the next tree blows up because the broccoli-scss-lint tree didn't copy its inputs to its output directory.

The relevant portion of my Brocfile.js is

var scssLint = require('broccoli-scss-lint');
var sass = require('broccoli-sass');

var lintedSCSS = scssLint('scss', {
  config: 'scss/.scss-lint.yml',
  bundleExec: true
});

var css = sass(
  [ lintedSCSS ],
  'my-library/all.scss',
  'my-library/all.css'
);