better-commits 1.23.2 → 1.23.3

package/src/args.ts

@@ -1,125 +0,0 @@
-import { parse } from "@bomb.sh/args";
-import { InferOutput } from "valibot";
-import { CommitState } from "./valibot-state";
-
-type CommitStateRuntime = InferOutput<typeof CommitState>;
-
-type ParsedRuntimeFlags = {
-  help: boolean;
-  version: boolean;
-  git_args: string;
-  no_interactive: boolean;
-  dry_run: boolean;
-  commit_state: Partial<CommitStateRuntime>;
-};
-
-export const COMMIT_OPTIONS = [
-  "type",
-  "scope",
-  "title",
-  "body",
-  "ticket",
-  "closes",
-  "trailer",
-  "breaking-title",
-  "breaking-body",
-  "deprecates-title",
-  "deprecates-body",
-  "custom-footer",
-] as const;
-
-export const GIT_OPTIONS = ["git-dir", "work-tree"] as const;
-
-export const BOOLEAN_FLAGS = [
-  "interactive",
-  "dry-run",
-  "help",
-  "version",
-] as const;
-
-class Flags {
-  #runtime: ParsedRuntimeFlags;
-
-  constructor(runtime: ParsedRuntimeFlags) {
-    this.#runtime = runtime;
-  }
-
-  get git_args(): string {
-    return this.#runtime.git_args;
-  }
-
-  get interactive(): boolean {
-    return !this.#runtime.no_interactive;
-  }
-
-  get dry_run(): boolean {
-    return this.#runtime.dry_run;
-  }
-
-  get help(): boolean {
-    return this.#runtime.help;
-  }
-
-  get version(): boolean {
-    return this.#runtime.version;
-  }
-
-  get commit_state(): Partial<CommitStateRuntime> {
-    return this.#runtime.commit_state;
-  }
-}
-
-export const flags = new Flags(parse_runtime_flags(process.argv.slice(2)));
-
-export function parse_runtime_flags(argv: string[]): ParsedRuntimeFlags {
-  const parsed = parse(argv, {
-    alias: { h: "help", v: "version" },
-    boolean: BOOLEAN_FLAGS,
-    string: [...COMMIT_OPTIONS, ...GIT_OPTIONS],
-  });
-
-  const commit_state: Partial<CommitStateRuntime> = {};
-  COMMIT_OPTIONS.forEach((value) => {
-    const cli_value = parsed[value];
-    const normalized_value = normalize_commit_flag(value, cli_value);
-    if (normalized_value !== undefined) {
-      const str = value.replace("-", "_") as keyof CommitStateRuntime;
-      commit_state[str] = normalized_value;
-    }
-  });
-
-  return {
-    help: parsed["help"] === true,
-    version: parsed["version"] === true,
-    git_args: get_git_args(parsed["git-dir"], parsed["work-tree"]),
-    no_interactive: parsed.interactive === false,
-    dry_run: parsed["dry-run"] === true,
-    commit_state,
-  };
-}
-
-function normalize_commit_flag(
-  option: (typeof COMMIT_OPTIONS)[number],
-  value: string | undefined,
-): string | undefined {
-  if (value === undefined) return undefined;
-  if (option !== "closes") return value;
-
-  const normalized = value.trim().toLowerCase();
-  if (normalized === "false") {
-    return undefined;
-  }
-
-  if (value === "" || normalized) {
-    return "Closes:";
-  }
-
-  return undefined;
-}
-
-function get_git_args(
-  git_dir: string | undefined,
-  work_tree: string | undefined,
-): string {
-  return `${git_dir ? `--git-dir=${git_dir}` : ""} ${work_tree ? `--work-tree=${work_tree}` : ""}`.trim();
-}

package/src/branch-args.test.ts

@@ -1,75 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { parse_branch_runtime_flags } from "./branch-args";
-
-describe("parse_branch_runtime_flags", () => {
-  it("maps branch flags into branch_state keys", () => {
-    const parsed = parse_branch_runtime_flags([
-      "--user",
-      "erik",
-      "--type",
-      "feat",
-      "--scope",
-      "cli",
-      "--ticket",
-      "ABC-123",
-      "--description",
-      "add-parser",
-      "--branch-version",
-      "1.2.0",
-    ]);
-
-    expect(parsed.branch_state).toEqual({
-      user: "erik",
-      type: "feat",
-      scope: "cli",
-      ticket: "ABC-123",
-      description: "add-parser",
-      version: "1.2.0",
-    });
-  });
-
-  it("maps --checkout into checkout", () => {
-    const parsed = parse_branch_runtime_flags(["--checkout", "worktree"]);
-
-    expect(parsed.branch_state).toEqual({
-      checkout: "worktree",
-    });
-  });
-
-  it("does not set checkout when --checkout is omitted", () => {
-    const parsed = parse_branch_runtime_flags([
-      "--type",
-      "feat",
-      "--description",
-      "add-parser",
-    ]);
-
-    expect(parsed.branch_state).toEqual({
-      type: "feat",
-      description: "add-parser",
-    });
-  });
-
-  it("honors interactive flag semantics", () => {
-    const default_flags = parse_branch_runtime_flags([]);
-    const explicit_interactive = parse_branch_runtime_flags(["--interactive"]);
-    const no_interactive = parse_branch_runtime_flags(["--no-interactive"]);
-
-    expect(default_flags.no_interactive).toBe(false);
-    expect(explicit_interactive.no_interactive).toBe(false);
-    expect(no_interactive.no_interactive).toBe(true);
-  });
-
-  it("parses git-dir and work-tree into git_args", () => {
-    const parsed = parse_branch_runtime_flags([
-      "--git-dir",
-      "/tmp/repo/.git",
-      "--work-tree",
-      "/tmp/repo",
-    ]);
-
-    expect(parsed.git_args).toBe(
-      "--git-dir=/tmp/repo/.git --work-tree=/tmp/repo",
-    );
-  });
-});

package/src/branch-args.ts

@@ -1,107 +0,0 @@
-import { parse } from "@bomb.sh/args";
-import { InferOutput } from "valibot";
-import { BranchState } from "./valibot-state";
-
-type BranchStateRuntime = InferOutput<typeof BranchState>;
-
-type ParsedRuntimeFlags = {
-  help: boolean;
-  version: boolean;
-  git_args: string;
-  no_interactive: boolean;
-  dry_run: boolean;
-  branch_state: Partial<BranchStateRuntime>;
-};
-
-const BRANCH_OPTIONS = [
-  "user",
-  "type",
-  "scope",
-  "description",
-  "ticket",
-  "branch-version",
-  "checkout",
-] as const;
-
-export const GIT_OPTIONS = ["git-dir", "work-tree"] as const;
-
-export const BOOLEAN_FLAGS = [
-  "interactive",
-  "dry-run",
-  "help",
-  "version",
-] as const;
-
-class BranchFlags {
-  #runtime: ParsedRuntimeFlags;
-
-  constructor(runtime: ParsedRuntimeFlags) {
-    this.#runtime = runtime;
-  }
-
-  get interactive(): boolean {
-    return !this.#runtime.no_interactive;
-  }
-
-  get dry_run(): boolean {
-    return this.#runtime.dry_run;
-  }
-
-  get help(): boolean {
-    return this.#runtime.help;
-  }
-
-  get version(): boolean {
-    return this.#runtime.version;
-  }
-
-  get git_args(): string {
-    return this.#runtime.git_args;
-  }
-
-  get branch_state(): Partial<BranchStateRuntime> {
-    return this.#runtime.branch_state;
-  }
-}
-
-export const branch_flags = new BranchFlags(
-  parse_branch_runtime_flags(process.argv.slice(2)),
-);
-
-export function parse_branch_runtime_flags(argv: string[]): ParsedRuntimeFlags {
-  const parsed = parse(argv, {
-    alias: { h: "help", v: "version" },
-    boolean: BOOLEAN_FLAGS,
-    string: [...BRANCH_OPTIONS, ...GIT_OPTIONS],
-  });
-
-  const branch_state: Partial<BranchStateRuntime> = {};
-  BRANCH_OPTIONS.forEach((value) => {
-    const cli_value = parsed[value];
-    if (cli_value) {
-      const str = (
-        value === "branch-version" ? "version" : value.replace("-", "_")
-      ) as keyof BranchStateRuntime;
-      if (str === "checkout")
-        branch_state[str] =
-          (cli_value as "worktree" | "branch" | undefined) ?? "branch";
-      else branch_state[str] = cli_value;
-    }
-  });
-
-  return {
-    help: parsed["help"] === true,
-    version: parsed["version"] === true,
-    git_args: get_git_args(parsed["git-dir"], parsed["work-tree"]),
-    no_interactive: parsed["interactive"] === false,
-    dry_run: parsed["dry-run"] === true,
-    branch_state: branch_state,
-  };
-}
-
-function get_git_args(
-  git_dir: string | undefined,
-  work_tree: string | undefined,
-): string {
-  return `${git_dir ? `--git-dir=${git_dir}` : ""} ${work_tree ? `--work-tree=${work_tree}` : ""}`.trim();
-}

package/src/branch-help.ts

@@ -1,125 +0,0 @@
-import { execSync } from "child_process";
-import { InferOutput } from "valibot";
-import { branch_flags } from "./branch-args";
-import { get_package_version } from "./utils";
-import {
-  infer_scope_from_git,
-  infer_ticket_from_git,
-  infer_type_from_git,
-} from "./utils/infer";
-import { Config } from "./valibot-state";
-import color from "picocolors";
-
-const CLI_FLAG_DEFINITIONS: Record<string, string> = {
-  "--interactive": "Run in interactive prompt mode (default behavior).",
-  "--dry-run": "Print branch commands without creating a branch or worktree.",
-  "--help": "Show help information and exit.",
-};
-
-const BRANCH_FLAG_DEFINITIONS: Record<string, string> = {
-  "--user": "Set branch username segment.",
-  "--type": "Set branch type (for example feat, fix, docs).",
-  "--scope": "Set branch scope segment.",
-  "--description": "Set branch description segment.",
-  "--ticket": "Set branch ticket/issue segment.",
-  "--branch-version": "Set branch version segment.",
-  "--checkout": "Choose branch or worktree checkout mode.",
-};
-
-const GIT_FLAG_DEFINITIONS: Record<string, string> = {
-  "--git-dir": "Set the path to the .git directory.",
-  "--work-tree": "Set the path to the working tree root.",
-};
-
-function to_definition_lines(definitions: Record<string, string>): string {
-  const description_column = 26;
-  const minimum_spacing = 2;
-  const indent = " ";
-
-  return Object.entries(definitions)
-    .map(([name, description]) => {
-      const spaces = Math.max(
-        minimum_spacing,
-        description_column - name.length,
-      );
-      return `${indent}${name}${" ".repeat(spaces)}${description}`;
-    })
-    .join("\n");
-}
-
-export function print_help_text(
-  config: InferOutput<typeof Config>,
-  config_source: "repository" | "global" | "none",
-) {
-  const version = get_package_version();
-
-  let branch = "(none)";
-  try {
-    branch =
-      execSync(`git ${branch_flags.git_args} branch --show-current`, {
-        stdio: "pipe",
-      })
-        .toString()
-        .trim() || "(none)";
-  } catch {
-    // noop
-  }
-
-  const inferred_type =
-    infer_type_from_git(config.commit_type.options, branch_flags.git_args) ||
-    "Unknown";
-  const inferred_ticket = config.check_ticket.infer_ticket
-    ? infer_ticket_from_git(
-        {
-          append_hashtag: config.check_ticket.append_hashtag,
-          prepend_hashtag: config.check_ticket.prepend_hashtag,
-        },
-        branch_flags.git_args,
-      ) || "Unknown"
-    : "Infer Disabled";
-  const inferred_scope = config.commit_scope.infer_scope_from_branch
-    ? infer_scope_from_git(
-        config.commit_scope.options,
-        branch_flags.git_args,
-      ) || "Unknown"
-    : "Infer Disabled";
-
-  const types = config.commit_type.options
-    .map((option) => option.value)
-    .join(", ")
-    .trim();
-  const scopes = config.commit_scope.options
-    .map((option) => option.value)
-    .join(", ")
-    .trim();
-  const cli_flags = to_definition_lines(CLI_FLAG_DEFINITIONS);
-  const git_flags = to_definition_lines(GIT_FLAG_DEFINITIONS);
-  const branch_flags_help = to_definition_lines(BRANCH_FLAG_DEFINITIONS);
-
-  console.log(`
-${color.green(" better-branch")} ${color.gray("v" + version)}
-
-${color.gray("BRANCH")} 
- ${branch}
- ${color.gray("Type")} ${color.blue(inferred_type)} ${color.gray("·")} ${color.gray("Scope")} ${color.cyan(inferred_scope)} ${color.gray("·")} ${color.gray("Ticket")} ${color.magenta(inferred_ticket)}
-
-${color.gray("CONFIGURATION")} 
- ${config_source}
-
-${color.gray("Types")} 
- ${types}
-
-${color.gray("Scopes")} 
- ${scopes}
-
-${color.gray("CLI FLAGS")} 
-${cli_flags}
-
-${color.gray("Branch Flags")} 
-${branch_flags_help}
-
-${color.gray("Git Flags (Advanced)")} 
-${git_flags}
-
-`);
-}

package/src/branch.ts

@@ -1,97 +0,0 @@
-#! /usr/bin/env node
-
-import Configstore from "configstore";
-import { chdir } from "process";
-import { InferOutput, ValiError, parse } from "valibot";
-import { BranchState, CommitState, Config } from "./valibot-state";
-import {
-  load_setup,
-  get_git_root,
-  NOOP_PROMPT_CACHE,
-  ConfigSource,
-} from "./utils";
-import { BranchRunnable } from "./prompts/branch-runnable";
-import { BranchCheckoutPrompt } from "./prompts/branch-checkout.prompt";
-import { BranchUserPrompt } from "./prompts/branch-user.prompt";
-import { BranchTypePrompt } from "./prompts/branch-type.prompt";
-import { BranchScopePrompt } from "./prompts/branch-scope.prompt";
-import { BranchTicketPrompt } from "./prompts/branch-ticket.prompt";
-import { BranchVersionPrompt } from "./prompts/branch-version.prompt";
-import { BranchDescriptionPrompt } from "./prompts/branch-description.prompt";
-import { BranchConfirmPrompt } from "./prompts/branch-confirm.prompt";
-import { branch_flags } from "./branch-args";
-import { print_help_text } from "./branch-help";
-import { create_strict_branch_state } from "./utils/no-interactive-validation";
-import { get_package_version } from "./utils";
-import * as p from "@clack/prompts";
-
-type PromptCtor = new (
-  config: InferOutput<typeof Config>,
-  commit_state: InferOutput<typeof BranchState>,
-  prompt_cache: Configstore,
-) => BranchRunnable;
-
-const promptCtors: PromptCtor[] = [
-  BranchCheckoutPrompt,
-  BranchUserPrompt,
-  BranchTypePrompt,
-  BranchTicketPrompt,
-  BranchScopePrompt,
-  BranchVersionPrompt,
-  BranchDescriptionPrompt,
-  BranchConfirmPrompt,
-];
-
-const { config, config_source } = load_setup(
-  " better-branch ",
-  branch_flags.git_args,
-);
-
-main(config, config_source);
-
-async function main(
-  config: InferOutput<typeof Config>,
-  config_source: ConfigSource,
-) {
-  chdir(get_git_root(branch_flags.git_args));
-
-  if (branch_flags.version) {
-    const version = get_package_version();
-    p.log.step("Better Commits v" + version);
-    return;
-  }
-
-  if (branch_flags.help) {
-    print_help_text(config, config_source);
-    return;
-  }
-
-  const branch_state = parse(BranchState, branch_flags.branch_state);
-
-  if (!branch_flags.interactive) {
-    try {
-      parse(create_strict_branch_state(config), branch_state);
-    } catch (err) {
-      if (err instanceof ValiError) {
-        p.log.error(`Invalid branch input: ${err.message}`);
-      } else {
-        p.log.error(`Failed to validate branch input: ${err}`);
-      }
-      process.exit(0);
-    }
-  }
-
-  const prompt_cache = config.cache_last_value
-    ? new Configstore("better-commits")
-    : NOOP_PROMPT_CACHE;
-  const prompts_to_run = branch_flags.interactive
-    ? promptCtors
-    : [BranchConfirmPrompt];
-  for (const Prompt of prompts_to_run) {
-    await new Prompt(config, branch_state, prompt_cache).run();
-  }
-}
-
-// TODO: No idea what's happening here
-// If you don't use CommitState, (even in unreachable code), parse fails on Config
-CommitState;