-
-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(changelog): add commit message verification
- Loading branch information
Showing
2 changed files
with
30 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
const chalk = require('chalk') // eslint-disable-line | ||
const msgPath = process.env.GIT_PARAMS | ||
const msg = require('fs').readFileSync(msgPath, 'utf-8').trim() | ||
|
||
const commitRE = /^(v\d+\.\d+\.\d+(-(alpha|beta|rc.\d+))?$)|((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) | ||
} |