Add Husky

.husky/pre-commit

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn format:fix
+yarn lint:fix
+yarn typecheck

INSTALLATION.md

@@ -22,6 +22,7 @@ This document provides instructions on how to set up and start a running instanc
   - [Sign in to talawa-admin](#sign-in-to-talawa-admin)
   - [Running tests](#running-tests)
   - [Linting code files](#linting-code-files)
+  - [Husky for Git Hooks](#husky-for-git-hooks)
   - [Setting up Talawa-Admin and API for Talawa App](#setting-up-talawa-admin-and-api-for-talawa-app)
     - [On Your Local Machine](#on-your-local-machine)
 
@@ -147,7 +148,24 @@ You can run the tests for `talawa-admin` using this command:-
 
 You can lint your code files using this command:-
 
-    yarn lint
+      yarn lint:fix
+
+## Husky for Git Hooks
+
+We are using the package `Husky` to automatically run the following scripts on your changes whenever you make a commit:
+
+```
+yarn format:fix
+yarn lint:fix
+yarn typecheck
+```
+
+This is done to improve developer experience and to make sure that your commits do not fail on the automated workflow runs. Still you can manually opt-out of the same using the `--no-verify` flag as follows:
+
+```
+git commit -m "Commit message" --no-verify
+```
+
 
 ## Setting up Talawa-Admin and API for Talawa App
 

package.json

@@ -72,7 +72,8 @@
     "lint:fix": "eslint \"**/*.{ts,tsx}\" --fix",
     "format:fix": "prettier --write \"**/*.{ts,tsx,json,scss,css}\"",
     "format:check": "prettier --check \"**/*.{ts,tsx,json,scss,css}\"",
-    "typecheck": "tsc --project tsconfig.json --noEmit"
+    "typecheck": "tsc --project tsconfig.json --noEmit",
+    "prepare": "husky install"
   },
   "eslintConfig": {
     "extends": [
@@ -103,6 +104,7 @@
     "@typescript-eslint/eslint-plugin": "^5.9.0",
     "@typescript-eslint/parser": "^5.9.0",
     "eslint-plugin-react-hooks": "^4.2.0",
+    "husky": "^8.0.3",
     "jest-localstorage-mock": "^2.4.19",
     "jest-location-mock": "^1.0.9",
     "jquery": "^3.2.1"