V3.x

.travis.yml

@@ -13,7 +13,6 @@ node_js:
 - '6'
 - '5'
 - '4'
-- '0.12'
 before_install:
 - git config --global user.name "TravisCI"
 - git config --global user.email "[email protected]"

README.md

@@ -90,7 +90,7 @@ This just tells Commitizen which adapter we actually want our contributors to us
 *  full relative file names
 *  absolute paths.
 
-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.
+Please note that in previous version of Commitizen we used czConfig. **czConfig has been removed** from Commitizen 3.0.0.
 
 #### Optional: Install and run Commitizen locally
 

package.json

@@ -8,6 +8,7 @@
     "commit": "node bin/git-cz",
     "build": "babel src --out-dir dist",
     "build:watch": "babel --watch src --out-dir dist",
+    "precommit": "npm run lint && npm run test && npm run check-coverage",
     "prepublish": "not-in-install && npm run build || true",
     "report-coverage": "nyc report --reporter=lcov | codecov",
     "write-coverage": "nyc report --reporter=lcov",
@@ -21,9 +22,6 @@
   "config": {
     "commitizen": {
       "path": "./node_modules/cz-conventional-changelog"
-    },
-    "ghooks": {
-      "pre-commit": "npm run lint && npm run test && npm run check-coverage"
     }
   },
   "homepage": "https://github.com/commitizen/cz-cli",
@@ -60,7 +58,7 @@
     "eslint-config-standard": "6.2.1",
     "eslint-plugin-promise": "3.4.0",
     "eslint-plugin-standard": "2.0.1",
-    "ghooks": "1.3.2",
+    "husky": "0.12.0",
     "in-publish": "^2.0.0",
     "mocha": "3.1.2",
     "node-uuid": "1.4.7",
@@ -77,6 +75,7 @@
     "cz-conventional-changelog": "1.2.0",
     "dedent": "0.6.0",
     "detect-indent": "4.0.0",
+    "execa": "0.5.1",
     "find-node-modules": "1.0.4",
     "find-root": "1.0.0",
     "fs-extra": "^1.0.0",
@@ -85,6 +84,7 @@
     "lodash": "4.17.2",
     "minimist": "1.2.0",
     "path-exists": "2.1.0",
+    "pify": "2.3.0",
     "shelljs": "0.7.5",
     "strip-json-comments": "2.0.1"
   },
@@ -102,6 +102,6 @@
   },
   "engineStrict": true,
   "engines": {
-    "node": ">= 0.12"
+    "node": ">= 4"
   }
 }

src/cli/strategies/git-cz.js

@@ -60,16 +60,20 @@ function gitCz (rawGitArgs, environment, adapterConfig) {
     let adapterPackageJson = getParsedPackageJsonFromPath(resolvedAdapterRootPath);
     let cliPackageJson = getParsedPackageJsonFromPath(environment.cliPath);
     console.log(`cz-cli@${cliPackageJson.version}, ${adapterPackageJson.name}@${adapterPackageJson.version}\n`);
-    commit(sh, inquirer, process.cwd(), prompter, {
+    commit(inquirer, process.cwd(), prompter, {
       args: parsedGitCzArgs,
       disableAppendPaths: true,
       emitData: true,
       quiet: false,
       retryLastCommit
-    }, function (error) {
-      if (error) {
-        throw error;
-      }
+    }).catch(function (error) {
+      //
+      // Throw in next tick to use Node.js built in error handling
+      //
+      // FIXME: This should probably be refactored so that this
+      //        function returns a rejected promise instead...
+      //
+      process.nextTick(function () { throw error; });
     });
   });
 

src/commitizen/adapter.js

@@ -3,7 +3,7 @@ import fs from 'fs';
 import findNodeModules from 'find-node-modules';
 import _ from 'lodash';
 import detectIndent from 'detect-indent';
-import sh from 'shelljs';
+import execa from 'execa';
 
 import {isFunction} from '../common/util';
 
@@ -150,5 +150,5 @@ function resolveAdapterPath (inboundAdapterPath) {
 }
 
 function getGitRootPath () {
-  return sh.exec('git rev-parse --show-toplevel').stdout.trim();
+  return execa.sync('git', ['rev-parse', '--show-toplevel']).stdout.trim();
 }

src/commitizen/commit.js

@@ -1,5 +1,7 @@
 import path from 'path';
+import {deprecate} from 'util';
 
+import pify from 'pify';
 import dedent from 'dedent';
 import cacheDir from 'cachedir';
 import {ensureDir} from 'fs-extra';
@@ -8,62 +10,51 @@ import * as cache from './cache';
 
 export default commit;
 
-/**
- * Takes all of the final inputs needed in order to make dispatch a git commit
- */
-function dispatchGitCommit (sh, repoPath, template, options, overrideOptions, done) {
-    // Commit the user input -- side effect that we'll test
-    gitCommit(sh, repoPath, template, { ...options, ...overrideOptions }, function (error) {
-      done(error, template);
+function askUser (inquirer, prompter) {
+  return new Promise(function (resolve, reject) {
+    const decoratedInquirer = {
+      prompt: deprecate(inquirer.prompt, 'Using the supplied copy of inquirer is depreacted, please depend on inquirer directly').bind(inquirer)
+    }
+
+    prompter(decoratedInquirer, function (arg0, arg1) {
+      // Allow adapters to error out by providing an Error
+      if (arg0 instanceof Error) {
+        return reject(arg0);
+      }
+
+      resolve({ template: arg0, overrideOptions: arg1 });
     });
+  });
 }
 
  /**
   * Asynchronously commits files using commitizen
   */
-function commit (sh, inquirer, repoPath, prompter, options, done) {
+function commit (inquirer, repoPath, prompter, options) {
   var cacheDirectory = cacheDir('commitizen');
   var cachePath = path.join(cacheDirectory, 'commitizen.json');
 
-  ensureDir(cacheDirectory, function (error) {
-    if (error) {
-      console.error("Couldn't create commitizen cache directory: ", error);
-      // TODO: properly handle error?
-    } else {
-      if (options.retryLastCommit) {
+  return pify(ensureDir)(cacheDirectory).then(function () {
+    if (options.retryLastCommit) {
+      console.log('Retrying last commit attempt.');
 
-        console.log('Retrying last commit attempt.');
+      // We want to use the last commit instead of the current commit,
+      // so lets override some options using the values from cache.
+      let {
+        options: retryOptions,
+        overrideOptions: retryOverrideOptions,
+        template: retryTemplate
+      } = cache.getCacheValueSync(cachePath, repoPath);
 
-        // We want to use the last commit instead of the current commit,
-        // so lets override some options using the values from cache.
-        let {
-          options: retryOptions,
-          overrideOptions: retryOverrideOptions,
-          template: retryTemplate
-        } = cache.getCacheValueSync(cachePath, repoPath);
-        dispatchGitCommit(sh, repoPath, retryTemplate, retryOptions, retryOverrideOptions, done);
-
-      } else {
-        // Get user input -- side effect that is hard to test
-        prompter(inquirer, function (error, template, overrideOptions) {
-          // Allow adapters to error out
-          // (error: Error?, template: String, overrideOptions: Object)
-          if (!(error instanceof Error)) {
-            overrideOptions = template;
-            template = error;
-            error = null;
-          }
+      return gitCommit(repoPath, retryTemplate, { ...retryOptions, ...retryOverrideOptions });
+    }
 
-          if (error) {
-            return done(error);
-          }
+    // Get user input -- side effect that is hard to test
+    return askUser(inquirer, prompter).then(function ({ template, overrideOptions }) {
+      // We don't want to add retries to the cache, only actual commands
+      cache.setCacheValueSync(cachePath, repoPath, { template, options, overrideOptions });
 
-          // We don't want to add retries to the cache, only actual commands
-          cache.setCacheValueSync(cachePath, repoPath, { template, options, overrideOptions });
-          dispatchGitCommit(sh, repoPath, template, options, overrideOptions, done);
-        });
-      }
-    }
+      return gitCommit(repoPath, template, { ...options, ...overrideOptions });
+    });
   });
-
 }

src/configLoader/getNormalizedConfig.js

@@ -11,14 +11,6 @@ function getNormalizedConfig (config, content) {
     // Use the npm config key, be good citizens
     if (content.config && content.config.commitizen) {
       return content.config.commitizen;
-    } else if (content.czConfig) { // Old method, will be deprecated in 3.0.0
-
-      // Suppress during test
-      if (typeof global.it !== 'function')
-      {
-        console.error("\n********\nWARNING: This repository's package.json is using czConfig. 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 

src/git/add.js

@@ -1,9 +1,10 @@
+import execa from 'execa';
+
 export { addPath };
 
 /**
  * Synchronously adds a path to git staging
  */
-function addPath (sh, repoPath) {
-  sh.cd(repoPath);
-  sh.exec('git add .');
+function addPath (repoPath) {
+  execa.sync('git', ['add', '.'], { cwd: repoPath });
 }

src/git/commit.js

@@ -1,6 +1,7 @@
 import os from 'os';
 import {spawn} from 'child_process';
 
+import execa from 'execa';
 import dedent from 'dedent';
 import {isString} from '../common/util';
 
@@ -9,29 +10,9 @@ export { commit };
 /**
  * Asynchronously git commit at a given path with a message
  */
-function commit (sh, repoPath, message, options, done) {
-  let called = false;
-  let args = ['commit', '-m', dedent(message), ...(options.args || [])];
-  let child = spawn('git', args, {
-    cwd: repoPath,
-    stdio: options.quiet ? 'ignore' : 'inherit'
-  });
+function commit (repoPath, message, options) {
+  const args = ['commit', '-m', dedent(message), ...(options.args || [])];
+  const opts = { cwd: repoPath, stdio: options.quiet ? 'ignore' : 'inherit' };
 
-  child.on('error', function (err) {
-    if (called) return;
-    called = true;
-
-    done(err);
-  });
-
-  child.on('exit', function (code, signal) {
-    if (called) return;
-    called = true;
-
-    if (code) {
-      done(Object.assign(new Error(`git exited with error code ${code}`), { code, signal }));
-    } else {
-      done(null);
-    }
-  });
+  return execa('git', args, opts);
 }

src/git/init.js

@@ -1,9 +1,10 @@
+import execa from 'execa';
+
 export { init };
 
 /**
  * Synchronously creates a new git repo at a path
  */
-function init (sh, repoPath) {
-  sh.cd(repoPath);
-  sh.exec('git init');
+function init (repoPath) {
+  execa.sync('git', ['init'], { cwd: repoPath });
 }

src/git/log.js

@@ -1,18 +1,12 @@
-import { exec } from 'child_process';
+import execa from 'execa';
 
 export { log };
 
 /**
  * Asynchronously gets the git log output
  */
-function log (repoPath, done) {
-  exec('git log', {
-    maxBuffer: Infinity,
-    cwd: repoPath
-  }, function (error, stdout, stderr) {
-    if (error) {
-      throw error;
-    }
-    done(stdout);
-  });
+function log (repoPath) {
+  const opts = { maxBuffer: Infinity, cwd: repoPath };
+
+  return execa.stdout('git', ['log'], opts);
 }