chore: use commitlint for validating commit message

Author: satya164

Diff for: CONTRIBUTING.md

@@ -13,20 +13,20 @@ The core team works directly on GitHub and all work is public.
 > **Working on your first pull request?** You can learn how from this *free* series: [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
 
 1. Fork the repo and create your branch from `master` (a guide on [how to fork a repository](https://help.github.com/articles/fork-a-repo/)).
-2. Run `yarn bootstrap` to setup the developement environment.
+2. Run `yarn bootstrap` to setup the development environment.
 3. Do the changes you want and test them out in the example app before sending a pull request.
 
 ### Commit message convention
 
-We prefix our commit messages with one of the following to signify the kind of change:
+We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:
 
 * `fix`: bug fixes, e.g. fix Button color on DarkTheme.
 * `feat`: new features, e.g. add Snackbar component.
-* `refactor`: code/structure refactor, e.g. new structure folder for components.
+* `refactor`: code refactor, e.g. new folder structure for components.
 * `docs`: changes into documentation, e.g. add usage example for Button.
 * `test`: adding or updating tests, eg unit, snapshot testing.
 * `chore`: tooling changes, e.g. change circleci config.
-* `BREAKING`: for changes that break existing usage, e.g. change API of a component.
+* `BREAKING CHANGE`: for changes that break existing usage, e.g. change API of a component.
 
 Our pre-commit hooks verify that your commit message matches this format when committing.
 
@@ -35,9 +35,9 @@ Our pre-commit hooks verify that your commit message matches this format when co
 We use `flow` for type checking, `eslint` with `prettier` for linting and formatting the code, and `jest` for testing. Our pre-commit hooks verify that the linter and tests pass when commiting. You can also run the following commands manually:
 
 * `yarn flow`: run flow on all files.
-* `yarn typescript`: run tests for typescript.
-* `yarn lint`: run eslint and prettier.
-* `yarn test`: run unit tests.
+* `yarn typescript`: run tests for typescript definitions.
+* `yarn lint`: lint files with eslint and prettier.
+* `yarn test`: run unit tests with jest.
 
 ### Sending a pull request
 

Diff for: commitlint.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+};

Diff for: package.json

@@ -11,6 +11,7 @@
     "types.js",
     "babel.js"
   ],
+  "sideEffects": false,
   "repository": {
     "type": "git",
     "url": "https://github.com/callstack/react-native-paper.git"
@@ -41,12 +42,6 @@
     "docs": "yarn --cwd docs",
     "example": "yarn --cwd example"
   },
-  "husky": {
-    "hooks": {
-      "commit-msg": "node ./scripts/validate-commit-message.js $HUSKY_GIT_PARAMS",
-      "pre-commit": "yarn lint && yarn flow && yarn typescript && yarn test"
-    }
-  },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
@@ -61,6 +56,7 @@
   "devDependencies": {
     "@babel/core": "^7.1.2",
     "@babel/runtime": "^7.1.2",
+    "@commitlint/config-conventional": "^7.5.0",
     "@types/react": "^16.4.18",
     "@types/react-native": "^0.57.7",
     "all-contributors-cli": "^6.1.1",
@@ -69,6 +65,7 @@
     "babel-jest": "^23.6.0",
     "babel-test": "^0.1.1",
     "chalk": "^2.4.1",
+    "commitlint": "^7.5.2",
     "conventional-changelog-cli": "^2.0.11",
     "dedent": "^0.7.0",
     "eslint": "^4.19.1",
@@ -77,7 +74,7 @@
     "eslint-plugin-react-native": "^3.5.0",
     "flow-bin": "~0.78.0",
     "glob": "^7.1.3",
-    "husky": "^1.1.3",
+    "husky": "^1.3.1",
     "jest": "^23.6.0",
     "jest-file-snapshot": "^0.3.2",
     "metro-react-native-babel-preset": "^0.49.0",
@@ -97,6 +94,15 @@
     "react-native": "*",
     "react-native-vector-icons": "*"
   },
+  "resolutions": {
+    "**/babel-core": "7.0.0-bridge.0"
+  },
+  "husky": {
+    "hooks": {
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+      "pre-commit": "yarn lint && yarn flow && yarn typescript && yarn test"
+    }
+  },
   "jest": {
     "preset": "react-native",
     "modulePathIgnorePatterns": [
@@ -105,9 +111,5 @@
     "watchPathIgnorePatterns": [
       "__fixtures__\\/[^/]+\\/(output|error)\\.js"
     ]
-  },
-  "resolutions": {
-    "**/babel-core": "7.0.0-bridge.0"
-  },
-  "sideEffects": false
+  }
 }