Merge branch 'master' into greenkeeper-nyc-10.0.0

* master:
  docs(install): Add documentation for installing and running locally (#300)
  fix(tests): fix tests when a global config is present (#405)
  test(adapter): add test for scoped npm modules
  fix(adapter): add support for scoped adapters
  docs: Add cz-emoji to tools list (#404)
  feat(commit): use OS-specific cache dir for commitizen.json instead of home-or-tmp (#400)
  fix(npmignore): ignore more unnecessary files (#393)
  docs: add vscode-commitizen to tools list (#397)
  Ci issues with commits (#402)
  chore(ci): add node versions and say git version in ci
  docs: replace sudo mention with link to how to fix EACCES error

Author: jimthedev

.npmignore

@@ -1,4 +1,9 @@
 /meta
 /src
 /test
-test/tools/trigger-appveyor-tests.sh
+test/tools/trigger-appveyor-tests.sh
+/coverage
+/.travis.yml
+/appveyor.yml
+jsconfig.json
+travis_after_all.py

.travis.yml

@@ -9,13 +9,18 @@ branches:
 notifications:
   email: false
 node_js:
+- '7'
+- '6'
+- '5'
 - '4'
 - '0.12'
 before_install:
 - git config --global user.name "TravisCI"
+- git config --global user.email "commitizen@gmail.com"
 - npm i -g npm@^2.0.0
 before_script:
 - npm prune
+- git version
 - curl -Lo travis_after_all.py https://git.io/vLSON
 script:
 - npm run test

CONTRIBUTING.md

@@ -17,6 +17,21 @@ to release new versions automatically.
 
 *  Commits of type `fix` will trigger bugfix releases, think `0.0.1`
 *  Commits of type `feat` will trigger feature releases, think `0.1.0`
-*  Commits with `BREAKING CHANGE` in body or footer will trigger breakgin releases, think `1.0.0`
+*  Commits with `BREAKING CHANGE` in body or footer will trigger breaking releases, think `1.0.0`
 
-All other commit types wil trigger no new release.
+All other commit types will trigger no new release.
+
+## Gotchas
+
+### Atom removes lines with just spaces, breaking tests
+
+When using Atom, if you edit some of our tests, atom will remove the whitespace on some lines. Unfortunately we wanted this whitespace to
+able to test multiline commits and their difference across operating
+systems. Atom has decided to keep the stripping of whitespace as a
+default. Although we understand this decision, it has the unfortunate
+side effect of editing parts of the file that you might not have
+intended. We think this should be left up to more configurable tools
+like eslint.
+
+For now, in order to work around this, you can take the steps outlined
+[here](https://github.com/atom/whitespace/issues/10#issuecomment-85183781) to temporarily disable automatic whitespace removal in Atom.

README.md

@@ -5,7 +5,7 @@ When you commit with Commitizen, you'll be prompted to fill out any required com
  [![codecov.io](https://img.shields.io/codecov/c/github/commitizen/cz-cli.svg?style=flat-square)](https://codecov.io/github/commitizen/cz-cli?branch=master) [![npm monthly downloads](https://img.shields.io/npm/dm/commitizen.svg?style=flat-square)](https://www.npmjs.com/package/commitizen) [![current version](https://img.shields.io/npm/v/commitizen.svg?style=flat-square)](https://www.npmjs.com/package/commitizen) [![bitHound Score](https://www.bithound.io/github/commitizen/cz-cli/badges/score.svg)](https://www.bithound.io/github/commitizen/cz-cli) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
 
 #### Installing the command line tool
-Installation is as simple as running the following command (add sudo if on OSX/Linux):
+Installation is as simple as running the following command (if you see `EACCES` error, reading [fixing npm permissions](https://docs.npmjs.com/getting-started/fixing-npm-permissions) may help):
 
 ```
 npm install -g commitizen
@@ -31,7 +31,7 @@ npm install -g commitizen
 Install your preferred `commitizen` adapter globally, for example [`cz-conventional-changelog`](https://www.npmjs.com/package/cz-conventional-changelog)
 
 ```
-npm i -g cz-conventional-changelog
+npm install -g cz-conventional-changelog
 ```
 
 Create a `.czrc` file in your `home` directory, with `path` referring to the preferred, globally installed, `commitizen` adapter
@@ -92,6 +92,27 @@ This just tells Commitizen which adapter we actually want our contributors to us
 
 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.
 
+#### Optional: Install and run Commitizen locally
+
+Installing and running Commitizen locally allows you to make sure that developers are running the exact same version of Commitizen on every machine.
+
+Install Commitizen with `npm install --save-dev commitizen`.
+
+Once you have Commitizen installed as a local dev dependency you can execute `./node_modules/.bin/commitizen` or `./node_modules/.bin/git-cz` in order to actually use the commands.
+
+You can then initialize the conventional changelog adapter using: `./node_modules/.bin/commitizen init cz-conventional-changelog --save-dev --save-exact`
+
+And you can then add some nice npm run scripts in your package.json pointing to the local version of commitizen:
+
+```json
+  ...
+  "scripts": {
+    "commit": "git-cz"
+  }
+```
+
+This will be more convenient for your users because then if they want to do a commit, all they need to do is run `npm run commit` and they will get the prompts needed to start a commit!
+
 #### Congratulations your repo is Commitizen-friendly. Time to flaunt it!
 
 Add the Commitizen-friendly badge to your README using the following markdown:
@@ -181,6 +202,8 @@ We know that every project and build process has different requirements so we've
 - [cz-mapbox-changelog](https://www.npmjs.com/package/cz-mapbox-changelog)
 - [cz-customizable](https://github.com/leonardoanalista/cz-customizable)
 - [cz-conventional-changelog-lint](https://github.com/marionebl/cz-conventional-changelog-lint)
+- [vscode-commitizen](https://github.com/KnisterPeter/vscode-commitizen)
+- [cz-emoji](https://github.com/ngryman/cz-emoji)
 
 To create an adapter, just fork one of these great adapters and modify it to suit your needs.  We pass you an instance of [Inquirer.js](https://github.com/SBoudrias/Inquirer.js/) but you can capture input using whatever means necessary. Just call the `commit` callback with a string and we'll be happy. Publish it to npm, and you'll be all set!
 

package.json

@@ -10,6 +10,7 @@
     "build:watch": "babel --watch src --out-dir dist",
     "prepublish": "not-in-install && npm run build || true",
     "report-coverage": "nyc report --reporter=lcov | codecov",
+    "write-coverage": "nyc report --reporter=lcov",
     "semantic-release": "semantic-release pre && npm publish && semantic-release post",
     "start": "npm run test:watch",
     "test": "nyc --require babel-core/register _mocha -- test/tests/index.js",
@@ -60,20 +61,20 @@
     "nodemon": "1.11.0",
     "nyc": "10.0.0",
     "proxyquire": "1.7.10",
-    "rimraf": "2.5.4",
     "semantic-release": "4.3.5",
     "semver": "5.3.0",
     "sinon": "1.17.6"
   },
   "dependencies": {
+    "cachedir": "^1.1.0",
     "chalk": "1.1.3",
     "cz-conventional-changelog": "1.2.0",
     "dedent": "0.6.0",
     "detect-indent": "4.0.0",
     "find-node-modules": "1.0.3",
     "find-root": "1.0.0",
+    "fs-extra": "^1.0.0",
     "glob": "7.1.1",
-    "home-or-tmp": "2.0.0",
     "inquirer": "1.2.2",
     "lodash": "4.16.3",
     "minimist": "1.2.0",

src/commitizen/adapter.js

@@ -128,7 +128,7 @@ function getPrompter(adapterPath) {
 function resolveAdapterPath(inboundAdapterPath) {
   // Check if inboundAdapterPath is a path or node module name
   let parsed = path.parse(inboundAdapterPath);
-  let isPath = parsed.dir.length > 0;
+  let isPath = parsed.dir.length > 0 && parsed.dir.charAt(0) !== "@";
 
   // Resolve from the root of the git repo if inboundAdapterPath is a path
   let absoluteAdapterPath = isPath ?

src/commitizen/commit.js

@@ -1,7 +1,8 @@
 import path from 'path';
 
-import homeOrTmp from 'home-or-tmp';
 import dedent from 'dedent';
+import cacheDir from 'cachedir';
+import {ensureDir} from 'fs-extra';
 import {commit as gitCommit, log} from '../git';
 import * as cache from './cache';
 
@@ -21,41 +22,48 @@ function dispatchGitCommit(sh, repoPath, template, options, overrideOptions, don
   * Asynchronously commits files using commitizen
   */
 function commit(sh, inquirer, repoPath, prompter, options, done) {
-  
-  var cachePath = path.join(homeOrTmp, 'commitizen.json');
-  
-  if(options.retryLastCommit) {
-    
-    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);
-    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;
-      }
+  var cacheDirectory = cacheDir('commitizen');
+  var cachePath = path.join(cacheDirectory, 'commitizen.json');
 
-      if (error) {
-        return done(error);
-      }
+  ensureDir(cacheDirectory, function(error) {
+    if (error) {
+      console.error("Couldn't create commitizen cache directory: ", error);
+      // TODO: properly handle error?
+    } else {
+      if(options.retryLastCommit) {
 
-      // 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);
-    });
-  }
+        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);
+        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;
+          }
+
+          if (error) {
+            return done(error);
+          }
+
+          // 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);
+        });
+      }
+    }
+  });
 
 }

src/common/util.js

@@ -7,7 +7,8 @@ export {
   getParsedPackageJsonFromPath,
   isArray,
   isFunction,
-  isString
+  isString,
+  isInTest
 }
 
 /**
@@ -80,3 +81,7 @@ function isString(str) {
     return Object.prototype.toString.call(str) == '[object String]';
   }
 }
+
+function isInTest() {
+  return typeof global.it === 'function';
+}

src/configLoader/loader.js

@@ -1,12 +1,13 @@
 import path from 'path';
 
 import {findup, getContent} from '../configLoader';
+import {isInTest} from '../common/util.js';
 
 export default loader;
 
 /**
  * Command line config helpers
- * Shamelessly ripped from with slight modifications: 
+ * Shamelessly ripped from with slight modifications:
  * https://github.com/jscs-dev/node-jscs/blob/master/lib/cli-config.js
  */
 
@@ -27,7 +28,7 @@ function loader(configs, config, cwd) {
 
     content = getContent(
         findup(configs, { nocase: true, cwd: directory }, function(configPath) {
-            if (path.basename(configPath) === 'package.json') { 
+            if (path.basename(configPath) === 'package.json') {
                 // return !!this.getContent(configPath);
             }
 
@@ -38,20 +39,22 @@ function loader(configs, config, cwd) {
     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 = getContent(configs[j], directoryArr[i]);
-
-            if (content) {
-                return content;
-            }
-        }
+    /* istanbul ignore if */
+    if(!isInTest()) {
+      // 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 = getContent(configs[j], directoryArr[i]);
+
+              if (content) {
+                  return content;
+              }
+          }
+      }
     }
-} 
+}

src/git/log.js

@@ -1,4 +1,4 @@
-import {exec} from 'child_process';
+import { exec } from 'child_process';
 
 export { log };
 
@@ -11,6 +11,7 @@ function log(repoPath, done) {
     cwd: repoPath
   }, function(error, stdout, stderr) {
     if (error) {
+      throw error;
       done();
     }
     done(stdout);