chore: add git hooks

Author: chengpeiquan

.eslintrc.js

@@ -6,7 +6,7 @@ module.exports = {
     es2021: true,
     node: true,
   },
-  extends: ['prettier'],
+  extends: ['eslint:recommended', 'prettier'],
   parserOptions: {
     ecmaVersion: 13,
   },

config.json

@@ -1,30 +1,11 @@
 {
   "lang": "en",
-  "authors": [
-    "chengpeiquan"
-  ],
-  "dateRange": [
-    "2021-12-01",
-    "2022-01-31"
-  ],
-  "repos": [
-    "D:\\Git\\git-commit-analytics"
-  ],
+  "authors": ["chengpeiquan"],
+  "dateRange": ["2021-12-01", "2022-01-31"],
+  "repos": ["D:\\Git\\git-commit-analytics"],
   "format": {
     "git-commit-analytics": "Git Commit Analytics"
   },
-  "includes": [
-    "feat",
-    "fix",
-    "docs",
-    "style",
-    "refactor",
-    "test",
-    "chore"
-  ],
-  "excludes": [
-    "typo",
-    "backup",
-    "progress"
-  ]
+  "includes": ["feat", "fix", "docs", "style", "refactor", "test", "chore"],
+  "excludes": ["typo", "backup", "progress"]
 }

jsconfig.json

@@ -1 +1 @@
-{}
+{}

package.json

@@ -19,9 +19,20 @@
     "eslint": "^8.5.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "prettier": "^2.5.1"
+    "lint-staged": "11.1.2",
+    "prettier": "^2.5.1",
+    "yorkie": "^2.0.0"
   },
   "dependencies": {
     "dayjs": "^1.10.7"
+  },
+  "gitHooks": {
+    "pre-commit": "lint-staged",
+    "commit-msg": "node scripts/verifyCommit.js"
+  },
+  "lint-staged": {
+    "*.js": [
+      "prettier --write ."
+    ]
   }
 }

scripts/verifyCommit.js

@@ -0,0 +1,20 @@
+// Invoked on the commit-msg git hook by yorkie.
+
+const fs = require('fs')
+const msgPath = process.env.GIT_PARAMS
+const msg = fs.readFileSync(msgPath, 'utf-8').trim()
+
+const commitRE =
+  /^(revert: )?(feat|fix|docs|dx|style|refactor|perf|test|workflow|build|ci|chore|types|wip|release)(\(.+\))?: .{1,50}/
+
+if (!commitRE.test(msg)) {
+  console.log()
+  console.error(
+    `   ERROR  invalid commit message format.\n\n
+        Proper commit message format is required for automated changelog generation. Examples:\n\n
+          feat(compiler): add 'comments' option\n
+          fix(v-model): handle events on blur (close #28)\n\n
+        See .github/commit-convention.md for more details.\n`
+  )
+  process.exit(1)
+}

src/config.json

@@ -1,12 +1,6 @@
 {
-  "authors": [
-    "程沛权",
-    "chengpeiquan"
-  ],
-  "dateRange": [
-    "2021-01-01",
-    "2021-12-31"
-  ],
+  "authors": ["程沛权", "chengpeiquan"],
+  "dateRange": ["2021-01-01", "2021-12-31"],
   "repos": [
     "D:\\Project\\npm-project\\vue-picture-cropper",
     "D:\\Project\\npm-project\\vite-plugin-banner"
@@ -15,18 +9,6 @@
     "vue-picture-cropper": "Vue Picture Cropper",
     "vite-plugin-banner": "Vite Plugin Banner"
   },
-  "includes": [
-    "feat",
-    "fix",
-    "docs",
-    "style",
-    "refactor",
-    "test",
-    "chore"
-  ],
-  "excludes": [
-    "typo",
-    "backup",
-    "progress"
-  ]
+  "includes": ["feat", "fix", "docs", "style", "refactor", "test", "chore"],
+  "excludes": ["typo", "backup", "progress"]
 }

src/libs/saveReport.js

@@ -36,7 +36,7 @@ module.exports = function ({ result, isEN }) {
           // Categories that has been written
           const categories = []
 
-          list = repoResult[t]
+          const list = repoResult[t]
           list.forEach((item, index) => {
             const { repo, category, msg } = item