feat(config): config through rc file, has precedence over package.json (

#62)

.vcmrc

@@ -0,0 +1,17 @@
+{
+  "helpMessage": "\nPlease fix your commit message (and consider using http://npm.im/commitizen)\n",
+  "types": [
+    "feat",
+    "fix",
+    "docs",
+    "style",
+    "refactor",
+    "perf",
+    "test",
+    "chore",
+    "revert",
+    "custom"
+  ],
+  "warnOnFail": false,
+  "autoFix": false
+}

README.md

@@ -29,7 +29,21 @@ Validates that your commit message follows this format:
 
 ### options
 
-You can specify options in `package.json`
+You can specify options in `.vcmrc`
+
+```js
+{
+  "types": ["feat", "fix", "docs", "style", "refactor", "perf", "test", "chore", "revert"], // default
+  "warnOnFail": false, // default
+  "maxSubjectLength": 100, // default
+  "subjectPattern": ".+", // default
+  "subjectPatternErrorMsg": "subject does not match subject pattern!", // default
+  "helpMessage": "", // default
+  "autoFix": false // default
+}
+```
+
+or in `package.json`
 
 ```javascript
 {
@@ -47,6 +61,8 @@ You can specify options in `package.json`
 }
 ```
 
+`.vcmrc` has precedence, if it does not exist, then `package.json` will be used.
+
 #### types
 
 These are the types that are allowed for your commit message. If omitted, the value is what is shown above.

lib/config.js

@@ -0,0 +1,34 @@
+'use strict';
+
+var findup = require('findup');
+var fs = require('fs');
+var resolve = require('path').resolve;
+
+function getConfigObject(filename) {
+  try {
+    var rcFile = findup.sync(process.cwd(), filename);
+    return JSON.parse(fs.readFileSync(resolve(rcFile, filename)));
+  } catch (e) {
+    return null;
+  }
+}
+
+function getRcConfig() {
+  return getConfigObject('.vcmrc');
+}
+
+function getPackageConfig() {
+  var configObject = getConfigObject('package.json');
+  return configObject && configObject.config && configObject.config['validate-commit-msg'];
+}
+
+function getConfig() {
+  return getRcConfig() || getPackageConfig() || {};
+}
+
+module.exports = {
+  getConfig: getConfig,
+  getRcConfig: getRcConfig,
+  getPackageConfig: getPackageConfig,
+  getConfigObject: getConfigObject
+};

lib/validateMessage.js

@@ -2,7 +2,7 @@
 
 var util = require('util');
 var semverRegex = require('semver-regex');
-var getConfig = require('./getConfig');
+var getConfig = require('./config').getConfig;
 
 var config = getConfig();
 var MAX_LENGTH = config.maxSubjectLength || 100;

test/config.test.js

@@ -0,0 +1,86 @@
+'use strict';
+
+var config = require('../lib/config');
+var expect = require('chai').expect;
+var sinon = require('sinon');
+var fs = require('fs');
+
+function testConfigObject(configObject) {
+  expect(configObject.helpMessage).to.contain('fix your commit');
+}
+
+describe('config', function() {
+  before(function() {
+    sinon.stub(fs, 'readFileSync', function() {
+      return JSON.stringify({
+        config: {
+          'validate-commit-msg': {
+            helpMessage: 'fix your commit'
+          }
+        }
+      });
+    });
+  });
+
+  describe('getPackageConfig', function() {
+    it('returns the validate-commit-msg config object if it exists', function() {
+      var configObject = config.getPackageConfig();
+      testConfigObject(configObject);
+    });
+  });
+
+  describe('getRcConfig', function() {
+    it('returns the config object if it exists', function() {
+      fs.readFileSync.restore();
+      sinon.stub(fs, 'readFileSync', function() {
+        return JSON.stringify({
+          helpMessage: 'fix your commit'
+        });
+      });
+      var configObject = config.getRcConfig();
+      testConfigObject(configObject);
+    });
+  });
+
+  describe('getConfig', function() {
+    it('returns .vcmrc config by default', function() {
+      var configObject = config.getConfig();
+      testConfigObject(configObject);
+    });
+
+    it('spec name', function() {
+      sinon.stub(config, 'getRcConfig', function() {
+        throw null;
+      });
+      var configObject = config.getConfig();
+      testConfigObject(configObject);
+      config.getRcConfig.restore();
+    });
+  });
+
+  describe('getConfigObject', function() {
+    it('returns config object given filename', function() {
+      fs.readFileSync.restore();
+      sinon.stub(fs, 'readFileSync', function() {
+        return JSON.stringify({
+          helpMessage: 'fix your commit'
+        });
+      });
+      var configObject = config.getConfigObject('package.json');
+      expect(configObject.helpMessage).to.equal('fix your commit');
+    });
+
+    it('returns null on error', function() {
+      fs.readFileSync.restore();
+      sinon.stub(fs, 'readFileSync', function() {
+        throw new Error();
+      });
+      var configObject = config.getConfigObject('package.json');
+      expect(configObject).to.equal(null);
+    });
+  });
+
+  after(function() {
+    fs.readFileSync.restore();
+  });
+});

wallaby.config.js

@@ -1,6 +1,6 @@
 module.exports = function() {
   return {
-    files: ['lib/**/*.js', 'package.json'],
+    files: ['lib/**/*.js', 'package.json', '.vcmrc'],
     tests: ['test/**/*.js'],
     env: {
       type: 'node'