🐙(git hook): add commitlint with gitmoji

New commitlint configuration to add convention and gitmoji to prepare for auto-generation of
changelog

Author: JeremyDolle

.husky/prepare-commit-msg

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

commitlint.config.js

@@ -0,0 +1,103 @@
+module.exports = {
+  parserPreset: 'conventional-changelog-conventionalcommits',
+  rules: {
+    'body-leading-blank': [1, 'always'],
+    'body-max-line-length': [2, 'always', 100],
+    'footer-leading-blank': [1, 'always'],
+    'footer-max-line-length': [2, 'always', 100],
+    'header-max-length': [2, 'always', 100],
+    'subject-case': [
+      2,
+      'never',
+      ['sentence-case', 'start-case', 'pascal-case', 'upper-case'],
+    ],
+    'subject-empty': [2, 'never'],
+    'subject-full-stop': [2, 'never', '.'],
+    'type-case': [2, 'always', 'lower-case'],
+    'type-empty': [2, 'never'],
+    'type-enum': [
+      2,
+      'always',
+      [
+        '✨',
+        '🐛',
+        '📚',
+        '💎',
+        '♻️',
+        '🐙',
+      ],
+    ],
+  },
+  prompt: {
+    questions: {
+      type: {
+        description: "Select the TYPE of change that you're committing",
+        enum: {
+          '✨': {
+            description: 'A new feature',
+            title: 'Features',
+            emoji: '✨',
+          },
+          '🐛': {
+            description: 'A bug fix',
+            title: 'Bug Fixes',
+            emoji: '🐛',
+          },
+          '📚': {
+            description: 'Documentation only changes',
+            title: 'Documentation',
+            emoji: '📚',
+          },
+          '💎': {
+            description:
+              'Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)',
+            title: 'Code Styles',
+            emoji: '💎',
+          },
+          '♻️': {
+            description:
+              'A code change that neither fixes a bug nor adds a feature',
+            title: 'Code Refactoring',
+            emoji: '♻️',
+          },
+          '🐙': {
+            description: 'Changes to the git configuration files and scripts (example scope: GitHub Actions)',
+            title: 'Github configuration',
+            emoji: '🐙',
+          },
+        },
+      },
+      scope: {
+        description:
+          'What is the SCOPE of this change (e.g. component or file name)',
+      },
+      subject: {
+        description:
+          'Write a short, imperative tense DESCRIPTION of the change',
+      },
+      body: {
+        description: 'Provide a longer description of the change',
+      },
+      isBreaking: {
+        description: 'Are there any breaking changes?',
+      },
+      breakingBody: {
+        description:
+          'A BREAKING CHANGE commit requires a body. Please enter a longer description of the commit itself',
+      },
+      breaking: {
+        description: 'Describe the breaking changes',
+      },
+      isIssueAffected: {
+        description: 'Does this change affect any open issues?',
+      },
+      issuesBody: {
+        description:
+          'If issues are closed, the commit requires a body. Please enter a longer description of the commit itself',
+      },
+      issues: {
+        description: 'Add issue references (e.g. "fix #123", "re #123".)',
+      },
+    },
+  },
+};

package.json

@@ -14,7 +14,9 @@
   "homepage": "https://thecodingmachine.github.io/react-native-boilerplate/",
   "main": "post-init.script.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "commit": "cz",
+    "prepare": "husky install"
   },
   "keywords": [
     "react",
@@ -28,5 +30,19 @@
     "@thecodingmachine/rnb-plugin-typescript": "^1.1.0",
     "kleur": "^4.1.4",
     "prompts": "^2.4.1"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^16.0.2",
+    "@commitlint/config-conventional": "^16.0.0",
+    "@commitlint/cz-commitlint": "^16.0.0",
+    "@commitlint/prompt-cli": "^16.0.0",
+    "commitizen": "^4.2.4",
+    "cz-conventional-changelog": "^3.3.0",
+    "husky": "^7.0.4"
+  },
+  "config": {
+    "commitizen": {
+      "path": "@commitlint/cz-commitlint"
+    }
   }
 }