Add ability to use built in formatters

Also remove the built in one

Fixes #1

Author: SimenB

README.md

@@ -66,7 +66,20 @@ file.csslint.results = []; // CSSLint errors
 file.csslint.opt = {}; // The options you passed to CSSLint
 ```
 
-## Custom Reporters
+## Using reporters
+
+Several reporters come built-in to css-lint. To use one of these reporters, pass the name to `csslint.reporter`.
+
+For a list of all reporters supported by `csslint`, see the [csslint wiki](https://github.com/CSSLint/csslint/wiki/Command-line-interface#--format).
+
+```js
+gulp.task('lint', function() {
+  gulp.files('lib/*.css')
+    .pipe(csslint())
+    .pipe(csslint.reporter('junit-xml'));
+```
+
+### Custom Reporters
 
 Custom reporter functions can be passed as `csslint.reporter(reporterFunc)`. The reporter function will be called for each linted file and passed the file object as described above.
 
@@ -118,7 +131,7 @@ gulp.task('lint', function() {
   gulp.files('lib/*.css')
     .pipe(csslint())
     .pipe(csslint.reporter()) // Display errors
-    .pipe(csslint.failReporter()); // Fail on error
+    .pipe(csslint.reporter('fail')); // Fail on error (or csslint.failReporter())
 });
 ```
 

index.js

@@ -1,11 +1,8 @@
-/*jshint node:true */
-
 'use strict';
 
 var gutil = require('gulp-util');
-var c = gutil.colors;
 var error = gutil.PluginError;
-var es = require('event-stream');
+var through = require('through2');
 var csslint = require('csslint').CSSLint;
 var RcLoader = require('rcloader');
 
@@ -26,14 +23,13 @@ var formatOutput = function(report, file, options) {
     return err;
   });
 
-  var output = {
+  return {
+    originalReport: report,
     errorCount: results.length,
     success: false,
     results: results,
     options: options
   };
-
-  return output;
 };
 
 var cssLintPlugin = function(options) {
@@ -48,11 +44,11 @@ var cssLintPlugin = function(options) {
     ruleset[rule.id] = 1;
   });
 
-  return es.map(function(file, cb) {
+  return through.obj(function(file, enc, cb) {
     if (file.isNull()) return cb(null, file); // pass along
-    if (file.isStream()) return cb(new error('gulp-csslint: Streaming not supported'));
+    if (file.isStream()) return cb(new error('gulp-csslint: Streaming not supported'), file);
 
-    var content = file.contents.toString('utf8');
+    var content = file.contents.toString(enc);
 
     if (!content) return cb(null, file); // pass along
 
@@ -79,47 +75,47 @@ var cssLintPlugin = function(options) {
   });
 };
 
-var defaultReporter = function(file) {
-  var errorCount = file.csslint.errorCount;
-  var plural = errorCount === 1 ? '' : 's';
-
-  gutil.log(c.cyan(errorCount)+' error'+plural+' found in '+c.magenta(file.path));
-
-  file.csslint.results.forEach(function(result) {
-    var message = result.error;
-    gutil.log(
-      c.red('[') +
-      (
-        typeof message.line !== 'undefined' ?
-          c.yellow( 'L' + message.line ) +
-          c.red(':') +
-          c.yellow( 'C' + message.col )
-        :
-          c.yellow('GENERAL')
-      ) +
-      c.red('] ') +
-      message.message + ' ' + message.rule.desc + ' (' + message.rule.id + ')');
-  });
-};
-
 cssLintPlugin.reporter = function(customReporter) {
-  var reporter = defaultReporter;
+  var reporter = csslint.getFormatter('text'), builtInReporter = true, output;
 
   if (typeof customReporter === 'function') {
     reporter = customReporter;
+    builtInReporter = false;
+  } else if (typeof customReporter === 'string') {
+    if (customReporter === 'fail') {
+      return cssLintPlugin.failReporter();
+    }
+
+    reporter = csslint.getFormatter(customReporter);
   }
 
   if (typeof reporter === 'undefined') {
     throw new Error('Invalid reporter');
   }
 
-  return es.map(function(file, cb) {
+  if (builtInReporter) {
+    output = reporter.startFormat();
+  }
+
+  return through.obj(function(file, enc, cb) {
     // Only report if CSSLint was ran and errors were found
     if (file.csslint && !file.csslint.success) {
-      reporter(file);
+      if (builtInReporter) {
+        output += reporter.formatResults(file.csslint.originalReport, file.path);
+      } else {
+        reporter(file);
+      }
     }
 
     return cb(null, file);
+  }, function(cb) {
+    if (builtInReporter) {
+      output += reporter.endFormat();
+
+      gutil.log(output);
+    }
+
+    return cb();
   });
 };
 
@@ -131,7 +127,7 @@ cssLintPlugin.addRule = function(rule) {
 };
 
 cssLintPlugin.failReporter = function() {
-  return es.map(function(file, cb) {
+  return through.obj(function(file, enc, cb) {
     // Nothing to report or no errors
     if (!file.csslint || file.csslint.success) {
       return cb(null, file);

package.json

@@ -8,9 +8,9 @@
   ],
   "dependencies": {
     "csslint": "^0.10.0",
-    "event-stream": "^3.3.1",
     "gulp-util": "^3.0.4",
-    "rcloader": "^0.1.4"
+    "rcloader": "^0.1.4",
+    "through2": "^2.0.0"
   },
   "devDependencies": {
     "coveralls": "^2.11.2",
@@ -19,7 +19,8 @@
     "jshint": "^2.7.0",
     "mocha": "^2.2.5",
     "rimraf": "^2.3.4",
-    "should": "^6.0.3"
+    "should": "^7.0.3",
+    "sinon": "^1.15.4"
   },
   "scripts": {
     "clean": "rimraf coverage/",

test/main.js

@@ -1,9 +1,11 @@
+/*jshint expr: true*/
+
 var cssLintPlugin = require('../');
 var should = require('should');
 var gutil = require('gulp-util');
 var fs = require('fs');
 var path = require('path');
-require('mocha');
+var sinon = require('sinon');
 
 var getFile = function(filePath) {
   filePath = 'test/'+filePath;
@@ -243,5 +245,41 @@ describe('gulp-csslint', function() {
       stream.write(file);
       stream.end();
     });
+
+    it('should use built-in formatter', sinon.test(function(done) {
+      var a = 0;
+
+      var file = getFile('fixtures/usingImportant.css');
+
+      var lintStream = cssLintPlugin();
+      var reporterStream = cssLintPlugin.reporter('checkstyle-xml');
+
+      sinon.stub(gutil, 'log');
+
+      reporterStream.on('data', function() {
+        ++a;
+      });
+      lintStream.on('data', function(file) {
+        reporterStream.write(file);
+      });
+      lintStream.once('end', function() {
+        reporterStream.end();
+      });
+
+      reporterStream.once('end', function() {
+        a.should.equal(1);
+        sinon.assert.calledOnce(gutil.log, 'asdasd');
+        sinon.assert.calledWith(gutil.log, '<?xml version="1.0" encoding="utf-8"?><checkstyle><file ' +
+          'name="test/fixtures/usingImportant.css"><error line="2" column="1" severity="warning" ' +
+          'message="Bad naming: .mybox" source="net.csslint.OOCSS"/><error line="3" column="3" severity="warning" ' +
+          'message="Use of !important" source="net.csslint.Disallow!important"/></file></checkstyle>');
+
+        gutil.log.restore();
+        done();
+      });
+
+      lintStream.write(file);
+      lintStream.end();
+    }));
   });
 });