aboutsummaryrefslogtreecommitdiff
path: root/scripts
diff options
context:
space:
mode:
Diffstat (limited to 'scripts')
-rw-r--r--scripts/verifyCommit.ts28
1 files changed, 28 insertions, 0 deletions
diff --git a/scripts/verifyCommit.ts b/scripts/verifyCommit.ts
new file mode 100644
index 00000000..2584cc37
--- /dev/null
+++ b/scripts/verifyCommit.ts
@@ -0,0 +1,28 @@
+// Invoked on the commit-msg git hook by simple-git-hooks.
+
+import colors from 'picocolors';
+import { readFileSync } from 'fs';
+
+// get $1 from commit-msg script
+const msgPath = process.argv[2];
+const msg = readFileSync(msgPath, 'utf-8').trim();
+
+const releaseRE = /^v\d/;
+const commitRE =
+ /^(revert: )?(feat|fix|docs|dx|refactor|perf|test|workflow|build|ci|chore|types|wip|release|deps)(\(.+\))?: .{1,50}/;
+
+if (!releaseRE.test(msg) && !commitRE.test(msg)) {
+ console.log();
+ console.error(
+ ` ${colors.bgRed(colors.white(' ERROR '))} ${colors.red(
+ `invalid commit message format.`
+ )}\n\n` +
+ colors.red(
+ ` Proper commit message format is required for automated changelog generation. Examples:\n\n`
+ ) +
+ ` ${colors.green(`feat: add 'comments' option`)}\n` +
+ ` ${colors.green(`fix: handle events on blur (close #28)`)}\n\n` +
+ colors.red(` See .github/commit-convention.md for more details.\n`)
+ );
+ process.exit(1);
+}