mirror of https://github.com/vuejs/core.git
40 lines
1.2 KiB
JavaScript
40 lines
1.2 KiB
JavaScript
// @ts-check
|
|
import pico from 'picocolors'
|
|
import { readFileSync } from 'node:fs'
|
|
import path from 'node:path'
|
|
import { exec } from './utils.js'
|
|
|
|
main()
|
|
|
|
async function main() {
|
|
const { stdout: branch } = await exec('git', ['branch', '--show-current'])
|
|
// only verify commit message on main and minor branches
|
|
if (branch !== 'main' && branch !== 'minor') {
|
|
return
|
|
}
|
|
|
|
const msgPath = path.resolve('.git/COMMIT_EDITMSG')
|
|
const msg = readFileSync(msgPath, 'utf-8').trim()
|
|
|
|
const commitRE =
|
|
/^(revert: )?(feat|fix|docs|dx|style|refactor|perf|test|workflow|build|ci|chore|types|wip|release)(\(.+\))?: .{1,50}/
|
|
|
|
if (!commitRE.test(msg)) {
|
|
console.log()
|
|
console.error(
|
|
` ${pico.white(pico.bgRed(' ERROR '))} ${pico.red(
|
|
`invalid commit message format.`,
|
|
)}\n\n` +
|
|
pico.red(
|
|
` Proper commit message format is required for automated changelog generation. Examples:\n\n`,
|
|
) +
|
|
` ${pico.green(`feat(compiler): add 'comments' option`)}\n` +
|
|
` ${pico.green(
|
|
`fix(v-model): handle events on blur (close #28)`,
|
|
)}\n\n` +
|
|
pico.red(` See .github/commit-convention.md for more details.\n`),
|
|
)
|
|
process.exit(1)
|
|
}
|
|
}
|