aboutsummaryrefslogtreecommitdiff
path: root/scripts/verifyCommit.ts
blob: 611c3a35dc40ebcb4ffae65a8c6226bf455d00c3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
/* eslint-disable @typescript-eslint/restrict-plus-operands */
/* eslint-disable @typescript-eslint/restrict-template-expressions */

// Invoked on the commit-msg git hook by simple-git-hooks.

import { readFileSync } from 'fs';
import colors from 'picocolors';

// get $1 from commit-msg script
const msgPath = process.argv[2];
const msg = readFileSync(msgPath, 'utf-8').trim();

const releaseRE = /^v\d/;
const commitRE =
  /^(feat|fix|chore|refactor|docs|test|ci|build|infra|revert|)(\(.+\))?\!?: .{1,50}/;

const isMergeCommit = msg.startsWith('Merge remote-tracking-branch');

if (!isMergeCommit && !releaseRE.test(msg) && !commitRE.test(msg)) {
  console.log();

  console.error(
    `  ${colors.bgRed(colors.white(' ERROR '))} ${colors.red(
      `invalid commit message format.`
    )}

  ${colors.red(
    `Proper commit message format is required for automated changelog generation. Examples:`
  )}

  ${colors.green(`feat: add 'comments' option`)}
  ${colors.green(`fix: handle events on blur (close #28)`)}

  ${colors.red(`See .github/commit-convention.md for more details.`)}
`
  );

  process.exit(1);
}