feat(git): add git package (#6)

.github/workflows/title.yml

@@ -38,4 +38,5 @@ jobs:
             http
             git
             github
+            git
             testing

core/git/conventional.ts

@@ -0,0 +1,43 @@
+import type { Commit } from "@roka/git";
+import { assert } from "@std/assert";
+
+/**
+ * A commit object that exposes conventional commit details.
+ *
+ * For example, a commit summary like `feat(cli): add new command` will have
+ * its type set to `feat` and modules set to `cli`.
+ *
+ * A {@linkcode ConventionalCommit} object can be converted to a
+ * {@linkcode ConventionalCommit} using the {@linkcode conventional} function.
+ *
+ * @see {@link https://www.conventionalcommits.org|Conventional Commits}
+ */
+export interface ConventionalCommit extends Commit {
+  /** Conventional commits: Commit description. */
+  description: string;
+  /** Conventional commits: Commit type. */
+  type: string | undefined;
+  /** Conventional commits: Modules affected by the commit. */
+  modules: string[];
+  /** Conventional commits: Whether the commit is a breaking change. */
+  breaking: boolean;
+}
+
+const SUMMARY_PATTERN =
+  /^(?:(?<type>[a-z]+)(?:\((?<modules>[^()]*)\))?(?<breaking>!?):s*)?\s*(?<description>[^\s].*)$/;
+
+/** Creates a commit object with conventional commit details. */
+export function conventional(commit: Commit): ConventionalCommit {
+  const match = commit.summary?.match(SUMMARY_PATTERN);
+  const footerBreaking = commit.body?.match(
+    /(^|\n\n)BREAKING CHANGE: (.+)($|\n)/,
+  );
+  assert(match?.groups?.description, "Commit must have description");
+  return {
+    ...commit,
+    description: match.groups.description,
+    type: match.groups.type,
+    modules: match.groups.modules?.split(",").map((m) => m.trim()) ?? [],
+    breaking: !!footerBreaking || !!match.groups.breaking,
+  };
+}

core/git/conventional_test.ts

@@ -0,0 +1,94 @@
+import type { Commit } from "@roka/git";
+import { conventional } from "@roka/git/conventional";
+import { assertEquals } from "@std/assert";
+
+function testCommit(summary: string): Commit {
+  return {
+    hash: "hash",
+    short: "short",
+    author: { name: "author-name", email: "author-email" },
+    committer: { name: "committer-name", email: "committer-email" },
+    summary: summary,
+    body: "body",
+  };
+}
+
+Deno.test("conventional() creates conventional commits", () => {
+  const commit = testCommit("feat(module): description");
+  assertEquals(conventional(commit), {
+    ...commit,
+    description: "description",
+    type: "feat",
+    modules: ["module"],
+    breaking: false,
+  });
+});
+
+Deno.test("conventional() accepts be simple commits", () => {
+  const commit = testCommit("description");
+  assertEquals(conventional(commit), {
+    ...commit,
+    description: "description",
+    type: undefined,
+    modules: [],
+    breaking: false,
+  });
+});
+
+Deno.test("conventional() can create breaking commits", () => {
+  const commit = testCommit("feat!: description");
+  assertEquals(conventional(commit), {
+    ...commit,
+    description: "description",
+    type: "feat",
+    modules: [],
+    breaking: true,
+  });
+});
+
+Deno.test("conventional() can create breaking commits from footer", () => {
+  const commit = {
+    ...testCommit("feat: description"),
+    body: "BREAKING CHANGE: breaking",
+  };
+  assertEquals(conventional(commit), {
+    ...commit,
+    description: "description",
+    type: "feat",
+    modules: [],
+    breaking: true,
+  });
+});
+
+Deno.test("conventional() can create breaking commit with module", () => {
+  const commit = testCommit("feat(module)!: description");
+  assertEquals(conventional(commit), {
+    ...commit,
+    description: "description",
+    type: "feat",
+    modules: ["module"],
+    breaking: true,
+  });
+});
+
+Deno.test("conventional() can create multiple modules", () => {
+  const commit = testCommit("feat(module1,module2): description");
+  assertEquals(conventional(commit), {
+    ...commit,
+    description: "description",
+    type: "feat",
+    modules: ["module1", "module2"],
+    breaking: false,
+  });
+});
+
+Deno.test("conventional() commits must have a description", () => {
+  const commit = testCommit("feat(module): ");
+  assertEquals(conventional(commit), {
+    ...commit,
+    description: "feat(module): ",
+    type: undefined,
+    modules: [],
+    breaking: false,
+  });
+});

core/git/deno.json

@@ -0,0 +1,7 @@
+{
+  "name": "@roka/git",
+  "exports": {
+    ".": "./git.ts",
+    "./conventional": "./conventional.ts"
+  }
+}