build: build: build: build: add commitizen, husky, and standard-release for better commit messages

Author: patrickcate

.cz-config.js

@@ -0,0 +1,58 @@
+'use strict'
+
+module.exports = {
+  extends: ['cz'],
+  types: [
+    { value: 'feat', name: 'feat: A new feature' },
+    { value: 'fix', name: 'fix: A bug fix' },
+    { value: 'docs', name: 'docs: Documentation only changes' },
+    {
+      value: 'style',
+      name: 'style: Changes that do not affect the meaning of the code\n(white-space, formatting, missing semi-colons, etc)',
+    },
+    {
+      value: 'refactor',
+      name: 'refactor: A code change that neither fixes a bug nor adds a feature',
+    },
+    {
+      value: 'perf',
+      name: 'perf: A code change that improves performance',
+    },
+    { value: 'test', name: 'test: Adding missing tests' },
+    {
+      value: 'build',
+      name: 'build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)',
+    },
+    {
+      value: 'ci',
+      name: 'ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)',
+    },
+    {
+      value: 'chore',
+      name: 'chore: Changes to the build process or auxiliary tools\nand libraries such as documentation generation',
+    },
+    { value: 'revert', name: 'revert: Reverts a previous commit' },
+    { value: 'WIP', name: 'WIP: Work in progress' },
+  ],
+
+  // override the messages, defaults are as follows
+  messages: {
+    type: "Select the type of change that you're committing:",
+    scope: '\nDenote the SCOPE of this change (optional):',
+    // used if allowCustomScopes is true
+    // customScope: 'Denote the SCOPE of this change:',
+    subject: 'Write a SHORT, IMPERATIVE tense description of the change:\n',
+    body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
+    breaking: 'List any BREAKING CHANGES (optional):\n',
+    footer:
+      'List any ISSUES CLOSED by this change (optional). E.g.: #31, #34:\n',
+    confirmCommit: 'Are you sure you want to proceed with the commit above?',
+  },
+
+  skipQuestions: ['scope'],
+  allowCustomScopes: false,
+  allowBreakingChanges: ['feat', 'fix'],
+
+  // limit subject length
+  subjectLimit: 100,
+}

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn lint-staged

.husky/pre-push

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn lint

commitlint.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['cz'],
+}

package.json

@@ -23,40 +23,52 @@
   "scripts": {
     "serve": "vue-cli-service serve",
     "build": "vue-cli-service build --mode production --target lib --name vue-leaflet-minimap ./src/vue-leaflet-minimap.vue",
-    "lint": "vue-cli-service lint"
+    "lint": "vue-cli-service lint",
+    "release": "standard-version",
+    "prepare": "husky install",
+    "gitcommit": "cz"
   },
   "dependencies": {
     "leaflet-minimap": "^3.6.1",
     "vue2-leaflet": "^2.5.2"
   },
   "devDependencies": {
+    "@commitlint/cli": "^12.1.4",
+    "@commitlint/config-conventional": "^12.1.4",
     "@vue/cli-plugin-babel": "^4.4.6",
     "@vue/cli-plugin-eslint": "^4.4.6",
     "@vue/cli-service": "^4.4.6",
     "@vue/eslint-config-prettier": "^6.0.0",
     "babel-eslint": "^10.1.0",
+    "commitizen": "^4.2.4",
+    "commitlint-config-cz": "^0.13.2",
     "core-js": "^3.6.4",
+    "cz-conventional-changelog": "3.3.0",
+    "cz-customizable": "^6.3.0",
     "eslint": "^7.9.0",
     "eslint-plugin-prettier": "^3.1.1",
-    "eslint-plugin-vue": "^6.2.2",
+    "eslint-plugin-vue": "^7.9.0",
+    "husky": "^6.0.0",
     "leaflet": "^1.6.0",
-    "lint-staged": "^9.5.0",
-    "prettier": "^1.19.1",
+    "lint-staged": "^11.0.0",
+    "prettier": "^2.3.0",
+    "standard-version": "^9.3.0",
     "vue": "^2.6.11",
     "vue-template-compiler": "^2.6.11"
   },
   "peerDependencies": {
     "leaflet": "^1.6.0"
   },
-  "gitHooks": {
-    "pre-commit": "lint-staged"
-  },
   "lint-staged": {
     "*.{js,jsx,vue}": [
-      "vue-cli-service lint",
-      "git add"
+      "vue-cli-service lint"
     ]
   },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-customizable"
+    }
+  },
   "files": [
     "src/vue-leaflet-minimap.vue",
     "dist/*.js"

src/vue-leaflet-minimap.vue

@@ -58,7 +58,7 @@ export default {
       this.mapObject.toggle()
     },
   },
-  render: function(h) {
+  render: function (h) {
     if (this.ready && this.$slots.default) {
       return h('div', { style: { display: 'none' } }, this.$slots.default)
     }