Merge pull request #31 from codersforcauses/add-husky-commitlint

feat(linter): add husky and commitlint

Author: jsun1590

.husky/commit-msg

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+cd client
+npx --no -- commitlint --edit "${1}"

client/commitlint.config.js

@@ -0,0 +1,19 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'scope-enum': [
+      2,
+      'always',
+      [
+        'core',
+        'linting',
+        'backend',
+        'frontend',
+        'authentication',
+        'styles',
+        'documentation',
+        'misc',
+      ],
+    ],
+  },
+};

client/package.json

@@ -3,6 +3,7 @@
   "version": "1.0.0",
   "private": true,
   "scripts": {
+    "prepare": "cd .. && husky install .husky",
     "dev": "nuxt",
     "build": "nuxt build",
     "start": "nuxt start",
@@ -23,6 +24,8 @@
     "webpack": "5.73.0"
   },
   "devDependencies": {
+    "@commitlint/cli": "^17.0.2",
+    "@commitlint/config-conventional": "^17.0.2",
     "@nuxtjs/tailwindcss": "5.1.2",
     "@vue/test-utils": "1.3.0",
     "babel-core": "7.0.0-bridge.0",
@@ -35,6 +38,7 @@
     "eslint-plugin-n": "^15.0.0",
     "eslint-plugin-promise": "^6.0.0",
     "eslint-plugin-vue": "^9.1.1",
+    "husky": "^8.0.1",
     "jest": "^28.1.1",
     "jest-environment-jsdom": "^28.1.1",
     "postcss": "8.4.14",