build: remove husky and validation hooks

devoto13 · devoto13 · commit 4c6f681cdba7 · 2021-11-02T22:47:24.000+01:00
Previously, we relied on husky package to set up the Git hooks to automatically lint code and check the commit message conventions. While it is a nice feature it causes extra delays on commit/push for more experienced contributors and we still get many PRs with incorrect commit messages from the first-time contributors. Given the above reasons remove the husky dependency, Git hooks and replace them with a script which can be used locally. Note that CI continues to validate the commit message conventions as before.
diff --git a/docs/dev/02-making-changes.md b/docs/dev/02-making-changes.md
@@ -9,7 +9,6 @@ TODO:
 
 If you are thinking about making Karma better, or you just want to hack on it, that’s great!
 Here are some tips on how to set up a Karma workspace and how to send a good pull request.
-**Please note we enforce [commit message conventions].**
 
 ## Setting up the Workspace
 
@@ -66,11 +65,15 @@ change the code, run the tests, etc.
 
 ## Sending a Pull Request
 
-- Commit your changes (**please follow our [commit message conventions]**):
+- Commit your changes (please follow [commit message conventions]):
   ```bash
   $ git commit -m "..."
   ```
-- Push to your github repo:
+- Verify that the last commit follows the conventions:
+  ```bash
+  $ npm run commit:check
+  ```
+- Push to your GitHub repo:
   ```bash
   $ git push origin <branch_name>
   ```
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -460,7 +460,6 @@
     "eslint-plugin-promise": "^4.2.1",
     "eslint-plugin-standard": "^4.0.1",
     "http2": "^3.3.6",
-    "husky": "^4.2.5",
     "jasmine-core": "^3.6.0",
     "karma": ".",
     "karma-browserify": "^7.0.0",
@@ -495,15 +494,10 @@
   },
   "version": "6.3.7",
   "license": "MIT",
-  "husky": {
-    "hooks": {
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
-      "pre-commit": "npm run lint"
-    }
-  },
   "scripts": {
     "lint": "eslint . --ext js --ignore-pattern *.tpl.js",
     "lint:fix": "eslint . --ext js --ignore-pattern *.tpl.js --fix",
+    "commit:check": "commitlint --from HEAD~1",
     "test:unit": "mocha \"test/unit/**/*.spec.js\"",
     "test:e2e": "cucumber-js test/e2e/*.feature",
     "test:client": "node bin/karma start test/client/karma.conf.js",
