Merge pull request #1005 from dacadeorg/ft/add-branch-name-check

feat: add branch name check

Author: musayann

.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
- npx lint-staged
+ npx lint-staged && npm run check-branch-name

CONTRIBUTING.md

@@ -8,7 +8,7 @@ More on the [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0
 
 <br>
 
-# Components conventions
+## Components conventions
 
 1. Use `functional components` instead of arrow components
 2. For typescript, use `interface` for props, and types if needed.

check_branch_name.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+local_branch_name="$(git rev-parse --abbrev-ref HEAD)"
+
+# This regular expression is:
+# 1. checking for branch Names: "dev" or "main" 
+#    - ^(dev|main)$)
+# 2. checking for branch Name starting with fix,ft,ht,chore or doc follwed by a "/" then the "branch name"
+#    - ^((fix|ft|ht|chore|doc)\/[a-zA-Z0-9\-]+)$
+valid_branch_regex='^(dev|main)$|^((fix|ft|ht|chore|doc)\/[a-zA-Z0-9\-]+)$'
+
+green='\033[0;32m'
+red='\033[0;31m'
+clear='\033[0m'
+
+message="❌❌❌❌ Error: The branch name $local_branch_name does not adhere to the project guidelines.\nPlease refer to the CONTRIBUTING guide for the correct format.\nYour commit will be rejected. Rename your branch to a valid name and try again."
+
+if [[ ! $local_branch_name =~ $valid_branch_regex ]]; then
+    echo -e "${red}$message${clear}"
+    exit 1
+fi
+
+echo -e "${green}Branch name check passed ✅${clear}"
+exit 0

package.json

@@ -8,7 +8,8 @@
     "start": "next start",
     "lint": "eslint --ignore-path .eslintignore \"./**/*.{ts,tsx,js}\"",
     "prettier-format": "prettier --config .prettierrc 'src/**/*.{ts,tsx,js,jsx}' --write",
-    "postinstall": "chmod +x .husky/*"
+    "check-branch-name": "./check_branch_name.sh",
+    "prepare": "npx husky install && chmod +x .husky/* && chmod +x ./check_branch_name.sh"
   },
   "dependencies": {
     "@coingecko/cryptoformat": "^0.5.4",