added husky pre commit to check run lint rules

sadabnepal · Apr 25, 2024 · edb6926 · edb6926
1 parent 328955b
commit edb6926
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 2 deletions.
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1 @@
+npm run lint
diff --git a/README.md b/README.md
@@ -84,12 +84,15 @@ npm run cleanup
 - Docker for testing against/using containerization
 - Github actions CI/CD integration
 - Report portal integration
-- dotenv to store secrets locally 
+- dotenv to store secrets locally
+- eslint linting tools integrated
+- husky git hooks for pre-commit checks (eslint)
 
 ### Folder Structure
 
 ```ini
 ├───.github
+├───.husky
 ├───.vscode
 ├───.images
 ├───tests
@@ -102,6 +105,7 @@ npm run cleanup
 |    └───types
 ├───.env
 ├───.env.example
+├───.eslintrc.js
 ├───.gitignore
 ├───docker-compose.yml
 ├───package-lock.json

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -18,7 +18,8 @@
     "docker:stop": "docker compose -f tests/docker/docker-compose.yml down",
     "docker:stop:arm": "docker compose -f tests/docker/docker-compose-arm.yml down",
     "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
+    "lint:fix": "eslint . --fix",
+    "prepare": "husky"
   },
   "author": "MD SADAB SAQIB",
   "license": "ISC",
@@ -35,6 +36,7 @@
     "dotenv": "^16.4.5",
     "eslint": "^8.57.0",
     "eslint-plugin-wdio": "^8.24.12",
+    "husky": "^9.0.11",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5",
     "wdio-docker-service": "^3.2.1"