2018-09-19 23:35:38 +08:00
|
|
|
// Invoked on the commit-msg git hook by yorkie.
|
|
|
|
|
|
|
|
|
|
const chalk = require('chalk')
|
|
|
|
|
const msgPath = process.env.GIT_PARAMS
|
|
|
|
|
const msg = require('fs')
|
|
|
|
|
.readFileSync(msgPath, 'utf-8')
|
|
|
|
|
.trim()
|
|
|
|
|
|
2019-03-01 01:50:01 +08:00
|
|
|
const commitRE = /^(revert: )?(feat|fix|docs|dx|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\(.+\))?: .{1,50}/
|
2018-09-19 23:35:38 +08:00
|
|
|
|
|
|
|
|
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)
|
|
|
|
|
}
|
