Close #81 PR: Support fix option.

Author: rniemeyer

index.js

@@ -22,8 +22,11 @@ module.exports = function (options) {
 	checker.registerDefaultRules();
 
 	var configPath = options.configPath;
+	var shouldFix = options.fix;
+
 	delete options.esnext;
 	delete options.configPath;
+	delete options.fix;
 
 	if (configPath) {
 		if (typeof options === 'object' && Object.keys(options).length) {
@@ -57,7 +60,18 @@ module.exports = function (options) {
 		}
 
 		try {
-			var errors = checker.checkString(file.contents.toString(), 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);
+			}
+
 			var errorList = errors.getErrorList();
 
 			file.jscs = {

readme.md

@@ -16,6 +16,8 @@ $ npm install --save-dev gulp-jscs
 
 ## Usage
 
+### Reporting Only
+
 ```js
 var gulp = require('gulp');
 var jscs = require('gulp-jscs');
@@ -26,6 +28,20 @@ gulp.task('default', function () {
 });
 ```
 
+### Fixing and Reporting
+
+```js
+var gulp = require('gulp');
+var jscs = require('gulp-jscs');
+
+gulp.task('default', function () {
+	return gulp.src('src/app.js')
+		.pipe(jscs({
+			fix: true
+		}))
+		.pipe(gulp.dest('src'));
+});
+```
 
 ## Results
 
@@ -61,6 +77,8 @@ Alternatively you can set the `configPath` *(default: `'.jscsrc'`)* option to th
 Set `esnext: true` if you want your code to be parsed as ES6 using the harmony
 version of the esprima parser.
 
+Set `fix: true` if you want jscs to attempt to auto-fix your files. Be sure to pipe to `gulp.dest` if you use this option.
+
 
 ## License
 

test.js

@@ -107,6 +107,29 @@ it('should accept both esnext and configPath options', function(cb) {
 	stream.end();
 });
 
+it('should accept the fix option', function (cb) {
+	var data = '';
+
+	var stream = jscs({
+		fix: true,
+		configPath: '.jscsrc'
+	});
+
+	stream.on('data', function (file) {
+		assert.equal(file.contents.toString(), 'var x = {a: 1, b: 2}');
+	});
+
+	stream.on('end', cb);
+
+	stream.write(new gutil.File({
+		base: __dirname,
+		path: __dirname + '/fixture.js',
+		contents: new Buffer('var x = { a: 1, b: 2 }')
+	}));
+
+	stream.end();
+});
+
 it('should throw when passing both configPath and code style options', function () {
 	assert.throws(jscs.bind(null, {
 		configPath: '.jscsrc',