fix: breaking changes are now recognized as meaningful

README.md

@@ -59,8 +59,9 @@ This is a release commit. Returning false.
 Based on a commit's conventional commit message type:
 
 1. If the type is `feat` `fix`, or `perf`, it's considered "meaningful"
-2. If the type is `docs`, `refactor`, `style`, or `test`, it's ignored
-3. If the message looks like `v1.2.3`, `chore: release 1.2.3`, or similar, it's considered a "release"
+2. If the commit is marked as being a breaking change, either via a note or via an `!` appended to the type, it's considered "meaningful"
+3. If the type is `docs`, `refactor`, `style`, or `test`, it's ignored
+4. If the message looks like `v1.2.3`, `chore: release 1.2.3`, or similar, it's considered a "release"
 
 See [`getCommitMeaning`](./src/getCommitMeaning.ts) for the exact logic used.
 

package.json

@@ -39,12 +39,11 @@
 		"*": "prettier --ignore-unknown --write"
 	},
 	"dependencies": {
-		"@pkgjs/parseargs": "^0.11.0",
-		"conventional-commits-parser": "^5.0.0"
+		"@conventional-commits/parser": "^0.4.1",
+		"@pkgjs/parseargs": "^0.11.0"
 	},
 	"devDependencies": {
 		"@release-it/conventional-changelog": "^8.0.0",
-		"@types/conventional-commits-parser": "^3.0.4",
 		"@types/eslint": "^8.44.3",
 		"@types/pkgjs__parseargs": "^0.10.1",
 		"@typescript-eslint/eslint-plugin": "^6.7.3",

src/getCommitMeaning.test.ts

@@ -40,6 +40,17 @@ describe("getCommitMeaning", () => {
 		["chore(deps): release", "release"],
 		["chore(deps): release 1.2.3", "release"],
 		["chore(deps): release v1.2.3", "release"],
+		// Breaking changes are meaningful no matter the type of the commit.
+		["chore!: message", "meaningful"],
+		["docs!: message", "meaningful"],
+		["style!: message", "meaningful"],
+		["chore!: release", "meaningful"],
+		["chore: bump\n\nBREAKING CHANGE: breaks things", "meaningful"],
+		["chore: bump\n\nBREAKING-CHANGE: breaks things", "meaningful"],
+		["docs: bump\n\nBREAKING CHANGE: breaks things", "meaningful"],
+		["docs: bump\n\nBREAKING-CHANGE: breaks things", "meaningful"],
+		["style: bump\n\nBREAKING CHANGE: breaks things", "meaningful"],
+		["style: bump\n\nBREAKING-CHANGE: breaks things", "meaningful"],
 	])("returns %j for %s", (input, expected) => {
 		expect(getCommitMeaning(input)).toEqual(expected);
 	});

src/getCommitMeaning.ts

@@ -1,4 +1,7 @@
-import conventionalCommitsParser from "conventional-commits-parser";
+import {
+	parser,
+	toConventionalChangelogFormat,
+} from "@conventional-commits/parser";
 
 const alwaysMeaningfulTypes = new Set(["feat", "fix", "perf"]);
 
@@ -8,22 +11,31 @@ 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 { type } = conventionalCommitsParser.sync(message);
-	if (type) {
-		if (alwaysMeaningfulTypes.has(type)) {
+	let type = undefined;
+	try {
+		const messageAst = parser(message);
+		const commit = toConventionalChangelogFormat(messageAst);
+		type = commit.type;
+
+		// Some types are always meaningful or ignored, regardless of potentially release-like messages
+		if (
+			alwaysMeaningfulTypes.has(type) ||
+			commit.notes.some(({ title }) => title === "BREAKING CHANGE")
+		) {
 			return "meaningful";
 		}
 
 		if (alwaysIgnoredTypes.has(type)) {
 			return { type };
 		}
+	} catch {
+		/* empty */
 	}
 
 	// 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 };
+	return { type };
 }