mirror of
https://github.com/vuejs/vue-cli.git
synced 2026-01-15 11:50:19 -06:00
workflow: enforce commit format
This commit is contained in:
@@ -17,7 +17,8 @@
|
||||
"boot": "node scripts/bootstrap.js"
|
||||
},
|
||||
"gitHooks": {
|
||||
"pre-commit": "lint-staged"
|
||||
"pre-commit": "lint-staged",
|
||||
"commit-msg": "node scripts/verifyCommitMsg.js"
|
||||
},
|
||||
"jest": {
|
||||
"testEnvironment": "node",
|
||||
|
||||
18
scripts/verifyCommitMsg.js
Normal file
18
scripts/verifyCommitMsg.js
Normal file
@@ -0,0 +1,18 @@
|
||||
const chalk = require('chalk')
|
||||
const msgPath = process.env.GIT_PARAMS
|
||||
const msg = require('fs').readFileSync(msgPath, 'utf-8').trim()
|
||||
|
||||
const commitRE = /^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|ci|chore|types)(\(.+\))?: .{1,50}/
|
||||
|
||||
if (!commitRE.test(msg)) {
|
||||
console.log()
|
||||
console.error(
|
||||
` ${chalk.bgRed.white(' ERROR ')} ${chalk.red(`invalid commit message format.`)}\n\n` +
|
||||
chalk.red(` Proper commit message format is required for automated changelog generation. Examples:\n\n`) +
|
||||
` ${chalk.green(`feat(compiler): add 'comments' option`)}\n` +
|
||||
` ${chalk.green(`fix(v-model): handle events on blur (close #28)`)}\n\n` +
|
||||
chalk.red(` See .github/COMMIT_CONVENTION.md for more details.\n`) +
|
||||
chalk.red(` You can also use ${chalk.cyan(`npm run commit`)} to interactively generate a commit message.\n`)
|
||||
)
|
||||
process.exit(1)
|
||||
}
|
||||
Reference in New Issue
Block a user