@wroud/conventional-commits-parser/src/parseConventionalCommit.test.ts

A lightweight parser for conventional commits that supports extracting commit metadata, generating commit messages, and managing commit trailers in TypeScript.

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: "tester@example.com",
      subject: "feat!: changed API",
      body: "This change breaks things\n",
      trailers: [],
      links: {},
    };

    expect(parseConventionalCommit(commit)).toMatchSnapshot();
  });
});