refactor(cli): Completely rewrite commitizen

In this release, commitizen was completely rewritten to clean up the code base, add tests, and fix
several long outstanding bugs. Additionally, there is additional functionality that has been added
to attempt to polish the user experience and address certain important edge cases.

Closes #25, closes #16, closes #13, closes #12, closes #7, closes
commitizen/cz-conventional-changelog#8, closes commitizen/cz-conventional-changelog#9

Author: jimthedev

.cz.json

@@ -1,27 +1,4 @@
-# Logs
-logs
-*.log
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directory
-# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
-node_modules
+node_modules/
+.tmp/
+artifacts/
+npm-debug.log

.gitignore

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE

@@ -24,23 +24,21 @@ As a project maintainer, making your repo Commitizen friendly allows you to sele
 
 For this example, we'll be setting up our repo to use [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) also known as [conventional-changelog](https://github.com/ajoslin/conventional-changelog).
 
-First, install the Commitizen conventional-changelog adapter into your project.
+First, install the Commitizen cli tools:
 
 ```
-npm install cz-conventional-changelog
+npm install commitizen -g
 ```
 
-Then just add **.cz.json** to the root of your repository with the following contents:
+Next, initialize your project to use the cz-conventional-changelog adapter by typing:
 
-```json
-{
-  "path": "node_modules/cz-conventional-changelog/"
-}
+```
+commitizen init cz-conventional-changelog --save --save-exact
 ```
 
-This just tells Commitizen which adapter we actually want our contributors to use when they try to commit to this repo.
+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`.
 
-Alternatively, you can skip adding an additional dot file to your root directory by making **.cz.json** a part of **package.json**... just add the `czConfig` field:
+Then just add the `czConfig` field to the root of your **package.json** with the following contents:
 
 ```json
 ...
@@ -49,6 +47,8 @@ Alternatively, you can skip adding an additional dot file to your root directory
   }
 ```
 
+This just tells Commitizen which adapter we actually want our contributors to use when they try to commit to this repo.
+
 #### Congratulations your repo is Commitizen-friendly. Time to flaunt it!
 
 Add the Commitizen-friendly badge to your README using the following markdown:
@@ -73,4 +73,10 @@ Both! Commitizen is not meant to be a replacement for git commit hooks. Rather,
 We accomplish this by letting you define which adapter you'd like to use in your project. Adapters just allow multiple projects to share the same commit message conventions. A good example of an adapter is the cz-conventional-commit adapter.
 
 ### Authors and Contributors
-Jim Cummins (@JimTheDev)
+@JimTheDev (Jim Cummins, author)
+@kentcdodds
+@accraze
+@kytwb
+@Den-dp
+
+Special thanks to @stevelacy, whose [gulp-git](https://www.npmjs.com/package/gulp-git) project makes commitizen possible.

README.md

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+
+require("babel/register");
+require('../src/cli/commitizen.js').bootstrap();

bin/commitizen

@@ -1,13 +1,7 @@
 #!/usr/bin/env node
 
-var app = require('../src/app.js');
-app.bootstrap();
-
-// PRIORITY HIGH
-// TODO: Tests
-// TODO: Examples
-
-// PRIORITY MEDIUM
-// TODO: 3. Allow users to use their original messages using
-//          some kind of template {{m1}} {{m2}} so that they
-//          aren't lost.
+require("babel/register");
+var path = require('path');
+require('../src/cli/git-cz.js').bootstrap({
+  cliPath: path.join(__dirname, '../')
+});

bin/git-cz-debug.cmd renamed to bin/commitizen.cmd

@@ -0,0 +1,62 @@
+import fs from 'fs';
+import path from 'path';
+
+export {
+  executeShellCommand,
+  getParsedJsonFromFile,
+  getParsedPackageJsonFromPath,
+  isArray,
+  isFunction,
+  isString
+}
+
+/**
+ * Executes the command passed to it at the path requested
+ * using the instance of shelljs passed in
+ */
+function executeShellCommand(sh, path, installCommand) {
+  sh.cd(path);
+  sh.exec(installCommand); 
+}
+
+/**
+ * Gets the parsed contents of a json file
+ */
+function getParsedJsonFromFile(filePath, fileName, encoding = 'utf8') {
+  try {
+    var packageJsonContents = fs.readFileSync(path.join(filePath, fileName), encoding);
+    return JSON.parse(packageJsonContents);
+  } catch (e) {
+    console.error(e);
+  }
+}
+
+/**
+ * A helper method for getting the contents of package.json at a given path
+ */
+function getParsedPackageJsonFromPath(path) {
+  return getParsedJsonFromFile(path, 'package.json');
+}
+
+/**
+ * Test if the passed argument is an array
+ */
+function isArray(arr) {
+  return arr.constructor === Array;
+}
+
+/**
+ * Test if the passed argument is a function 
+ */
+function isFunction(functionToCheck) {
+ var getType = {};
+ return functionToCheck && getType.toString.call(functionToCheck) === '[object Function]';
+}
+
+/**
+ * Test if the passed argument is a string
+ */
+function isString(str) {
+  return Object.prototype.toString.call(str) == '[object String]';
+}
+

bin/git-cz

@@ -0,0 +1,7 @@
+{
+    "compilerOptions": {
+        "target": "ES6",
+        "module": "commonjs",
+        "experimentalDecorators" : true
+    }
+}

bin/git-cz-debug

@@ -1,10 +1,15 @@
 {
   "name": "commitizen",
-  "version": "1.0.4",
+  "version": "2.0.0",
   "description": "Git commit, but play nice with conventions.",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "start": "npm run test:watch",
+    "test": "mocha test/tests/index.js --compilers js:babel/register",
+    "test:watch": "nodemon -q --exec \"$(npm bin)/mocha test/tests/index.js --watch --compilers js:babel/register\" --"
+  },
+  "czConfig": {
+    "path": "./node_modules/cz-conventional-changelog"
   },
   "homepage": "https://github.com/commitizen/cz-cli",
   "repository": {
@@ -13,22 +18,33 @@
   },
   "bin": {
     "git-cz": "./bin/git-cz",
-    "git-cz-debug": "./bin/git-cz-debug",
-    "commitizen": "./bin/git-cz",
-    "commitizen-debug": "./bin/git-cz-debug"
+    "commitizen": "./bin/commitizen"
   },
   "author": "Jim Cummins <[email protected]>",
   "license": "MIT",
+  "devDependencies": {
+    "babel": "5.8.23",
+    "chai": "3.3.0",
+    "lodash": "3.10.1",
+    "mocha": "2.3.3",
+    "shelljs": "0.5.3"
+  },
   "dependencies": {
+    "babel": "5.8.23",
     "chalk": "1.1.1",
-    "cz-conventional-changelog": "1.1.1",
     "dedent": "0.4.0",
-    "glob": "5.0.14",
+    "find-node-modules": "1.0.1",
+    "glob": "5.0.15",
     "gulp": "3.9.0",
-    "gulp-git": "1.4.0",
+    "gulp-git": "1.5.0",
     "inquirer": "0.10.1",
+    "jsontool": "7.0.2",
     "minimist": "1.2.0",
+    "node-uuid": "1.4.3",
+    "nodemon": "1.7.1",
+    "rimraf": "2.4.3",
+    "semver": "5.0.3",
     "strip-json-comments": "1.0.4",
-    "systemjs": "0.16.11"
+    "cz-conventional-changelog": "1.1.4"
   }
 }

bin/git-cz.cmd

@@ -0,0 +1,87 @@
+import {configLoader} from '../commitizen';
+import {init} from '../commitizen';
+import {commitizen as commitizenParser} from './parsers'; 
+import * as sh from 'shelljs'; 
+
+let {parse} = commitizenParser;
+
+export {
+  bootstrap
+};
+
+/**
+ * This is the main cli entry point.
+ * environment may be used for debugging.
+ */
+function bootstrap(environment = {}) {
+  
+  // Get cli args
+  let rawGitArgs = process.argv.slice(2, process.argv.length);
+  
+  // Parse the args
+  let parsedArgs = parse(rawGitArgs);
+  let command = parsedArgs._[0];
+   
+  // Do actions based on commands
+  if (command === "init") {
+    let adapterNpmName = parsedArgs._[1];
+    if (adapterNpmName) {
+      console.log(`Attempting to initialize using the npm package ${adapterNpmName}`);
+      try {
+        init(sh, process.cwd(), adapterNpmName, parsedArgs);  
+      } catch(e) {
+        console.error(`Error: ${e}`);
+      }
+    } else {
+      console.error('Error: You must provide an adapter name as the second argument.');
+    }
+  } else {
+    console.log(`
+    
+    Commitizen has two command line tools:
+    
+      1) commitizen -- used for installing adapters into your project
+      2) git-cz     -- used for making commits according to convention
+                       note: you can run 'git cz' if installed with -g
+    
+    Generally if you're using someone else's repo and they've already set up an
+    adapter, you're going to just be running:
+    
+         git-cz
+    
+    However, if you create a new repo and you want to make it easier for future 
+    contributors to follow your commit message conventions using commitizen then
+    you'll need to run a command like this one to add this adapter to your config:
+        
+         commitizen init cz-convetional-changelog --save
+        
+    You should swap out cz-conventional-changelog for the NPM package name of the
+    adapter you wish you install in your project's package.json.
+    
+    Detailed usage:
+      
+      1) commitizen <sub-command>
+    
+         init <adapter-npm-name> [args]
+        
+           description: Install a commitizen adapter from npm and adds it to your
+                        czConfig in your package.json file.
+        
+           args:
+             --save         Install the adapter to package.json dependencies 
+             --save-dev     Install the adapter to devDependencies
+             --save-exact   Install an exact version instead of a range
+             --force        Force install the adapter, even if a previous one exists.
+             
+      2) git-cz <any regular git commit arguments>
+      
+          description: Runs the commitizen prompter, asking you questions so that you
+                       follow the commit conventions of the repository of the current 
+                       directory.
+                       
+                       note: git-cz may even be run as 'git cz' if installed with -g.
+    
+    `);
+  }
+  
+}