remove ability to pass JSCS config to jscs()

JSCS config should be in an external file so other tools can make use of it too.

fixes #70

Author: sindresorhus

.travis.yml

@@ -1,6 +1,6 @@
 sudo: false
 language: node_js
 node_js:
-  - 'iojs'
+  - 'stable'
   - '0.12'
   - '0.10'

index.js

@@ -2,43 +2,29 @@
 var path = require('path');
 var gutil = require('gulp-util');
 var through = require('through2');
+var tildify = require('tildify');
 var Checker = require('jscs');
 var loadConfigFile = require('jscs/lib/cli-config');
-var assign = require('object-assign');
-var tildify = require('tildify');
-
-module.exports = function (options) {
-	options = options || '.jscsrc';
-
-	if (typeof options === 'string') {
-		options = {configPath: options};
-	}
 
-	options = assign({}, options);
+module.exports = function (opts) {
+	opts = opts || {};
 
 	var checker = new Checker();
 
 	checker.registerDefaultRules();
 
-	var configPath = options.configPath;
-	var shouldFix = options.fix;
-
-	delete options.configPath;
-	delete options.fix;
+	try {
+		checker.configure(loadConfigFile.load(opts.configPath));
+	} catch (err) {
+		err.message = 'Unable to load JSCS config file';
 
-	if (configPath) {
-		if (typeof options === 'object' && Object.keys(options).length) {
-			throw new Error('configPath option is not compatible with code style options');
+		if (opts.configPath) {
+			err.message += ' at ' + tildify(path.resolve(opts.configPath));
 		}
 
-		try {
-			checker.configure(loadConfigFile.load(configPath));
-		} catch (err) {
-			err.message = 'Unable to load JSCS config file at ' + tildify(path.resolve(configPath)) + '\n' + err.message;
-			throw err;
-		}
-	} else {
-		checker.configure(options);
+		err.message += '\n' + err.message;
+
+		throw err;
 	}
 
 	return through.obj(function (file, enc, cb) {
@@ -61,7 +47,7 @@ module.exports = function (options) {
 		var errors;
 		var contents = file.contents.toString();
 
-		if (shouldFix) {
+		if (opts.fix) {
 			fixResults = checker.fixString(contents, file.relative);
 			errors = fixResults.errors;
 			file.contents = new Buffer(fixResults.output);

package.json

@@ -13,11 +13,11 @@
     "node": ">=0.10.0"
   },
   "scripts": {
-    "pretest": "jscs *.js reporters",
     "test": "xo && mocha"
   },
   "files": [
-    "index.js"
+    "index.js",
+    "reporters"
   ],
   "keywords": [
     "gulpplugin",
@@ -36,13 +36,13 @@
   "dependencies": {
     "gulp-util": "^3.0.4",
     "jscs": "^2.1.1",
-    "object-assign": "^4.0.1",
     "through2": "^2.0.0",
     "tildify": "^1.0.0"
   },
   "devDependencies": {
     "mocha": "*",
     "stream-assert": "^2.0.2",
+    "temp-write": "^1.1.2",
     "xo": "*"
   }
 }

readme.md

@@ -42,10 +42,26 @@ gulp.task('default', () => {
 });
 ```
 
+### Reporting & fixing & failing on lint error
+
+```js
+const gulp = require('gulp');
+const jscs = require('gulp-jscs');
+
+gulp.task('default', () => {
+	return gulp.src('src/app.js')
+		.pipe(jscs({fix: true}))
+		.pipe(jscs.reporter())
+		.pipe(jscs.reporter('fail'))
+		.pipe(gulp.dest('src'));
+});
+```
+
 
 ## Results
 
-A `jscs` object will be attached to the file object which can be used for custom error reporting. An example with one error might look like this:
+A `jscs` object will be attached to the file object.  
+An example with one error might look like this:
 
 ```js
 {
@@ -64,20 +80,39 @@ A `jscs` object will be attached to the file object which can be used for custom
 
 ## API
 
+JSCS [config](http://jscs.info/overview.html#options) should be placed in a `.jscsrc` file.
+
 ### jscs([options])
 
 #### options
 
-See the JSCS [options](http://jscs.info/overview.html#options).
+##### fix
+
+Type: `boolean`  
+Default: `false`
+
+Make JSCS attempt to auto-fix your files.  
+Be sure to pipe to `gulp.dest` if you use this option.
 
-Alternatively you can set the `configPath` *(default: `'.jscsrc'`)* option to the path of a [.jscsrc](http://jscs.info/rules.html) file.
+##### configPath
 
-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.
+Type: `string`  
+Default: JSCS will search for the config file up to your home directory.
+
+Set the path to the JSCS config file.  
+Only use this option when it can't be found automatically.
 
 ### jscs.reporter([reporter])
 
+#### reporter
+
+Type: `string`  
+Default: `console`
+
 See the JSCS [reporter docs](http://jscs.info/overview#-reporter-r) for supported input.
 
+Can be used multiple times in the same pipeline.
+
 This plugin also ships with some custom reporters:
 
 - `fail` - Emits an error at the end of the stream if there are lint errors.

test.js

@@ -4,6 +4,7 @@ var path = require('path');
 var assert = require('assert');
 var gutil = require('gulp-util');
 var streamAssert = require('stream-assert');
+var tempWrite = require('temp-write');
 var jscs = require('./');
 
 var stdoutWrite = process.stdout.write;
@@ -53,7 +54,9 @@ it('should check code style of JS files', function (cb) {
 });
 
 it('should check code style of JS files using a preset', function (cb) {
-	var stream = jscs({preset: 'google'});
+	var stream = jscs({
+		configPath: tempWrite.sync(JSON.stringify({preset: 'google'}))
+	});
 
 	stream
 		.pipe(streamAssert.first(function (file) {
@@ -126,8 +129,7 @@ it('should accept configPath options', function (cb) {
 
 it('should accept the fix option', function (cb) {
 	var stream = jscs({
-		fix: true,
-		configPath: '.jscsrc'
+		fix: true
 	});
 
 	stream.on('data', function (file) {
@@ -145,13 +147,6 @@ it('should accept the fix option', function (cb) {
 	stream.end();
 });
 
-it('should throw when passing both configPath and code style options', function () {
-	assert.throws(jscs.bind(null, {
-		configPath: '.jscsrc',
-		preset: 'airbnb'
-	}), /configPath/);
-});
-
 it('should not mutate the options object passed as argument', function () {
 	var options = {foo: true};
 	jscs(options);