getCommitMeaning.ts

import conventionalCommitsParser from "conventional-commits-parser";

const alwaysMeaningfulTypes = new Set(["feat", "fix", "perf"]);

const alwaysIgnoredTypes = new Set(["docs", "refactor", "style", "test"]);

const releaseCommitTester =
	/^(?:chore(?:\(.*\))?:?)?\s*release|v?\d+\.\d+\.\d+/;

export function getCommitMeaning(message: string) {
	// Some types are always meaningful or ignored, regardless of potentially release-like messages
	const { header, notes, type } = conventionalCommitsParser.sync(message, {
		breakingHeaderPattern: /^(\w*)(?:\((.*)\))?!: (.*)$/,
	});
	if (
		notes.some((note) => note.title.match(/^BREAKING[ -]CHANGE$/)) ||
		header?.match(/^BREAKING[ -]CHANGE(?: \([^)]+\))?:/)
	) {
		return "meaningful";
	}

	if (type) {
		if (alwaysMeaningfulTypes.has(type)) {
			return "meaningful";
		}

		if (alwaysIgnoredTypes.has(type)) {
			return { type };
		}
	}

	// If we've hit a release commit, we know we don't need to release
	if (releaseCommitTester.test(message)) {
		return "release";
	}

	return { type: type ?? undefined };
}