Adding husky and pre-commit hooks

README.md

@@ -176,7 +176,9 @@ Run `npm run build` to compile the code to Javascript.
 
 Run `node dist/examples/runFasterCode.js` (to use GraphQL) or `node dist/examples/runOldCode.ts` (to use REST calls), to run the example program. It requires internet access, since it calls the GitHub API. It will take a couple minutes to complete. Some of the output includes the word "ERROR", so don't panic.
 
-Ensure to lint your code by running `npm run lint` before submitting any code for review. `npm run lint:fix` will automatically fix any errors.
+Ensure to lint your code by running `npm run lint` before submitting any code for review. Either manually fix the errors or run `npm run lint:fix` to automatically fix any errors.
+
+Husky is set up to run linting checks pre-commit which should prevent being able to commit linting errors; however, There is a [bug](https://github.com/typicode/husky/issues/639) in husky where occasionally the hooks won't run in an IDE.
 
 ## Local testing of the npm packaging
 

package.json

@@ -6,6 +6,11 @@
     "types": "dist/src/mariner/index.d.ts",
     "author": "",
     "license": "Apache-2.0",
+    "husky": {
+        "hooks": {
+            "pre-commit": "npm run lint"
+        }
+    },
     "scripts": {
         "test": "echo \"Error: no test specified\" && exit 1",
         "check": "npx eslint --print-config src/* | npx eslint-config-prettier-check",
@@ -39,6 +44,7 @@
         "eslint": "^7.10.0",
         "eslint-config-prettier": "^6.12.0",
         "eslint-plugin-prettier": "^3.1.4",
+        "husky": "^4.3.0",
         "prettier": "^2.1.2",
         "typescript": "^4.0.3"
     },