feat(ci-cd): commitizen added (#24)

GH-0

.cz-config.js

@@ -0,0 +1,65 @@
+module.exports = {
+  types: [
+    {value: 'feat', name: 'feat:     A new feature'},
+    {value: 'fix', name: 'fix:      A bug fix'},
+    {value: 'docs', name: 'docs:     Documentation only changes'},
+    {
+      value: 'style',
+      name:
+        'style:    Changes that do not affect the meaning of the code\n            (white-space, formatting, missing semi-colons, etc)',
+    },
+    {
+      value: 'refactor',
+      name:
+        'refactor: A code change that neither fixes a bug nor adds a feature',
+    },
+    {
+      value: 'perf',
+      name: 'perf:     A code change that improves performance',
+    },
+    {value: 'test', name: 'test:     Adding missing tests'},
+    {
+      value: 'chore',
+      name:
+        'chore:    Changes to the build process or auxiliary tools\n            and libraries such as documentation generation',
+    },
+    {value: 'revert', name: 'revert:   Reverting a commit'},
+    {value: 'WIP', name: 'WIP:      Work in progress'},
+  ],
+
+  scopes: [
+    {name: 'chore'},
+    {name: 'ci-cd'},
+    {name: 'component'},
+    {name: 'provider'},
+    {name: 'core'},
+  ],
+
+  appendBranchNameToCommitMessage: true,
+  appendIssueFromBranchName: true,
+  allowTicketNumber: false,
+  isTicketNumberRequired: false,
+
+  // override the messages, defaults are as follows
+  messages: {
+    type: "Select the type of change that you're committing:",
+    scope: 'Denote the SCOPE of this change:',
+    // used if allowCustomScopes is true
+    customScope: 'Denote the SCOPE of this change:',
+    subject: 'Write a SHORT, IMPERATIVE tense description of the change:\n',
+    body:
+      'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
+    breaking: 'List any BREAKING CHANGES (optional):\n',
+    footer: 'List any ISSUES CLOSED by this change (optional). E.g.: GH-144:\n',
+    confirmCommit: 'Are you sure you want to proceed with the commit above?',
+  },
+
+  allowCustomScopes: false,
+  allowBreakingChanges: ['feat', 'fix'],
+
+  // limit subject length
+  subjectLimit: 100,
+  breaklineChar: '|', // It is supported for fields body and footer.
+  footerPrefix: '',
+  askForBreakingChangeFirst: true, // default is false
+};

.eslintignore

@@ -2,3 +2,5 @@ node_modules/
 dist/
 coverage/
 api-docs/
+.cz-config.js
+commitlint.config.js

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm test

.husky/prepare-commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+exec < /dev/tty && npx cz --hook || true

DEVELOPING.md

@@ -7,8 +7,14 @@ users.
 
 Install the following extensions:
 
- - [tslint](https://marketplace.visualstudio.com/items?itemName=eg2.tslint)
- - [prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
+- [tslint](https://marketplace.visualstudio.com/items?itemName=eg2.tslint)
+- [prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
+
+## Setup Commit Hooks
+
+Run the following script to prepare husky after the first time install -
+
+`npm run prepare`
 
 ## Development workflow
 

commitlint.config.js

@@ -0,0 +1,14 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'header-max-length': [2, 'always', 100],
+    'body-leading-blank': [2, 'always'],
+    'footer-leading-blank': [0, 'always'],
+    'references-empty': [2, 'never'],
+  },
+  parserPreset: {
+    parserOpts: {
+      issuePrefixes: ['GH-'],
+    },
+  },
+};