chore(commitizen): add cz-conventional-changelog

This adds the ability to automate the format of the commit by prompting the information needed in sequence. It is then easier to follow the standard format of the repository. A commit check has been added to the CI too.

Author: bcabanes

.travis.yml

@@ -9,9 +9,10 @@ install:
  - sh -e /etc/init.d/xvfb start
  - yarn install
 script:
- - 'if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then yarn checkformat --head=$TRAVIS_PULL_REQUEST_SHA --base=$(git merge-base HEAD $TRAVIS_BRANCH); fi'
  - yarn test
  - yarn e2e
+ - 'if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then yarn checkformat --head=$TRAVIS_PULL_REQUEST_SHA --base=$(git merge-base HEAD $TRAVIS_BRANCH); fi'
+ - yarn checkcommit
 addons:
  chrome: stable
 cache:

CONTRIBUTING.md

@@ -80,6 +80,11 @@ feat(schematics): add an option to generate lazy-loadable modules
 `ng generate lib mylib --lazy` provisions the mylib project in tslint.json
 ```
 
+#### Commitizen
+
+To simplify and automate the process of commiting with this format, 
+**Nx is a [Commitizen](https://github.com/commitizen/cz-cli) friendly repository**, just do `git add` and execute `yarn commit`.
+
 ## Migrations
 
 Nx allows users to automatically upgrade to the newest version of the package. If you are introducing a change that would require the users to upgrade their workspace, add a migration to `packages/schematics/migrations`.

README.md

@@ -8,6 +8,7 @@
 [![NPM Version](https://badge.fury.io/js/%40nrwl%2Fnx.svg)](https://www.npmjs.com/@nrwl/nx)
 [![NPM Downloads](https://img.shields.io/npm/dt/@nrwl/schematics.svg?style=flat-square)](https://www.npmjs.com/@nrwl/nx)
 [![Semantic Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)]()
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 
 </p>
 

package.json

@@ -6,6 +6,8 @@
  "private": true,
  "scripts": {
  "build": "./scripts/build.sh",
+ "commit": "git-cz",
+ "checkcommit": "./scripts/commit-lint.js",
  "e2e": "./scripts/e2e.sh",
  "format": "prettier \"{packages,e2e}/**/*.ts\" --write",
  "linknpm": "./scripts/link.sh",
@@ -42,8 +44,10 @@
  "@types/yargs": "^11.0.0",
  "angular": "1.6.6",
  "app-root-path": "^2.0.1",
+ "commitizen": "^2.10.1",
  "conventional-changelog-cli": "^1.3.21",
  "cosmiconfig": "^4.0.0",
+ "cz-conventional-changelog": "^2.1.0",
  "fs-extra": "5.0.0",
  "graphviz": "^0.0.8",
  "husky": "^0.14.3",
@@ -80,5 +84,10 @@
  "tmp",
  "collection/.*/files"
  ]
+ },
+ "config": {
+ "commitizen": {
+ "path": "./node_modules/cz-conventional-changelog"
+ }
  }
 }

scripts/commit-lint.js

@@ -0,0 +1,28 @@
+#!/usr/bin/env node
+
+console.log('🐟🐟🐟 Validating git commit message 🐟🐟🐟');
+const gitMessage = require('child_process')
+ .execSync('git log -1 --no-merges')
+ .toString()
+ .trim();
+const matchTest = /([a-z]){0,8}\([a-z.0-9]+\):\s(([a-z0-9:\-\s])+)/g.test(
+ gitMessage
+);
+const exitCode = +!matchTest;
+
+if (exitCode === 0) {
+ console.log('Commit ACCEPTED 👌');
+} else {
+ console.log(
+ '[Error]: Ho no! 😦 Your commit message: \n' +
+ gitMessage +
+ '\ndoes not follow the commit message convention specified in the CONTRIBUTING.MD file.'
+ );
+ console.log('\ntype(scope): subject \n BLANK LINE \n body');
+ console.log(
+ '\nExample: \n ' +
+ 'feat(schematics): add an option to generate lazy-loadable modules\n' +
+ '\n`ng generate lib mylib --lazy` provisions the mylib project in tslint.json'
+ );
+}
+process.exit(exitCode);