better-commits 1.19.0 → 1.20.0-cli-flags

package/src/utils/build-branch.test.ts

@@ -0,0 +1,141 @@
+import { describe, expect, it } from "vitest";
+import { parse } from "valibot";
+import { BranchState, Config } from "../valibot-state";
+import { build_branch, build_worktree_path } from "./build-branch";
+
+function make_config(input: Record<string, unknown> = {}) {
+  return parse(Config, input);
+}
+
+function make_branch(input: Record<string, unknown>) {
+  return parse(BranchState, input);
+}
+
+describe("build_branch", () => {
+  it("builds branch with default order and separators", () => {
+    const branch = make_branch({
+      user: "erik",
+      version: "1.2.0",
+      type: "feat",
+      ticket: "ABC-1",
+      description: "add-parser",
+    });
+    const config = make_config();
+
+    expect(build_branch(branch, config)).toBe(
+      "erik/1.2.0/feat/ABC-1-add-parser",
+    );
+  });
+
+  it("omits empty fields without leaving trailing separators", () => {
+    const branch = make_branch({
+      user: "erik",
+      type: "fix",
+      description: "repair-parser",
+    });
+    const config = make_config();
+
+    expect(build_branch(branch, config)).toBe("erik/fix/repair-parser");
+  });
+
+  it("respects custom branch order", () => {
+    const branch = make_branch({
+      type: "feat",
+      ticket: "ABC-1",
+      description: "add-parser",
+      user: "erik",
+    });
+    const config = make_config({
+      branch_order: ["type", "ticket", "description", "user"],
+      branch_description: { separator: "/" },
+    });
+
+    expect(build_branch(branch, config)).toBe("feat/ABC-1-add-parser/erik");
+  });
+
+  it("uses per-field separator config", () => {
+    const branch = make_branch({
+      user: "erik",
+      type: "feat",
+      ticket: "ABC-1",
+      description: "parser",
+    });
+    const config = make_config({
+      branch_user: { separator: "_" },
+      branch_type: { separator: "-" },
+      branch_ticket: { separator: "_" },
+      branch_description: { separator: "" },
+      branch_order: ["user", "type", "ticket", "description"],
+    });
+
+    expect(build_branch(branch, config)).toBe("erik_feat-ABC-1_parser");
+  });
+});
+
+describe("build_worktree_path", () => {
+  it("builds path from template tokens", () => {
+    const branch = make_branch({
+      user: "erik",
+      type: "feat",
+      ticket: "ABC-1",
+      description: "add-parser",
+      version: "1.2.0",
+    });
+    const config = make_config({
+      worktrees: {
+        base_path: "../worktrees",
+        folder_template: "{{repo_name}}-{{ticket}}-{{branch_description}}",
+      },
+    });
+
+    const result = build_worktree_path(branch, config, "/tmp/my-repo");
+    expect(result).toBe("../worktrees/my-repo-ABC-1-add-parser");
+  });
+
+  it("handles base_path with trailing slash", () => {
+    const branch = make_branch({
+      description: "add-parser",
+    });
+    const config = make_config({
+      worktrees: {
+        base_path: "../wt/",
+        folder_template: "{{repo_name}}-{{branch_description}}",
+      },
+    });
+
+    const result = build_worktree_path(branch, config, "/tmp/repo");
+    expect(result).toBe("../wt/repo-add-parser");
+  });
+
+  it("normalizes repeated dashes and trims edges", () => {
+    const branch = make_branch({
+      ticket: "",
+      description: "parser",
+    });
+    const config = make_config({
+      worktrees: {
+        base_path: "../wt",
+        folder_template: "-{{repo_name}}--{{ticket}}--{{branch_description}}-",
+      },
+    });
+
+    const result = build_worktree_path(branch, config, "/tmp/repo");
+    expect(result).toBe("../wt/repo-parser");
+  });
+
+  it("removes whitespace from rendered worktree name", () => {
+    const branch = make_branch({
+      user: "erik",
+      description: "new feature",
+    });
+    const config = make_config({
+      worktrees: {
+        base_path: "../wt",
+        folder_template: "{{repo_name}}-{{user}}-{{branch_description}}",
+      },
+    });
+
+    const result = build_worktree_path(branch, config, "/tmp/repo");
+    expect(result).toBe("../wt/repo-erik-newfeature");
+  });
+});

package/src/utils/build-branch.ts

@@ -0,0 +1,46 @@
+import { InferOutput } from "valibot";
+import { V_BRANCH_CONFIG_FIELDS, V_BRANCH_FIELDS } from "../valibot-consts";
+import { BranchState, Config } from "../valibot-state";
+
+export function build_branch(
+  branch: InferOutput<typeof BranchState>,
+  config: InferOutput<typeof Config>,
+): string {
+  let res = "";
+  config.branch_order.forEach((b: InferOutput<typeof V_BRANCH_FIELDS>) => {
+    const config_key: InferOutput<typeof V_BRANCH_CONFIG_FIELDS> = `branch_${b}`;
+    if (branch[b]) res += branch[b] + config[config_key].separator;
+  });
+
+  if (res.endsWith("-") || res.endsWith("/") || res.endsWith("_")) {
+    return res.slice(0, -1).trim();
+  }
+
+  return res.trim();
+}
+
+export function build_worktree_path(
+  branch_state: InferOutput<typeof BranchState>,
+  config: InferOutput<typeof Config>,
+  git_root: string,
+): string {
+  const repo_name = git_root.split("/").pop() || "repo";
+
+  let worktree_name = config.worktrees.folder_template;
+
+  worktree_name = worktree_name
+    .replace("{{repo_name}}", repo_name)
+    .replace("{{branch_description}}", branch_state.description)
+    .replace("{{user}}", branch_state.user || "")
+    .replace("{{type}}", branch_state.type || "")
+    .replace("{{ticket}}", branch_state.ticket || "")
+    .replace("{{version}}", branch_state.version || "");
+
+  worktree_name = worktree_name
+    .replace(/\s/g, "")
+    .replace(/--+/g, "-")
+    .replace(/^-+|-+$/g, "");
+
+  const base_path = config.worktrees.base_path;
+  return `${base_path}${base_path.endsWith("/") ? "" : "/"}${worktree_name}`;
+}

package/src/utils/build-commit-string.test.ts

@@ -0,0 +1,253 @@
+import { describe, expect, it } from "vitest";
+import { InferOutput, parse } from "valibot";
+import { CommitState, Config } from "../valibot-state";
+import { build_commit_string } from "./build-commit-string";
+
+type ConfigOutput = InferOutput<typeof Config>;
+type ConfigOverrides = Partial<
+  Omit<ConfigOutput, "check_ticket" | "breaking_change">
+> & {
+  check_ticket?: Partial<ConfigOutput["check_ticket"]>;
+  breaking_change?: Partial<ConfigOutput["breaking_change"]>;
+};
+
+function make_config(overrides?: ConfigOverrides): ConfigOutput {
+  const base = parse_config({});
+  if (!overrides) return base;
+
+  return {
+    ...base,
+    ...overrides,
+    check_ticket: {
+      ...base.check_ticket,
+      ...(overrides.check_ticket ?? {}),
+    },
+    breaking_change: {
+      ...base.breaking_change,
+      ...(overrides.breaking_change ?? {}),
+    },
+  };
+}
+
+function parse_config(input: Record<string, unknown>) {
+  return parse(Config, input);
+}
+
+function make_state(input: Record<string, unknown>) {
+  return parse(CommitState, input);
+}
+
+describe("build_commit_string", () => {
+  it("builds a basic conventional commit title", () => {
+    const result = build_commit_string({
+      commit_state: make_state({
+        type: "feat",
+        scope: "api",
+        title: "add endpoint",
+      }),
+      config: make_config(),
+    });
+
+    expect(result).toBe("feat(api): add endpoint");
+  });
+
+  it("adds ticket at start of title by default", () => {
+    const result = build_commit_string({
+      commit_state: make_state({
+        type: "fix",
+        title: "handle null values",
+        ticket: "ABC-123",
+      }),
+      config: make_config(),
+    });
+
+    expect(result).toBe("fix: ABC-123 handle null values");
+  });
+
+  it("supports ticket before colon", () => {
+    const result = build_commit_string({
+      commit_state: make_state({
+        type: "feat",
+        scope: "core",
+        title: "ship parser",
+        ticket: "PROJ-9",
+      }),
+      config: make_config({
+        check_ticket: {
+          title_position: "before-colon",
+        },
+      }),
+    });
+
+    expect(result).toBe("feat(core) PROJ-9: ship parser");
+  });
+
+  it("supports ticket wrapping when surround is configured", () => {
+    const result = build_commit_string({
+      commit_state: make_state({
+        type: "chore",
+        title: "update docs",
+        ticket: "42",
+      }),
+      config: make_config({
+        check_ticket: {
+          surround: "[]",
+        },
+      }),
+    });
+
+    expect(result).toBe("chore: [42] update docs");
+  });
+
+  it("supports ticket at end of title", () => {
+    const result = build_commit_string({
+      commit_state: make_state({
+        type: "chore",
+        title: "cleanup docs",
+        ticket: "DOC-7",
+      }),
+      config: make_config({
+        check_ticket: {
+          title_position: "end",
+        },
+      }),
+    });
+
+    expect(result).toBe("chore: cleanup docs DOC-7");
+  });
+
+  it("supports ticket at beginning of commit header", () => {
+    const result = build_commit_string({
+      commit_state: make_state({
+        type: "feat",
+        scope: "api",
+        title: "add endpoint",
+        ticket: "ABC-1",
+      }),
+      config: make_config({
+        check_ticket: {
+          title_position: "beginning",
+        },
+      }),
+    });
+
+    expect(result).toBe("ABC-1 feat(api): add endpoint");
+  });
+
+  it("appends body and footer blocks with spacing", () => {
+    const result = build_commit_string({
+      commit_state: make_state({
+        type: "feat",
+        title: "add cli",
+        body: "line 1\\nline 2",
+        custom_footer: "Refs: ABC-1",
+      }),
+      config: make_config(),
+    });
+
+    expect(result).toBe("feat: add cli\n\nline 1\nline 2\n\nRefs: ABC-1");
+  });
+
+  it("includes trailer only when include_trailer is true", () => {
+    const state = make_state({
+      type: "feat",
+      title: "add cli",
+      trailer: "Signed-off-by: Erik",
+    });
+    const config = make_config();
+
+    const no_trailer = build_commit_string({
+      commit_state: state,
+      config,
+      include_trailer: false,
+    });
+    const with_trailer = build_commit_string({
+      commit_state: state,
+      config,
+      include_trailer: true,
+    });
+
+    expect(no_trailer).toBe("feat: add cli");
+    expect(with_trailer).toBe("feat: add cli\n\nSigned-off-by: Erik");
+  });
+
+  it("skips title ticket when add_to_title is false but keeps closes footer", () => {
+    const result = build_commit_string({
+      commit_state: make_state({
+        type: "fix",
+        title: "repair parser",
+        ticket: "BUG-99",
+        closes: "closes",
+      }),
+      config: make_config({
+        check_ticket: {
+          add_to_title: false,
+        },
+      }),
+    });
+
+    expect(result).toBe("fix: repair parser\n\ncloses BUG-99");
+  });
+
+  it("adds breaking exclamation when enabled", () => {
+    const result = build_commit_string({
+      commit_state: make_state({
+        type: "feat",
+        title: "replace api",
+        breaking_title: "v1 removed",
+      }),
+      config: make_config({
+        breaking_change: {
+          add_exclamation_to_title: true,
+        },
+      }),
+    });
+
+    expect(result).toBe("feat!: replace api\n\nBREAKING CHANGE: v1 removed");
+  });
+
+  it("renders deprecation title and body blocks", () => {
+    const result = build_commit_string({
+      commit_state: make_state({
+        type: "chore",
+        title: "remove legacy helper",
+        deprecates_title: "legacy helper",
+        deprecates_body: "use modern helper",
+      }),
+      config: make_config(),
+    });
+
+    expect(result).toBe(
+      "chore: remove legacy helper\n\nDEPRECATED: legacy helper\n\nuse modern helper",
+    );
+  });
+
+  it("formats before-colon ticket without type and scope", () => {
+    const result = build_commit_string({
+      commit_state: make_state({
+        title: "ship parser",
+        ticket: "PROJ-9",
+      }),
+      config: make_config({
+        check_ticket: {
+          title_position: "before-colon",
+        },
+      }),
+    });
+
+    expect(result).toBe("PROJ-9: ship parser");
+  });
+
+  it("escapes double quotes and backticks for shell-safe command composition", () => {
+    const result = build_commit_string({
+      commit_state: make_state({
+        type: "fix",
+        title: 'handle "quoted" `inline` value',
+      }),
+      config: make_config(),
+      escape_quotes: true,
+    });
+
+    expect(result).toBe('fix: handle \\"quoted\\" \\`inline\\` value');
+  });
+});

package/src/utils/build-commit-string.ts

@@ -0,0 +1,158 @@
+import color from "picocolors";
+import { InferOutput } from "valibot";
+import { CommitState, Config } from "../valibot-state";
+
+type BuildCommitStringInput = {
+  commit_state: InferOutput<typeof CommitState>;
+  config: InferOutput<typeof Config>;
+  colorize?: boolean;
+  escape_quotes?: boolean;
+  include_trailer?: boolean;
+};
+
+export function build_commit_string({
+  commit_state,
+  config,
+  colorize = false,
+  escape_quotes = false,
+  include_trailer = false,
+}: BuildCommitStringInput): string {
+  let commit_string = "";
+  if (commit_state.type) {
+    commit_string += colorize
+      ? color.blue(commit_state.type)
+      : commit_state.type;
+  }
+
+  if (commit_state.scope) {
+    const scope = colorize
+      ? color.cyan(commit_state.scope)
+      : commit_state.scope;
+    commit_string += `(${scope})`;
+  }
+
+  let title_ticket = commit_state.ticket;
+  const surround = config.check_ticket.surround;
+  if (commit_state.ticket && surround) {
+    const open_token = surround.charAt(0);
+    const close_token = surround.charAt(1);
+    title_ticket = `${open_token}${commit_state.ticket}${close_token}`;
+  }
+
+  const position_beginning = config.check_ticket.title_position === "beginning";
+  if (title_ticket && config.check_ticket.add_to_title && position_beginning) {
+    commit_string = `${colorize ? color.magenta(title_ticket) : title_ticket} ${commit_string}`;
+  }
+
+  const position_before_colon =
+    config.check_ticket.title_position === "before-colon";
+  if (
+    title_ticket &&
+    config.check_ticket.add_to_title &&
+    position_before_colon
+  ) {
+    const spacing =
+      commit_state.scope || (commit_state.type && !config.check_ticket.surround)
+        ? " "
+        : "";
+    commit_string += colorize
+      ? color.magenta(spacing + title_ticket)
+      : spacing + title_ticket;
+  }
+
+  if (
+    commit_state.breaking_title &&
+    config.breaking_change.add_exclamation_to_title
+  ) {
+    commit_string += colorize ? color.red("!") : "!";
+  }
+
+  if (
+    commit_state.scope ||
+    commit_state.type ||
+    (title_ticket && position_before_colon)
+  ) {
+    commit_string += ": ";
+  }
+
+  const position_start = config.check_ticket.title_position === "start";
+  const position_end = config.check_ticket.title_position === "end";
+  if (title_ticket && config.check_ticket.add_to_title && position_start) {
+    commit_string += colorize
+      ? color.magenta(title_ticket) + " "
+      : title_ticket + " ";
+  }
+
+  if (commit_state.title) {
+    commit_string += colorize
+      ? color.reset(commit_state.title)
+      : commit_state.title;
+  }
+
+  if (title_ticket && config.check_ticket.add_to_title && position_end) {
+    commit_string +=
+      " " + (colorize ? color.magenta(title_ticket) : title_ticket);
+  }
+
+  if (commit_state.body) {
+    const temp = commit_state.body.split("\\n");
+    const res = temp
+      .map((value) => (colorize ? color.reset(value.trim()) : value.trim()))
+      .join("\n");
+    commit_string += `\n\n${res}`;
+  }
+
+  if (commit_state.breaking_title) {
+    const title = colorize
+      ? color.red(`BREAKING CHANGE: ${commit_state.breaking_title}`)
+      : `BREAKING CHANGE: ${commit_state.breaking_title}`;
+    commit_string += `\n\n${title}`;
+  }
+
+  if (commit_state.breaking_body) {
+    const body = colorize
+      ? color.red(commit_state.breaking_body)
+      : commit_state.breaking_body;
+    commit_string += `\n\n${body}`;
+  }
+
+  if (commit_state.deprecates_title) {
+    const title = colorize
+      ? color.yellow(`DEPRECATED: ${commit_state.deprecates_title}`)
+      : `DEPRECATED: ${commit_state.deprecates_title}`;
+    commit_string += `\n\n${title}`;
+  }
+
+  if (commit_state.deprecates_body) {
+    const body = colorize
+      ? color.yellow(commit_state.deprecates_body)
+      : commit_state.deprecates_body;
+    commit_string += `\n\n${body}`;
+  }
+
+  if (commit_state.custom_footer) {
+    const temp = commit_state.custom_footer.split("\\n");
+    const res = temp
+      .map((value) => (colorize ? color.reset(value.trim()) : value.trim()))
+      .join("\n");
+    commit_string += `\n\n${res}`;
+  }
+
+  if (commit_state.closes && commit_state.ticket) {
+    commit_string += colorize
+      ? `\n\n${color.reset(commit_state.closes)} ${color.magenta(commit_state.ticket)}`
+      : `\n\n${commit_state.closes} ${commit_state.ticket}`;
+  }
+
+  if (include_trailer && commit_state.trailer) {
+    commit_string += colorize
+      ? `\n\n${color.dim(commit_state.trailer)}`
+      : `\n\n${commit_state.trailer}`;
+  }
+
+  if (escape_quotes) {
+    commit_string = commit_string.replaceAll('"', '\\"').replaceAll("`", "\\`");
+  }
+
+  return commit_string;
+}

package/src/utils/commit-title-size.ts

@@ -0,0 +1,24 @@
+type CommitTitleSizeInput = {
+  type?: string;
+  scope?: string;
+  ticket?: string;
+  title?: string;
+};
+
+type CommitTitleSizeOptions = {
+  include_ticket: boolean;
+};
+
+export function get_commit_title_size(
+  val: CommitTitleSizeInput,
+  options: CommitTitleSizeOptions,
+): number {
+  const commit_scope_size = val.scope ? val.scope.length + 2 : 0;
+  const commit_type_size = val.type?.length ?? 0;
+  const commit_ticket_size = options.include_ticket
+    ? (val.ticket?.length ?? 0)
+    : 0;
+  const title_size = val.title?.length ?? 0;
+
+  return commit_scope_size + commit_type_size + commit_ticket_size + title_size;
+}

package/src/utils/infer.test.ts

@@ -0,0 +1,83 @@
+import { beforeEach, describe, expect, it, vi } from "vitest";
+
+vi.mock("child_process", () => ({
+  execSync: vi.fn(),
+}));
+
+vi.mock("../args", () => ({
+  flags: {
+    interactive: false,
+    git_args: "--git-dir=/tmp/repo/.git --work-tree=/tmp/repo",
+  },
+}));
+
+import { execSync } from "child_process";
+import { parse } from "valibot";
+import { Config } from "../valibot-state";
+import {
+  infer_not_interactive,
+  infer_ticket_from_git,
+  infer_type_from_git,
+} from "./infer";
+
+const execSyncMock = vi.mocked(execSync);
+
+describe("infer", () => {
+  beforeEach(() => {
+    execSyncMock.mockReset();
+  });
+
+  it('prepends hashtags for inferred tickets when prepend_hashtag is "Always"', () => {
+    execSyncMock.mockReturnValue(Buffer.from("feat/127-cli-bombshell-args\n"));
+
+    const result = infer_ticket_from_git(
+      {
+        append_hashtag: false,
+        prepend_hashtag: "Always",
+      },
+      "--git-dir=/tmp/repo/.git --work-tree=/tmp/repo",
+    );
+
+    expect(result).toBe("#127");
+  });
+
+  it('returns plain inferred tickets when prepend_hashtag is "Never"', () => {
+    execSyncMock.mockReturnValue(Buffer.from("feat/ABC-123-add-parser\n"));
+
+    const result = infer_ticket_from_git(
+      {
+        append_hashtag: false,
+        prepend_hashtag: "Never",
+      },
+      "--git-dir=/tmp/repo/.git --work-tree=/tmp/repo",
+    );
+
+    expect(result).toBe("ABC-123");
+  });
+
+  it("infers commit types from the current branch", () => {
+    execSyncMock.mockReturnValue(Buffer.from("everduin94/feat/ABC-123-add-parser\n"));
+
+    const result = infer_type_from_git(
+      [{ value: "feat" }, { value: "fix" }],
+      "--git-dir=/tmp/repo/.git --work-tree=/tmp/repo",
+    );
+
+    expect(result).toBe("feat");
+  });
+
+  it("builds no-interactive inferred state using current config settings", () => {
+    execSyncMock.mockReturnValue(Buffer.from("feat/127-cli-bombshell-args\n"));
+
+    const config = parse(Config, {
+      check_ticket: {
+        prepend_hashtag: "Always",
+      },
+    });
+
+    expect(infer_not_interactive(config)).toEqual({
+      ticket: "#127",
+      type: "feat",
+    });
+  });
+});