Add precommit hook to run lint command (opensearch-project#201)

CCongWang · web-flow · commit 43d592f86fb1 · 2022-04-27T14:11:01.000-07:00
* add precommit hook to run lint command

Signed-off-by: CCongWang &lt;wangcong@umich.edu&gt;

* update the formatting section in CONTRIBUTING

Signed-off-by: CCongWang &lt;wangcong@umich.edu&gt;
diff --git a/.husky/.gitignore b/.husky/.gitignore
@@ -0,0 +1 @@
+_
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn lint
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -94,7 +94,7 @@ and auto fix the formatting of all files (new and existing) by running
 $ yarn lint --fix
 ```
 
-This should be done before opening a PR to keep checked-in code consistent.
+`Husky` precommit hook is used to automatically run `yarn lint`, please fix the files according to lint result before commiting code changes (run `yarn lint --fix` for fixable errors, or manully fix code according to error messages). If you have any doubts on `ESLint` rules, feel free to [open an issue](issues).
 
 ### Onboarding
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -46,6 +46,7 @@
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-cypress": "^2.12.1",
     "eslint-plugin-prettier": "^4.0.0",
+    "husky": "^6.0.0",
     "mocha-junit-reporter": "^2.0.0"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,7 @@`
`46`	`46`	`"eslint-config-prettier": "^8.5.0",`
`47`	`47`	`"eslint-plugin-cypress": "^2.12.1",`
`48`	`48`	`"eslint-plugin-prettier": "^4.0.0",`
	`49`	`+ "husky": "^6.0.0",`
`49`	`50`	`"mocha-junit-reporter": "^2.0.0"`
`50`	`51`	`}`
`51`	`52`	`}`