Merge branch 'master' into greenkeeper-lodash-4.17.2

* master:
  fix(package): "main" property within "package.json" (#409)
  style: Add linting using eslint (#406)
  ci(appveyor): remove appveyor on finish script
  ci(appveyor): disable collection of artifacts
  ci(tests): on windows run tests as node4/npm3
  ci(travis): update semantic-release to 6.3.5 and update travis config
  chore(package): update nyc to version 10.0.0 (#392)
  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

.eslintrc

@@ -0,0 +1,25 @@
+{
+  "extends": "standard",
+  "rules": {
+    "block-spacing": 0,
+    "brace-style": 0,
+    "comma-dangle": 0,
+    "indent": 0,
+    "key-spacing": 0,
+    "keyword-spacing": 0,
+    "no-duplicate-imports": 0,
+    "no-multiple-empty-lines": 0,
+    "no-path-concat": 0,
+    "no-throw-literal": 0,
+    "no-trailing-spaces": 0,
+    "no-unused-vars": 0,
+    "operator-linebreak": 0,
+    "padded-blocks": 0,
+    "quotes": 0,
+    "semi-spacing": 0,
+    "semi": 0,
+    "space-before-blocks": 0,
+    "space-before-function-paren": 0,
+    "space-infix-ops": 0
+  }
+}

.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,20 +9,24 @@ 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
-- curl -Lo travis_after_all.py https://git.io/vLSON
+- git version
 script:
+# Only run linting on Node.js 4.x and up
+- if [ $(node -pe 'process.version.match(/v(\d+)\./)[1] >= 4') == 'true' ]; then npm run lint; fi
 - npm run test
 - npm run check-coverage
 after_success:
-- python travis_after_all.py
-- export $(cat .to_export_back)
 - npm run report-coverage
 - npm run test:windows
 - npm run semantic-release

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!
 

appveyor.yml

@@ -1,6 +1,6 @@
 # Test against this version of Node.js
 environment:
-  nodejs_version: "0.12"
+  nodejs_version: "4"
 
 # Install scripts. (runs after repo cloning)
 install:
@@ -18,12 +18,12 @@ test_script:
   # run tests
   - npm test
 
-on_finish:
-  - ps: $root = Resolve-Path .\test\artifacts; [IO.Directory]::GetFiles($root.Path, '*.*', 'AllDirectories') | % { Push-AppveyorArtifact $_ -FileName $_.Substring($root.Path.Length + 1) -DeploymentName to-publish }
+#on_finish:
+#  - ps: $root = Resolve-Path .\test\artifacts; [IO.Directory]::GetFiles($root.Path, '*.*', 'AllDirectories') | % { Push-AppveyorArtifact $_ -FileName $_.Substring($root.Path.Length + 1) -DeploymentName to-publish }
 
-artifacts:
-  - path: test/artifacts/**/*
-    name: test artifacts
+#artifacts:
+#  - path: test/artifacts/**/*
+#    name: test artifacts
 
 # Don't actually build.
-build: off
+build: off

package.json

@@ -2,16 +2,18 @@
   "name": "commitizen",
   "version": "0.0.0-semantically-released",
   "description": "Git commit, but play nice with conventions.",
-  "main": "src/index.js",
+  "main": "dist/index.js",
   "scripts": {
     "check-coverage": "nyc check-coverage --statements 80 --branches 80 --functions 80 --lines 80 ",
     "commit": "node bin/git-cz",
     "build": "babel src --out-dir dist",
     "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",
+    "lint": "eslint --ignore-path .gitignore .",
     "test": "nyc --require babel-core/register _mocha -- test/tests/index.js",
     "test:watch": "nodemon -q --ignore test/.tmp/ --ignore test/artifacts/ --ignore coverage/ --exec \"npm run test\" --",
     "test:windows": "node ./test/tools/trigger-appveyor-tests.js"
@@ -21,7 +23,7 @@
       "path": "./node_modules/cz-conventional-changelog"
     },
     "ghooks": {
-      "pre-commit": "npm run test && npm run check-coverage"
+      "pre-commit": "npm run lint && npm run test && npm run check-coverage"
     }
   },
   "homepage": "https://github.com/commitizen/cz-cli",
@@ -53,27 +55,31 @@
     "babel-preset-stage-2": "6.17.0",
     "chai": "3.5.0",
     "codecov.io": "0.1.6",
+    "eslint": "3.12.2",
+    "eslint-config-standard": "6.2.1",
+    "eslint-plugin-promise": "3.4.0",
+    "eslint-plugin-standard": "2.0.1",
     "ghooks": "1.3.0",
     "in-publish": "^2.0.0",
     "mocha": "3.1.2",
     "node-uuid": "1.4.7",
     "nodemon": "1.11.0",
-    "nyc": "6.6.1",
+    "nyc": "10.0.0",
     "proxyquire": "1.7.10",
-    "rimraf": "2.5.4",
-    "semantic-release": "4.3.5",
+    "semantic-release": "6.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.17.2",
     "minimist": "1.2.0",

src/cli/git-cz.js

@@ -25,4 +25,4 @@ function bootstrap(environment = {}) {
     // This tells commitizen that it is not needed, just use git
     useGitStrategy(rawGitArgs, environment);
   }
-}
+}

src/cli/parsers.js

@@ -4,4 +4,4 @@ import * as gitCz from './parsers/git-cz';
 export {
   commitizen,
   gitCz
-};
+};

src/cli/parsers/commitizen.js

@@ -18,4 +18,4 @@ function parse(rawGitArgs) {
    });
 
    return args;
-}
+}