@wroud/conventional-commits-parser - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

src/gitTrailersConventionalCommits.ts

+export const gitTrailersConventionalCommits = [
+  /^(?<token>BREAKING CHANGE):[\s\t]*(?<value>.+)$/,
+];

src/IConventionalCommit.ts

+import type { IGitCommitInfo } from "@wroud/git";
+
+export interface IConventionalCommit {
+  commitInfo: IGitCommitInfo;
+  type: string;
+  scope?: string;
+  description: string;
+  body?: string;
+  breakingChanges: string[];
+}

src/index.ts

+export * from "./IConventionalCommit.js";
+export * from "./parseConventionalCommit.js";
+export * from "./gitTrailersConventionalCommits.js";

src/parseConventionalCommit.test.ts

+import { describe, expect, it } from "vitest";
+import { parseConventionalCommit } from "./parseConventionalCommit.js";
+import { readFile } from "fs/promises";
+import path from "path";
+
+describe("parseConventionalCommit", () => {
+  it("without", async () => {
+    const data = await readFile(
+      path.join(
+        import.meta.dirname,
+        "../__testfixtures__/fixture.git-commits.json",
+      ),
+      "utf8",
+    );
+    const commits = JSON.parse(data);
+    expect(commits.map(parseConventionalCommit)).toMatchSnapshot();
+  });
+
+  it("breaking body", () => {
+    const commit = {
+      hash: "abcdef1",
+      tags: [],
+      authorName: "Tester",
+      authorEmail: "[e-mail]",
+      subject: "feat!: changed API",
+      body: "This change breaks things\n",
+      trailers: [],
+      links: {},
+    };
+
+    expect(parseConventionalCommit(commit)).toMatchSnapshot();
+  });
+});

src/parseConventionalCommit.ts

+import type { IGitCommitInfo } from "@wroud/git";
+import type { IConventionalCommit } from "./IConventionalCommit.js";
+
+const headerRegex =
+  /^(?<type>[\w-]+)(\((?<scope>[\w-]+)\))?(?<breaking>!)?:\s(?<description>[\S\s]*)/;
+
+export function parseConventionalCommit(
+  commitInfo: IGitCommitInfo,
+): IConventionalCommit | null {
+  const match = headerRegex.exec(commitInfo.subject);
+  if (!match) {
+    return null;
+  }
+
+  const breakingChanges: string[] = [];
+  const { type, breaking, scope, description } = match.groups as {
+    type: string;
+    breaking?: string;
+    scope?: string;
+    description: string;
+  };
+
+  const rawBody = commitInfo.body?.trim() || "";
+
+  if (breaking) {
+    if (rawBody) {
+      breakingChanges.push(rawBody);
+    } else {
+      breakingChanges.push(description);
+    }
+  }
+
+  for (const trailer of commitInfo.trailers) {
+    const value = trailer.value.trim();
+
+    if (
+      trailer.token === "BREAKING CHANGE" ||
+      trailer.token === "BREAKING-CHANGE"
+    ) {
+      breakingChanges.push(value);
+      continue;
+    }
+  }
+
+  const body = rawBody || undefined;
+
+  const uniqueBreakingChanges = Array.from(new Set(breakingChanges));
+
+  return {
+    commitInfo,
+    type: type.toLowerCase(),
+    scope: scope || undefined,
+    description,
+    body,
+    breakingChanges: uniqueBreakingChanges,
+  };
+}

CHANGELOG.md

@@ -6,2 +6,12 @@ <!-- header -->
 
+<!-- version:0.2.1 -->
+## 0.2.1 (2025-09-22)
+
+[Compare changes](https://github.com/Wroud/foundation/compare/cc-parser-v0.2.0...cc-parser-v0.2.1)
+
+<!-- changelog -->
+### 🩹 Fixes
+
+- publish sources to npm for source maps ([0631b68](https://github.com/Wroud/foundation/commit/0631b68))
+
 <!-- version:0.2.0 -->
@@ -8,0 +18,0 @@ ## 0.2.0 (2025-06-05)

package.json

 {
   "name": "@wroud/conventional-commits-parser",
   "description": "A lightweight parser for conventional commits that supports extracting commit metadata, generating commit messages, and managing commit trailers in TypeScript.",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "type": "module",
@@ -16,2 +16,3 @@ "packageManager": "yarn@4.9.1",
     "lib",
+    "src",
     "!lib/**/*.d.ts.map",
@@ -18,0 +19,0 @@ "!lib/**/*.test.js",

New alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

13144

29.59%

Number of package files

21

31.25%

Lines of code

151

155.93%

Worsened metrics

Number of low supply chain risk alerts

3

200%

No dependency changes