feat(config): use npm config object, deprecate czConfig

Npm is generous enough to give us a config object. We should use it. This change is not breaking but
sets up 3.0.0 to be breaking by adding a deprecation warning to any repos using the old style of
config. czConfig will be removed in 3.0.0. From now on, commitizen init now uses the new config as
its default. Adds additional tests and docs as well

Closes #30

Author: jimthedev

README.md

@@ -40,17 +40,21 @@ commitizen init cz-conventional-changelog --save --save-exact
 
 Note that if you want to force install over the top of an old adapter, you can apply the `--force` argument. For more information on this, just run `commitizen help`.
 
-Then just add the `czConfig` field to the root of your **package.json** with the following contents:
+Then just add the `config.commitizen` key to the root of your **package.json** as shown here:
 
 ```json
 ...
-  "czConfig": {
-    "path": "node_modules/cz-conventional-changelog"
+  "config": {
+    "commitizen": {
+      "path": "node_modules/cz-conventional-changelog"
+    }
   }
 ```
 
 This just tells Commitizen which adapter we actually want our contributors to use when they try to commit to this repo.
 
+Please note that in previous version of Commitizen we used czConfig. **czConfig has been deprecated** and you should migrate to the new format before Commitizen 3.0.0.
+
 #### Congratulations your repo is Commitizen-friendly. Time to flaunt it!
 
 Add the Commitizen-friendly badge to your README using the following markdown:

package.json

@@ -12,10 +12,10 @@
     "test": "istanbul cover -x ./test _mocha -- -R spec test/tests/index.js --compilers js:babel/register",
     "test:watch": "nodemon -q --ignore test/.tmp/ --ignore test/artifacts/ --ignore coverage/ --exec \"npm run test\" --"
   },
-  "czConfig": {
-    "path": "./node_modules/cz-conventional-changelog"
-  },
   "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"  
+    },
     "ghooks": {
       "pre-commit": "npm run test && npm run check-coverage"
     }

src/commitizen/adapter.js

@@ -5,7 +5,6 @@ import findNodeModules from 'find-node-modules';
 import {isFunction} from '../../common/util';
 
 export {
-  addAdapterConfigToPackageJson,
   addPathToAdapterConfig,
   getNearestNodeModulesDirectory,
   getNearestProjectRootDirectory,
@@ -25,20 +24,12 @@ export {
  */
 
 /**
- * Modifies the package.json, sets key czConfig to an empty object
- */
-function addAdapterConfigToPackageJson(sh, cliPath, repoPath) {
-  let packageJsonPath = path.join(getNearestProjectRootDirectory(),'package.json');
-  sh.exec(`${cliPath}/node_modules/.bin/json -I -f ${packageJsonPath} -e 'this.czConfig={}'`);
-}
-
-/**
- * Modifies the package.json, sets czConfig.path to the path of the adapter
+ * Modifies the package.json, sets config.commitizen.path to the path of the adapter
  * Must be passed an absolute path to the cli's root
  */
 function addPathToAdapterConfig(sh, cliPath, repoPath, adapterNpmName) {
   let packageJsonPath = path.join(getNearestProjectRootDirectory(), 'package.json');
-  sh.exec(`${cliPath}/node_modules/.bin/json -I -f ${packageJsonPath} -e 'this.czConfig.path=\"./node_modules/${adapterNpmName}\"'`);
+  sh.exec(`${cliPath}/node_modules/.bin/json -I -f ${packageJsonPath} -e 'if(!this.config) {this.config={};}; if(!this.config.commitizen) { this.config.commitizen={};}; this.config.commitizen.path=\"./node_modules/${adapterNpmName}\"'`);
 }
 
 /**
@@ -115,7 +106,6 @@ function getPrompter(adapterPath) {
  * return a located adapter path or will throw.
  */
 function resolveAdapterPath(inboundAdapterPath) {
-  
   let outboundAdapterPath;
 
   // Try to open the provided path
@@ -135,8 +125,7 @@ function resolveAdapterPath(inboundAdapterPath) {
     return outboundAdapterPath;
 
   } catch(err) {
-    console.error('Adapter path invalid: ' + inboundAdapterPath);
-    throw (err);
+    throw err;
   }
 
 }

src/commitizen/configLoader.js

@@ -1,132 +1,10 @@
+import {loader} from '../configLoader';
 
-/**
- * Command line config helpers
- * Shamelessly ripped from with slight modifications: 
- * https://github.com/jscs-dev/node-jscs/blob/master/lib/cli-config.js
- */
-
-var fs = require('fs');
-var path = require('path');
-
-var stripJSONComments = require('strip-json-comments');
-var supportsColor = require('chalk').supportsColor;
-var glob = require('glob');
+export { load };
 
 // Configuration sources in priority order.
 var configs = ['package.json', '.czrc', '.cz.json'];
 
-// Before, "findup-sync" package was used,
-// but it does not provide filter callback
-function findup(patterns, options, fn) {
-    /* jshint -W083 */
-
-    var lastpath;
-    var file;
-
-    options = Object.create(options);
-    options.maxDepth = 1;
-    options.cwd = path.resolve(options.cwd);
-
-    do {
-        file = patterns.filter(function(pattern) {
-            var configPath = glob.sync(pattern, options)[0];
-
-            if (configPath) {
-                return fn(path.join(options.cwd, configPath));
-            }
-        })[0];
-
-        if (file) {
-            return path.join(options.cwd, file);
-        }
-
-        lastpath = options.cwd;
-        options.cwd = path.resolve(options.cwd, '..');
-    } while (options.cwd !== lastpath);
-}
-
-/**
- * Get content of the configuration file
- * @param {String} config - partial path to configuration file
- * @param {String} directory - directory path which will be joined with config argument
- * @return {Object}
- */
-exports.getContent = function(config, directory) {
-    if (!config) {
-        return;
-    }
-
-    var configPath = path.resolve(directory, config);
-    var ext;
-    var content;
-
-    config = path.basename(config);
-
-    if (fs.existsSync(configPath)) {
-        ext = path.extname(configPath);
-
-        if (ext === '.js' || ext === '.json') {
-            content = JSON.parse(fs.readFileSync(configPath, 'utf8'));
-        } else {
-            content = JSON.parse(
-                stripJSONComments(
-                    fs.readFileSync(configPath, 'utf8')
-                )
-            );
-        }
-
-        // Adding property via Object.defineProperty makes it
-        // non-enumerable and avoids warning for unsupported rules
-        Object.defineProperty(content, 'configPath', {
-            value: configPath
-        });
-    }
-
-    return content && config === 'package.json' ? content.czConfig : content;
-};
-
-/**
- * Get content of the configuration file
- * @param {String} config - partial path to configuration file
- * @param {String} [cwd = process.cwd()] - directory path which will be joined with config argument
- * @return {Object|undefined}
- */
-exports.load = function(config, cwd) {
-    var content;
-    var directory = cwd || process.cwd();
-
-    // If config option is given, attempt to load it
-    if (config) {
-        return this.getContent(config, directory);
-    }
-
-    content = this.getContent(
-        findup(configs, { nocase: true, cwd: directory }, function(configPath) {
-            if (path.basename(configPath) === 'package.json') { 
-                // return !!this.getContent(configPath);
-            }
-
-            return true;
-        }.bind(this))
-    );
-
-    if (content) {
-        return content;
-    }
-
-    // Try to load standard configs from home dir
-    var directoryArr = [process.env.USERPROFILE, process.env.HOMEPATH, process.env.HOME];
-    for (var i = 0, dirLen = directoryArr.length; i < dirLen; i++) {
-        if (!directoryArr[i]) {
-            continue;
-        }
-
-        for (var j = 0, len = configs.length; j < len; j++) {
-            content = this.getContent(configs[j], directoryArr[i]);
-
-            if (content) {
-                return content;
-            }
-        }
-    }
-};
+function load(config, cwd) {
+  return loader(configs, config, cwd);
+}

src/commitizen/init.js

@@ -4,7 +4,6 @@ import {executeShellCommand} from '../../common/util';
 import * as adapter from './adapter';
 
 let {
-  addAdapterConfigToPackageJson, 
   addPathToAdapterConfig,
   generateNpmInstallAdapterCommand,
   getNpmInstallStringMappings
@@ -39,7 +38,7 @@ const defaultInitOptions = {
 };
 
 /**
- * Runs npm install for the adapter then modifies the czConfig as needed
+ * Runs npm install for the adapter then modifies the config.commitizen as needed
  */
 function init(sh, repoPath, adapterNpmName, {
   save = false, 
@@ -95,7 +94,6 @@ function init(sh, repoPath, adapterNpmName, {
     try {
 
       executeShellCommand(sh, repoPath, installAdapterCommand);
-      addAdapterConfigToPackageJson(sh, CLI_PATH, repoPath);
       addPathToAdapterConfig(sh, CLI_PATH, repoPath, adapterNpmName);
     } catch (e) {
       console.error(e);
@@ -121,7 +119,7 @@ function checkRequiredArguments(sh, path, adapterNpmName) {
 
 /**
  * CONFIG
- * Loads and returns the adapter config at key czConfig, if it exists
+ * Loads and returns the adapter config at key config.commitizen, if it exists
  */
 function loadAdapterConfig() {
   let config = configLoader.load();

src/configLoader.js

@@ -0,0 +1,11 @@
+import findup from './configLoader/findup';
+import getContent from './configLoader/getContent';
+import getNormalizedConfig from './configLoader/getNormalizedConfig';
+import loader from './configLoader/loader';
+
+export {
+  findup,
+  getContent,
+  getNormalizedConfig,
+  loader
+};

src/configLoader/findup.js

@@ -0,0 +1,34 @@
+import path from 'path';
+import glob from 'glob';
+
+export default findup;
+
+// Before, "findup-sync" package was used,
+// but it does not provide filter callback
+function findup(patterns, options, fn) {
+    /* jshint -W083 */
+
+    var lastpath;
+    var file;
+
+    options = Object.create(options);
+    options.maxDepth = 1;
+    options.cwd = path.resolve(options.cwd);
+
+    do {
+        file = patterns.filter(function(pattern) {
+            var configPath = glob.sync(pattern, options)[0];
+
+            if (configPath) {
+                return fn(path.join(options.cwd, configPath));
+            }
+        })[0];
+
+        if (file) {
+            return path.join(options.cwd, file);
+        }
+
+        lastpath = options.cwd;
+        options.cwd = path.resolve(options.cwd, '..');
+    } while (options.cwd !== lastpath);
+}

src/configLoader/getContent.js

@@ -0,0 +1,47 @@
+import fs from 'fs';
+import path from 'path';
+import stripJSONComments from 'strip-json-comments';
+
+import {getNormalizedConfig} from '../configLoader';
+
+export default getContent;
+
+/**
+ * Get content of the configuration file
+ * @param {String} config - partial path to configuration file
+ * @param {String} directory - directory path which will be joined with config argument
+ * @return {Object}
+ */
+function getContent(config, directory) {
+    if (!config) {
+        return;
+    }
+
+    var configPath = path.resolve(directory, config);
+    var ext;
+    var content;
+
+    config = path.basename(config);
+
+    if (fs.existsSync(configPath)) {
+        ext = path.extname(configPath);
+
+        if (ext === '.js' || ext === '.json') {
+            content = JSON.parse(fs.readFileSync(configPath, 'utf8'));
+        } else {
+            content = JSON.parse(
+                stripJSONComments(
+                    fs.readFileSync(configPath, 'utf8')
+                )
+            );
+        }
+
+        // Adding property via Object.defineProperty makes it
+        // non-enumerable and avoids warning for unsupported rules
+        Object.defineProperty(content, 'configPath', {
+            value: configPath
+        });
+    }
+    return getNormalizedConfig(config, content);
+    
+};

src/configLoader/getNormalizedConfig.js

@@ -0,0 +1,29 @@
+export default getNormalizedConfig;
+
+// Given a config and content, plucks the actual
+// settings that we're interested in
+function getNormalizedConfig(config, content) {
+  
+  if(content && (config == 'package.json')) {
+
+  // PACKAGE.JSON
+
+    // Use the npm config key, be good citizens
+    if(content.config && content.config.commitizen) {
+      return content.config.commitizen;
+    } else {
+      
+      // Old method, will be deprecated in 3.0.0
+      if(typeof global.it !== 'function')
+      {
+        console.error("\n********\nWARNING: You are using czConfig in your package.json. czConfig will be deprecated in Commitizen 3. \nPlease use this instead:\n{\n  \"config\": {\n    \"commitizen\": {\n      \"path\": \"./path/to/adapter\"\n    }\n  }\n}\nFor more information, see: http://commitizen.github.io/cz-cli/\n********\n"); 
+      }
+      return content.czConfig;
+    }
+    
+  } else {
+    // .cz.json or .czrc 
+    return content;
+  }
+    
+}