fix(semver): commitParserOptions support in changelog and semver bump

Author: Guilherme Prezzi

packages/semver/src/executors/version/__snapshots__/index.e2e.spec.ts.snap

@@ -314,3 +314,24 @@ This file was generated using [@jscutlery/semver](https://github.com/jscutlery/s
 * **a:** 🚀 new feature xxxxxxx
 "
 `;
+
+exports[`@jscutlery/semver @jscutlery/semver:version when using commitParserOptions and libs/d changed (v0.1.0 => v0.2.0) should generate CHANGELOG.md properly: d-0.2.0 1`] = `
+"# Changelog
+
+This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
+
+## [0.2.0](///compare/d-0.1.0...d-0.2.0) (yyyy-mm-dd)
+
+
+### ✨ Awesome features
+
+* **d:** 🚀 new feature xxxxxxx
+
+## 0.1.0 (yyyy-mm-dd)
+
+
+### ✨ Awesome features
+
+* **d:** 🚀 new awesome feature xxxxxxx
+"
+`;

packages/semver/src/executors/version/index.e2e.spec.ts

@@ -1,6 +1,9 @@
 import { execSync } from 'child_process';
 import { setupTestingWorkspace, type TestingWorkspace } from './testing';
 import { readFileSync, existsSync } from 'fs';
+import { ProjectConfiguration } from '@nx/devkit';
+import { writeFile } from './utils/filesystem';
+import { firstValueFrom } from 'rxjs';
 
 describe('@jscutlery/semver', () => {
   let testingWorkspace: TestingWorkspace;
@@ -21,9 +24,14 @@ describe('@jscutlery/semver', () => {
     // Lib d is publishable and use a custom preset.
     testingWorkspace.generateLib('d', '--publishable --importPath=@proj/d');
     testingWorkspace.installSemver('d', '--preset=conventionalcommits');
+    // macOS's BSD sed !== Linux's GNU sed
     testingWorkspace.exec(
       `
-        sed -i 's/"preset": "conventionalcommits"/"preset": { "types": [ { "type": "feat", "section": "✨ Awesome features" } ] }/g' libs/d/project.json
+        if [[ "$OSTYPE" == "darwin"* ]]; then
+          sed -i '' 's/"preset": "conventionalcommits"/"preset": { "types": [ { "type": "feat", "section": "✨ Awesome features" } ] }/g' libs/d/project.json
+        else
+          sed -i 's/"preset": "conventionalcommits"/"preset": { "types": [ { "type": "feat", "section": "✨ Awesome features" } ] }/g' libs/d/project.json
+        fi
       `,
     );
     testingWorkspace.exec(
@@ -403,6 +411,48 @@ describe('@jscutlery/semver', () => {
       });
     });
 
+    describe('when using commitParserOptions and libs/d changed (v0.1.0 => v0.2.0)', () => {
+      beforeAll(async () => {
+        const projectJson = JSON.parse(
+          readFile(`${testingWorkspace.root}/libs/d/project.json`),
+        );
+        projectJson.targets['version'].options.commitParserOptions = {
+          headerPattern:
+            '^([A-Z]{3,}-\\d{1,5}):? (chore|build|ci|docs|feat|fix|perf|refactor|test)(?:\\(([\\w-]+)\\))?\\S* (.+)$',
+          headerCorrespondence: ['ticketReference', 'type', 'scope', 'subject'],
+        };
+        await firstValueFrom(
+          writeFile(
+            `${testingWorkspace.root}/libs/d/project.json`,
+            JSON.stringify(projectJson, null, 2),
+          ),
+        );
+        console.log(readFile(`${testingWorkspace.root}/libs/d/project.json`));
+        testingWorkspace.exec(
+          `
+              echo feat >> libs/d/d.txt
+              git add .
+              git commit -m "TKT-1010: feat(d): 🚀 new feature"
+            `,
+        );
+        testingWorkspace.runNx(`run d:version --noVerify`);
+      });
+
+      it('should semver bump properly based on the custom commit header', () => {
+        expect(
+          readFile(`${testingWorkspace.root}/libs/d/package.json`),
+        ).toMatch(/"version": "0.2.0"/);
+      });
+
+      it('should generate CHANGELOG.md properly', () => {
+        expect(
+          deterministicChangelog(
+            readFile(`${testingWorkspace.root}/libs/d/CHANGELOG.md`),
+          ),
+        ).toMatchSnapshot('d-0.2.0');
+      });
+    });
+
     describe('when libs/b changed with --skipCommit (v0.1.0 => v0.2.0)', () => {
       beforeAll(() => {
         testingWorkspace.exec(

packages/semver/src/executors/version/index.ts

@@ -138,6 +138,7 @@ export default async function version(
         dependencyUpdates,
         skipCommit,
         skipStage,
+        commitParserOptions,
         workspace: context.projectsConfigurations,
       };
 

packages/semver/src/executors/version/schema.d.ts

@@ -47,4 +47,5 @@ export interface WriteChangelogConfig {
   dryRun?: boolean;
   changelogPath: string;
   tagPrefix: string;
+  commitParserOptions?: CommitParserOptions;
 }

packages/semver/src/executors/version/utils/changelog.ts

@@ -15,6 +15,7 @@ import type { Version } from '../version';
 import { diff } from './diff';
 import { readFile, readFileIfExists, writeFile } from './filesystem';
 import { PresetOpt } from '../schema';
+import { Options as CommitParserOptions } from 'conventional-commits-parser';
 export const defaultHeader = `# Changelog
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
@@ -33,13 +34,15 @@ export function updateChangelog({
   newVersion,
   changelogHeader,
   tagPrefix,
+  commitParserOptions,
 }: {
   projectRoot: string;
   dryRun: boolean;
   preset: PresetOpt;
   newVersion: string;
   tagPrefix: string;
   changelogHeader: string;
+  commitParserOptions?: CommitParserOptions;
 }): Observable<string> {
   return defer(async () => {
     const changelogPath = getChangelogPath(projectRoot);
@@ -51,6 +54,7 @@ export function updateChangelog({
         projectRoot,
         preset,
         tagPrefix,
+        commitParserOptions,
       },
       newVersion,
     );

packages/semver/src/executors/version/utils/conventional-commit.ts

@@ -19,5 +19,6 @@ export function createConventionalCommitStream(
     { version: newVersion },
     /// @ts-expect-error - Partially typed API
     { path: config.projectRoot },
+    config.commitParserOptions,
   );
 }

packages/semver/src/executors/version/utils/try-bump.spec.ts

@@ -68,11 +68,14 @@ describe('tryBump', () => {
     });
 
     expect(mockConventionalRecommendedBump).toBeCalledTimes(1);
-    expect(mockConventionalRecommendedBump).toBeCalledWith({
-      path: '/libs/demo',
-      preset: 'angular',
-      tagPrefix: 'v',
-    });
+    expect(mockConventionalRecommendedBump).toBeCalledWith(
+      {
+        path: '/libs/demo',
+        preset: 'angular',
+        tagPrefix: 'v',
+      },
+      undefined,
+    );
   });
 
   it('should compute the next version based on last version, changes, and dependencies', async () => {
@@ -130,11 +133,14 @@ describe('tryBump', () => {
     });
 
     expect(mockConventionalRecommendedBump).toBeCalledTimes(1);
-    expect(mockConventionalRecommendedBump).toBeCalledWith({
-      path: '/libs/demo',
-      preset: 'angular',
-      tagPrefix: 'v',
-    });
+    expect(mockConventionalRecommendedBump).toBeCalledWith(
+      {
+        path: '/libs/demo',
+        preset: 'angular',
+        tagPrefix: 'v',
+      },
+      undefined,
+    );
   });
 
   it('should use given type to calculate next version', async () => {

packages/semver/src/executors/version/utils/try-bump.ts

@@ -158,6 +158,7 @@ export function tryBump({
         tagPrefix,
         releaseType,
         preid,
+        commitParserOptions,
       }).pipe(map((version) => ({ type: 'project', version })));
 
       const dependencyVersions$ = _getDependencyVersions({
@@ -233,22 +234,27 @@ export function _semverBump({
   tagPrefix,
   releaseType,
   preid,
+  commitParserOptions,
 }: {
   since: string;
   preset: PresetOpt;
   projectRoot: string;
   tagPrefix: string;
   releaseType?: ReleaseIdentifier;
   preid?: string;
+  commitParserOptions?: CommitParserOptions;
 }) {
   return defer(async () => {
-    const recommended = await conventionalRecommendedBump({
-      path: projectRoot,
-      tagPrefix,
-      ...(typeof preset === 'string'
-        ? { preset }
-        : { preset: preset.name ?? 'conventionalcommits', config: preset }),
-    });
+    const recommended = await conventionalRecommendedBump(
+      {
+        path: projectRoot,
+        tagPrefix,
+        ...(typeof preset === 'string'
+          ? { preset }
+          : { preset: preset.name ?? 'conventionalcommits', config: preset }),
+      },
+      commitParserOptions,
+    );
 
     let recommendedReleaseType: ReleaseIdentifier | undefined =
       recommended.releaseType;
@@ -368,6 +374,7 @@ export function _getDependencyVersions({
               preset,
               projectRoot,
               tagPrefix,
+              commitParserOptions,
             }).pipe(
               map(
                 (version) =>

packages/semver/src/executors/version/version.ts

@@ -1,6 +1,7 @@
 import { ProjectsConfigurations } from '@nx/devkit';
 import { forkJoin, Observable, of } from 'rxjs';
 import { concatMap, map } from 'rxjs/operators';
+import type { Options as CommitParserOptions } from 'conventional-commits-parser';
 import { PresetOpt } from './schema';
 import {
   insertChangelogDependencyUpdates,
@@ -40,6 +41,7 @@ export interface CommonVersionOptions {
   dependencyUpdates: Version[];
   preset: PresetOpt;
   workspace: ProjectsConfigurations | undefined;
+  commitParserOptions?: CommitParserOptions;
 }
 
 export function versionWorkspace({