feat(template): add commit message specification

Val-istar-Guo · Val-istar-Guo · commit dcdacd4c7538 · 2018-10-01T17:40:50.000+08:00
All template's commit message is constrained by the commit message specification of the angrular team implemented by commitizen. At the sametime, the message format is verified when the commit is submitted. #6
diff --git a/template/assist-plugin/.commitlintrc.yml b/template/assist-plugin/.commitlintrc.yml
@@ -0,0 +1,2 @@
+extends:
+  - '@commitlint/config-conventional'
diff --git a/template/assist-plugin/.czrc b/template/assist-plugin/.czrc
@@ -0,0 +1 @@
+{ "path": "cz-conventional-changelog" }
diff --git a/template/assist-plugin/.huskyrc.yml b/template/assist-plugin/.huskyrc.yml
@@ -1,2 +1,3 @@
 hooks:
   pre-commit: 'npm test'
+  commit-msg: 'commitlint -E HUSKY_GIT_PARAMS'
diff --git a/template/assist-plugin/package.json.mustache b/template/assist-plugin/package.json.mustache
@@ -9,6 +9,8 @@
     "clean": "rm -rf ./dist/*",
     "build": "npm run clean & webpack",
     "prepublishOnly": "npm test; npm run build",
+    "ca": "git add -A && git-cz -av",
+    "commit": "git-cz",
   },
   "engines": {
     "node": ">=8.9.4"
@@ -53,7 +55,11 @@
     "webpack-bundle-analyzer": "^2.11.1",
     "webpack-cli": "^2.0.14",
     "webpack-merge": "^4.1.2",
-    "webpack-node-externals": "^1.7.2"
+    "webpack-node-externals": "^1.7.2",
+    "commitizen": "^2.10.1",
+    "cz-conventional-changelog": "^2.1.0",
+    "@commitlint/cli": "^7.1.2",
+    "@commitlint/config-conventional": "^7.1.2"
   },
   "dependencies": {},
   "postcss": {
diff --git a/template/component/.commitlintrc.yml b/template/component/.commitlintrc.yml
@@ -0,0 +1,2 @@
+extends:
+  - '@commitlint/config-conventional'
diff --git a/template/component/.czrc b/template/component/.czrc
@@ -0,0 +1 @@
+{ "path": "cz-conventional-changelog" }
diff --git a/template/component/.huskyrc.yml b/template/component/.huskyrc.yml
@@ -1,2 +1,3 @@
 hooks:
   pre-commit: 'npm test'
+  commit-msg: 'commitlint -E HUSKY_GIT_PARAMS'
diff --git a/template/component/package.json.mustache b/template/component/package.json.mustache
@@ -10,7 +10,9 @@
     "mili:upgrade": "mili upgrade",
     "clean": "rm -rf ./dist/*",
     "build": "npm run clean & rollup -c",
-    "prepublishOnly": "npm test; npm run build"
+    "prepublishOnly": "npm test; npm run build",
+    "ca": "git add -A && git-cz -av",
+    "commit": "git-cz"
   },
   "engines": { "node": ">=8.9.4" },
   "mili": {
@@ -44,7 +46,11 @@
     "rollup-plugin-babel": "^3.0.3",
     "rollup-plugin-commonjs": "^9.1.0",
     "rollup-plugin-json": "^3.0.0",
-    "rollup-plugin-node-resolve": "^3.3.0"
+    "rollup-plugin-node-resolve": "^3.3.0",
+    "commitizen": "^2.10.1",
+    "cz-conventional-changelog": "^2.1.0",
+    "@commitlint/cli": "^7.1.2",
+    "@commitlint/config-conventional": "^7.1.2"
   },
   "dependencies": {}
 }
diff --git a/template/pwa/.commitlintrc.yml b/template/pwa/.commitlintrc.yml
@@ -0,0 +1,2 @@
+extends:
+  - '@commitlint/config-conventional'
diff --git a/template/pwa/.czrc b/template/pwa/.czrc
@@ -0,0 +1 @@
+{ "path": "cz-conventional-changelog" }
diff --git a/template/pwa/.huskyrc.yml b/template/pwa/.huskyrc.yml
@@ -0,0 +1,2 @@
+hooks:
+  commit-msg: 'commitlint -E HUSKY_GIT_PARAMS'
diff --git a/template/pwa/package.json.mustache b/template/pwa/package.json.mustache
@@ -17,7 +17,9 @@
     "deploy": "npm run deploy:stage",
     "deploy:stage": "pm2 deploy ecosystem.config.js stage",
     "deploy:prod": "pm2 deploy ecosystem.config.js prod",
-    "analyzer": "NODE_ENV=production ANALYZER=true webpack"
+    "analyzer": "NODE_ENV=production ANALYZER=true webpack",
+    "ca": "git add -A && git-cz -av",
+    "commit": "git-cz"
   },
   "engines": { "node": ">=8.9.4" },
   "deploy": {
@@ -62,7 +64,11 @@
     "webpack-bundle-analyzer": "^2.13.1",
     "webpack-cli": "^3.0.3",
     "webpack-merge": "^4.1.2",
-    "webpack-node-externals": "^1.7.2"
+    "webpack-node-externals": "^1.7.2",
+    "commitizen": "^2.10.1",
+    "cz-conventional-changelog": "^2.1.0",
+    "@commitlint/cli": "^7.1.2",
+    "@commitlint/config-conventional": "^7.1.2"
   },
   "dependencies": {
     "babel-polyfill": "^6.26.0",
diff --git a/template/web/.commitlintrc.yml b/template/web/.commitlintrc.yml
@@ -0,0 +1,2 @@
+extends:
+  - '@commitlint/config-conventional'
diff --git a/template/web/.czrc b/template/web/.czrc
@@ -0,0 +1 @@
+{ "path": "cz-conventional-changelog" }
diff --git a/template/web/.huskyrc.yml b/template/web/.huskyrc.yml
@@ -0,0 +1,2 @@
+hooks:
+  commit-msg: 'commitlint -E HUSKY_GIT_PARAMS'
diff --git a/template/web/package.json.mustache b/template/web/package.json.mustache
@@ -17,7 +17,9 @@
     "deploy": "npm run deploy:stage",
     "deploy:stage": "pm2 deploy ecosystem.config.js stage",
     "deploy:prod": "pm2 deploy ecosystem.config.js prod",
-    "analyzer": "NODE_ENV=production ANALYZER=true webpack"
+    "analyzer": "NODE_ENV=production ANALYZER=true webpack",
+    "ca": "git add -A && git-cz -av",
+    "commit": "git-cz"
   },
   "engines": { "node": ">=8.9.4" },
   "deploy": {
@@ -44,6 +46,7 @@
     "css-loader": "^0.28.11",
     "file-loader": "^1.1.11",
     "html-loader": "^0.5.5",
+    "husky": "^1.0.1",
     "koa-webpack": "^3.0.2",
     "memory-fs": "^0.4.1",
     "pm2": "^2.10.2",
@@ -61,7 +64,11 @@
     "webpack-bundle-analyzer": "^2.11.1",
     "webpack-cli": "^2.0.14",
     "webpack-merge": "^4.1.2",
-    "webpack-node-externals": "^1.7.2"
+    "webpack-node-externals": "^1.7.2",
+    "commitizen": "^2.10.1",
+    "cz-conventional-changelog": "^2.1.0",
+    "@commitlint/cli": "^7.1.2",
+    "@commitlint/config-conventional": "^7.1.2"
   },
   "dependencies": {
     "babel-polyfill": "^6.26.0",

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+extends:`
	`2`	`+ - '@commitlint/config-conventional'`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{ "path": "cz-conventional-changelog" }`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`hooks:`
`2`	`2`	`pre-commit: 'npm test'`
	`3`	`+ commit-msg: 'commitlint -E HUSKY_GIT_PARAMS'`