feat: add pre-commit hook to auto generated addresses.json for new deployments

Author: apoorvlathey

package.json

@@ -16,6 +16,11 @@
     "verify:arbitrum": "hardhat --network arbitrum etherscan-verify",
     "gen:addresses": "ts-node ./script/genAddressesJson.ts"
   },
+  "husky": {
+    "hooks": {
+      "pre-commit": "./script/preCommitGenAddresses.sh"
+    }
+  },
   "devDependencies": {
     "@ethersproject/units": "^5.7.0",
     "@nomicfoundation/hardhat-foundry": "^1.0.0",
@@ -34,7 +39,7 @@
     "hardhat-deploy": "^0.11.22",
     "hardhat-deploy-ethers": "0.3.0-beta.13",
     "hardhat-tracer": "^1.0.0-alpha.6",
-    "husky": "^8.0.0",
+    "husky": "^8.0.3",
     "prettier": "^2.4.1",
     "prettier-plugin-solidity": "^1.0.0-beta.18",
     "ts-node": "^10.8.0",

script/preCommitGenAddresses.sh

@@ -0,0 +1,19 @@
+#!/bin/sh
+
+# Check if any files in 'deployments' folder are staged for commit
+if git diff --cached --name-only | grep -q 'deployments/'
+then
+    echo "Changes detected in 'deployments' folder. Running 'yarn gen:addresses'..."
+    yarn gen:addresses
+
+    # Check if the script was successful
+    if [ $? -ne 0 ]; then
+        echo "Script failed. Aborting commit."
+        exit 1
+    fi
+
+    echo "Adding updated address.json to the commit..."
+    git add addresses.json
+
+    echo "Continuing with commit..."
+fi

yarn.lock

@@ -4639,7 +4639,7 @@ https-proxy-agent@^5.0.0:
     agent-base "6"
     debug "4"
 
-husky@^8.0.0:
+husky@^8.0.3:
   version "8.0.3"
   resolved "https://registry.yarnpkg.com/husky/-/husky-8.0.3.tgz#4936d7212e46d1dea28fef29bb3a108872cd9184"
   integrity sha512-+dQSyqPh4x1hlO1swXBiNb2HzTDN1I2IGLQx1GrBuiqFJfoMrnZWwVmatvSiO+Iz8fBUnf+lekwNo4c2LlXItg==