fix: husky and lint-stage work properly when hooks are installed (#16)

.eslintrc

@@ -1,5 +1,9 @@
 {
-  "ignorePatterns": ["dist", "typechain"],
+  "ignorePatterns": [
+    "dist",
+    "node_modules",
+    "typechain"
+  ],
   "root": true,
   "parser": "@typescript-eslint/parser",
   "plugins": [
@@ -15,6 +19,6 @@
   "rules": {
     "no-console": 2,
     "prettier/prettier": 2,
-    "strict" : 2
+    "strict": 2
   }
 }

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

.prettierignore

@@ -1,3 +1,4 @@
 # Ignore artifacts:
+node_modules
 dist
 typechain

README.md

@@ -81,3 +81,10 @@ npm run build
 npm run test
 ```
 
+#### Husky Git Commit Hooks
+To enable Husky commit hooks to trigger the lint-staged behaviour of formatting and linting the staged files prior 
+before committing, prepare your repo with `prepare`.
+
+```shell
+npm run prepare
+```

package.json

@@ -16,8 +16,9 @@
   "scripts": {
     "build": "hardhat compile",
     "clean": "hardhat clean",
-    "lint": "eslint . --ext .ts",
     "format": "prettier ./**/*.ts --write",
+    "lint": "eslint . --ext .ts",
+    "prepare": "husky install",
     "test": "mocha --exit --recursive --require ts-node/register 'test/**/*.test.ts'"
   },
   "devDependencies": {
@@ -48,15 +49,10 @@
   "dependencies": {
     "bunyan": "^1.8.15"
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
   "lint-staged": {
     "*.ts": [
-      "eslint --cache --fix",
-      "prettier --write"
+      "npm run format",
+      "npm run lint --fix"
     ]
   }
 }