Add pre-commit hooks

Delemangi · Dec 14, 2023 · 3f7fe4f · 3f7fe4f
1 parent afe68d6
commit 3f7fe4f
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 0 deletions.
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run lint
diff --git a/README.md b/README.md
@@ -6,6 +6,8 @@ It's recommended, but not required to run this inside a Docker container.
 
 ## Installation
 
+For development purposes, be sure to run `npm run prepare` to install the Git pre-commit hooks.
+
 ### Installation (Docker)
 
 1. Clone the repository: `git clone [email protected]:Delemangi/finki-discord-bot.git`

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -20,6 +20,7 @@
     "@types/async-lock": "^1.4.2",
     "eslint": "^8.55.0",
     "eslint-config-canonical": "^42.8.0",
+    "husky": "^8.0.3",
     "prisma": "^5.7.0",
     "typescript": "^5.3.3"
   },
@@ -40,6 +41,7 @@
     "lint:fix": "eslint . --ext .ts --fix",
     "migration:apply": "prisma migrate deploy",
     "migration:create": "prisma migrate dev --name a",
+    "prepare": "husky install",
     "start": "node dist/main.js",
     "start:dev": "npm run lint && npm run build && npm run start",
     "start:prod": "npm run migration:apply && npm run start"