mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
39 lines
834 B
TypeScript
39 lines
834 B
TypeScript
import { readFileSync } from 'fs-extra';
|
|
import { consola } from '../common/logger';
|
|
|
|
const commitRE = /^(revert: )?(fix|feat|docs|perf|test|types|style|build|chore|release|refactor|breaking change)(\(.+\))?: .{1,50}/;
|
|
const mergeRE = /Merge /;
|
|
|
|
export function commitLint(gitParams: string) {
|
|
const commitMsg = readFileSync(gitParams, 'utf-8').trim();
|
|
|
|
if (!commitRE.test(commitMsg) && !mergeRE.test(commitMsg)) {
|
|
consola.error(`invalid commit message: "${commitMsg}".
|
|
|
|
Proper commit message format is required for automated changelog generation.
|
|
|
|
Examples:
|
|
|
|
- fix(Button): incorrect style
|
|
- feat(Button): incorrect style
|
|
- docs(Button): fix typo
|
|
|
|
Allowed Types:
|
|
|
|
- fix
|
|
- feat
|
|
- docs
|
|
- perf
|
|
- test
|
|
- types
|
|
- build
|
|
- chore
|
|
- release
|
|
- refactor
|
|
- breaking change
|
|
- Merge branch 'foo' into 'bar'
|
|
`);
|
|
process.exit(1);
|
|
}
|
|
}
|