vue/scripts/verify-commit-msg.js

25 lines
842 B
JavaScript
Raw Permalink Normal View History

2018-01-06 15:08:47 +00:00
const chalk = require('chalk')
const msgPath = process.env.GIT_PARAMS
const msg = require('fs').readFileSync(msgPath, 'utf-8').trim()
2022-05-24 13:49:09 +00:00
const commitRE =
/^(revert: )?(wip|release|feat|fix|polish|docs|style|refactor|perf|test|workflow|ci|chore|types|build)(\(.+\))?: .{1,50}/
2018-01-06 15:08:47 +00:00
if (!commitRE.test(msg)) {
console.log()
console.error(
2022-05-24 13:49:09 +00:00
` ${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`)
2018-01-06 15:08:47 +00:00
)
process.exit(1)
}