Add maxWarnings option. Closes #17

Author: jwilsson

README.md

@@ -24,6 +24,8 @@ gulp.task('lint', () => {
 ## Options
 * `configPath`
     * Pass a path to a valid configuration file and stop lesshint from looking for a `.lesshintrc` file.
+* `maxWarnings`
+    * The maximum number of warnings to allow, before failing the task. Omit this option to always allow the task to pass.
 
 ## API
 * `lesshint.failOnError()`

index.js

@@ -8,12 +8,19 @@ const lesshintPlugin = (options) => {
     const lesshint = new Lesshint();
 
     options = options || {};
-    options = lesshint.getConfig(options.configPath);
 
-    lesshint.configure(options);
+    const config = lesshint.getConfig(options.configPath);
 
+    lesshint.configure(config);
+
+    let warningCount = 0;
+    let maxWarnings;
     let error;
 
+    if (options.maxWarnings) {
+        maxWarnings = parseInt(options.maxWarnings) || 0;
+    }
+
     return through.obj(function (file, enc, cb) {
         if (file.isStream()) {
             return cb(new PluginError('gulp-lesshint', 'Streaming not supported'));
@@ -27,6 +34,10 @@ const lesshintPlugin = (options) => {
             const contents = file.contents.toString();
             const results = lesshint.checkString(contents, file.path);
 
+            warningCount = results.reduce((sum, result) => {
+                return sum + (result.severity === 'warning' ? 1 : 0);
+            }, warningCount);
+
             file.lesshint = {
                 resultCount: results.length,
                 results,
@@ -44,6 +55,13 @@ const lesshintPlugin = (options) => {
             this.emit('error', new PluginError('gulp-lesshint', error, {
                 showStack: false,
             }));
+        } else if (warningCount > maxWarnings) {
+            const count = (warningCount === 1 ? 'warning' : 'warnings');
+            const message = `Failed with ${ warningCount } ${ count }. Maximum allowed is ${ options.maxWarnings }.`;
+
+            this.emit('error', new PluginError('gulp-lesshint', message, {
+                name: 'LesshintError'
+            }));
         }
 
         return cb();

test/test.js

@@ -175,6 +175,32 @@ describe('gulp-lesshint', () => {
         lintStream.end();
     });
 
+    it('should fail the task when the maximum number of warnings is exceeded.', (cb) => {
+        const stream = lesshint({
+            maxWarnings: 1
+        });
+
+        stream.on('error', (error) => {
+            assert.equal(error.message, 'Failed with 3 warnings. Maximum allowed is 1.');
+
+            cb();
+        });
+
+        stream.on('end', cb);
+
+        stream.write(new File({
+            base: __dirname,
+            path: __dirname + '/fixture.less',
+            contents: new Buffer(`
+                .foo {
+                    color: red !important;
+                }
+            `)
+        }));
+
+        stream.end();
+    });
+
     it('should ignore null files', () => {
         const stream = lesshint();