feat: support latest conventional-changelog packages

BREAKING CHANGE: by supporting the latest major versions of conventional-changelog packages, we are
dropping support for previous major versions of those packages due to the breaking changes between
majors. this only impacts your project if you are installing alongside semantic-release, so updating
those packages to latest version should be the only change you need for this update. no action
should be necessary if you are using default semantic-release config

Author: travi

index.js

@@ -1,6 +1,6 @@
 import { isUndefined } from "lodash-es";
-import { sync as parser } from "conventional-commits-parser";
-import filter from "conventional-commits-filter";
+import { CommitParser } from "conventional-commits-parser";
+import { filterRevertedCommitsSync } from "conventional-commits-filter";
 import debugFactory from "debug";
 import loadParserConfig from "./lib/load-parser-config.js";
 import loadReleaseRules from "./lib/load-release-rules.js";
@@ -31,7 +31,8 @@ export async function analyzeCommits(pluginConfig, context) {
   const config = await loadParserConfig(pluginConfig, context);
   let releaseType = null;
 
-  filter(
+  const parser = new CommitParser(config)
+  const filteredCommits = filterRevertedCommitsSync(
     commits
       .filter(({ message, hash }) => {
         if (!message.trim()) {
@@ -41,9 +42,15 @@ export async function analyzeCommits(pluginConfig, context) {
 
         return true;
       })
-      .map(({ message, ...commitProps }) => ({ rawMsg: message, message, ...commitProps, ...parser(message, config) }))
-  ).every(({ rawMsg, ...commit }) => {
-    logger.log(`Analyzing commit: %s`, rawMsg);
+      .map((rawCommit) => ({
+        ...rawCommit,
+        ...parser.parse(rawCommit.message)
+      }))
+  );
+
+  for (const { message, ...commit } of filteredCommits) {
+    console.log(`Analyzing commit: %s`, message)
+    logger.log(`Analyzing commit: %s`, message);
     let commitReleaseType;
 
     // Determine release type based on custom releaseRules
@@ -71,11 +78,10 @@ export async function analyzeCommits(pluginConfig, context) {
 
     // Break loop if releaseType is the highest
     if (releaseType === RELEASE_TYPES[0]) {
-      return false;
+      break;
     }
+  }
 
-    return true;
-  });
   logger.log("Analysis of %s commits complete: %s release", commits.length, releaseType || "no");
 
   return releaseType;

lib/load-parser-config.js

@@ -30,5 +30,5 @@ export default async ({ preset, config, parserOpts, presetConfig }, { cwd }) =>
     loadedConfig = await conventionalChangelogAngular();
   }
 
-  return { ...loadedConfig.parserOpts, ...parserOpts };
+  return { ...loadedConfig.parser, ...parserOpts };
 };

package-lock.json

@@ -18,9 +18,10 @@
     "Gregor Martynus (https://twitter.com/gr2m)"
   ],
   "dependencies": {
-    "conventional-changelog-angular": "^7.0.0",
-    "conventional-commits-filter": "^4.0.0",
-    "conventional-commits-parser": "^5.0.0",
+    "conventional-changelog-angular": "^8.0.0",
+    "conventional-changelog-writer": "^8.0.0",
+    "conventional-commits-filter": "^5.0.0",
+    "conventional-commits-parser": "^6.0.0",
     "debug": "^4.0.0",
     "import-from-esm": "^1.0.3",
     "lodash-es": "^4.17.21",
@@ -29,12 +30,12 @@
   "devDependencies": {
     "ava": "6.1.3",
     "c8": "9.1.0",
-    "conventional-changelog-atom": "4.0.0",
-    "conventional-changelog-conventionalcommits": "7.0.2",
-    "conventional-changelog-ember": "4.0.0",
-    "conventional-changelog-eslint": "5.0.0",
-    "conventional-changelog-express": "4.0.0",
-    "conventional-changelog-jshint": "4.0.0",
+    "conventional-changelog-atom": "5.0.0",
+    "conventional-changelog-conventionalcommits": "8.0.0",
+    "conventional-changelog-ember": "5.0.0",
+    "conventional-changelog-eslint": "6.0.0",
+    "conventional-changelog-express": "5.0.0",
+    "conventional-changelog-jshint": "5.0.0",
     "lockfile-lint": "4.13.2",
     "ls-engines": "0.9.1",
     "npm-run-all2": "6.2.0",

package.json

@@ -99,9 +99,9 @@ test('Accept a partial "parseOpts" object as option', async (t) => {
 
 test("Exclude commits if they have a matching revert commits", async (t) => {
   const commits = [
-    { message: "fix(scope): First fix" },
-    { hash: "456", message: "revert: feat(scope): First feature\n\nThis reverts commit 123.\n" },
-    { hash: "123", message: "feat(scope): First feature" },
+    { hash: "df012f1", message: "fix(scope): First fix" },
+    { hash: "df012f2", message: "revert: feat(scope): First feature\n\nThis reverts commit df012f3.\n" },
+    { hash: "df012f3", message: "feat(scope): First feature" },
   ];
   const releaseType = await analyzeCommits({}, { cwd, commits, logger: t.context.logger });