Close PR #66: Add gulp-jshint-like reporters - fixes #21

Author: UltCombo

index.js

@@ -16,7 +16,6 @@ module.exports = function (options) {
 
 	options = assign({esnext: false}, options);
 
-	var out = [];
 	var checker = new Checker({esnext: !!options.esnext});
 
 	checker.registerDefaultRules();
@@ -59,48 +58,34 @@ module.exports = function (options) {
 			return;
 		}
 
-		try {
-			var fixResults;
-			var errors;
-			var contents = file.contents.toString();
-
-			if (shouldFix) {
-				fixResults = checker.fixString(contents, file.relative);
-				errors = fixResults.errors;
-				file.contents = new Buffer(fixResults.output);
-			} else {
-				errors = checker.checkString(contents, file.relative);
-			}
-
-			var errorList = errors.getErrorList();
-
-			file.jscs = {
-				success: true,
-				errorCount: 0,
-				errors: []
-			};
-
-			if (errorList.length > 0) {
-				file.jscs.success = false;
-				file.jscs.errorCount = errorList.length;
-				file.jscs.errors = errorList;
-			}
-
-			errorList.forEach(function (err) {
-				out.push(errors.explainError(err, true));
-			});
-		} catch (err) {
-			out.push(err.stack.replace('null:', file.relative + ':'));
+		var fixResults;
+		var errors;
+		var contents = file.contents.toString();
+
+		if (shouldFix) {
+			fixResults = checker.fixString(contents, file.relative);
+			errors = fixResults.errors;
+			file.contents = new Buffer(fixResults.output);
+		} else {
+			errors = checker.checkString(contents, file.relative);
 		}
 
-		cb(null, file);
-	}, function (cb) {
-		if (out.length > 0) {
-			this.emit('error', new gutil.PluginError('gulp-jscs', out.join('\n\n'), {
-				showStack: false
-			}));
+		var errorList = errors.getErrorList();
+
+		file.jscs = {
+			success: true,
+			errorCount: 0,
+			errors: []
+		};
+
+		if (errorList.length > 0) {
+			file.jscs.success = false;
+			file.jscs.errorCount = errorList.length;
+			file.jscs.errors = errors;
 		}
 
-		cb();
+		cb(null, file);
 	});
 };
+
+module.exports.reporter = require('./reporters');

package.json

@@ -13,7 +13,7 @@
     "node": ">=0.10.0"
   },
   "scripts": {
-    "pretest": "jscs *.js",
+    "pretest": "jscs *.js reporters",
     "test": "mocha"
   },
   "files": [
@@ -41,6 +41,7 @@
     "tildify": "^1.0.0"
   },
   "devDependencies": {
-    "mocha": "*"
+    "mocha": "*",
+    "stream-assert": "^2.0.2"
   }
 }

reporters/fail.js

@@ -0,0 +1,37 @@
+'use strict';
+var PluginError = require('gulp-util').PluginError;
+var through = require('through2');
+
+module.exports = function (failImmediately) {
+	// paths to files that failed JSCS
+	var fails = false;
+
+	return through.obj(function (file, enc, cb) {
+		var error = null;
+
+		// check for failure
+		if (file.jscs && !file.jscs.success) {
+			if (failImmediately) {
+				error = new PluginError('gulp-jscs', {
+					message: 'JSCS failed for: ' + file.path,
+					showStack: false
+				});
+			} else {
+				(fails = fails || []).push(file.path);
+			}
+		}
+
+		cb(error, file);
+	}, function (cb) {
+		if (!failImmediately && fails) {
+			// calling `cb(err)` would not emit the `end` event,
+			// so emit the error explicitly and call `cb()` afterwards.
+			this.emit('error', new PluginError('gulp-jscs', {
+				message: 'JSCS failed for: ' + fails.join(', '),
+				showStack: false
+			}));
+		}
+
+		cb();
+	});
+};

reporters/index.js

@@ -0,0 +1,26 @@
+'use strict';
+var PluginError = require('gulp-util').PluginError;
+var through = require('through2');
+var loadReporter = require('./loadReporter');
+var failReporter = require('./fail');
+
+module.exports = function (reporter) {
+	if (reporter === 'fail' || reporter === 'failImmediately') {
+		return failReporter(reporter === 'failImmediately');
+	}
+
+	var rpt = loadReporter(reporter);
+
+	if (typeof rpt !== 'function') {
+		throw new PluginError('gulp-jscs', 'Invalid reporter');
+	}
+
+	// return stream that reports stuff
+	return through.obj(function (file, enc, cb) {
+		if (file.jscs && !file.jscs.success) {
+			rpt([file.jscs.errors]);
+		}
+
+		cb(null, file);
+	});
+};

reporters/loadReporter.js

@@ -0,0 +1,10 @@
+'use strict';
+var getReporter = require('jscs/lib/cli-config').getReporter;
+
+module.exports = function (reporter) {
+	// we want the function
+	if (typeof reporter === 'function') return reporter;
+
+	// load JSCS built-in or absolute path or module reporters
+	return getReporter(reporter).writer;
+};