better-commits 1.23.2 → 1.23.3

package/src/init.test.ts

@@ -1,123 +0,0 @@
-import fs from "fs";
-import { beforeEach, describe, expect, it, vi } from "vitest";
-
-const mocked = vi.hoisted(() => ({
-  writeFileSync: vi.fn<typeof fs.writeFileSync>(),
-  intro: vi.fn(),
-  outro: vi.fn(),
-  confirm: vi.fn(),
-  isCancel: vi.fn(() => false),
-  success: vi.fn(),
-  error: vi.fn(),
-  get_git_root: vi.fn(() => "/repo"),
-  get_repository_config_path: vi.fn<() => string | null>(),
-}));
-
-vi.mock("fs", () => ({
-  default: {
-    writeFileSync: mocked.writeFileSync,
-  },
-}));
-
-vi.mock("@clack/prompts", () => ({
-  intro: mocked.intro,
-  outro: mocked.outro,
-  confirm: mocked.confirm,
-  isCancel: mocked.isCancel,
-  log: {
-    success: mocked.success,
-    error: mocked.error,
-  },
-}));
-
-vi.mock("./utils", async () => {
-  const actual = await vi.importActual<typeof import("./utils")>("./utils");
-  return {
-    ...actual,
-    get_git_root: mocked.get_git_root,
-    get_repository_config_path: mocked.get_repository_config_path,
-  };
-});
-
-describe("create_init_config", () => {
-  beforeEach(() => {
-    vi.resetModules();
-    mocked.writeFileSync.mockReset();
-    mocked.intro.mockReset();
-    mocked.outro.mockReset();
-    mocked.confirm.mockReset();
-    mocked.isCancel.mockReset();
-    mocked.isCancel.mockReturnValue(false);
-    mocked.success.mockReset();
-    mocked.error.mockReset();
-    mocked.get_git_root.mockReset();
-    mocked.get_git_root.mockReturnValue("/repo");
-    mocked.get_repository_config_path.mockReset();
-  });
-
-  it("creates a new config when none exists", async () => {
-    mocked.get_repository_config_path.mockReturnValue(null);
-
-    const { create_init_config } = await import("./init");
-    mocked.writeFileSync.mockClear();
-    mocked.confirm.mockClear();
-    mocked.outro.mockClear();
-
-    await create_init_config();
-
-    expect(mocked.confirm).not.toHaveBeenCalled();
-    expect(mocked.writeFileSync).toHaveBeenCalledTimes(1);
-  });
-
-  it("asks before overwriting an existing config", async () => {
-    mocked.get_repository_config_path.mockReturnValue("/repo/.better-commits.jsonc");
-    mocked.confirm.mockResolvedValue(true);
-
-    const { create_init_config } = await import("./init");
-    mocked.writeFileSync.mockClear();
-    mocked.confirm.mockClear();
-    mocked.outro.mockClear();
-
-    await create_init_config();
-
-    expect(mocked.confirm).toHaveBeenCalledTimes(1);
-    expect(mocked.writeFileSync).toHaveBeenCalledWith(
-      "/repo/.better-commits.jsonc",
-      expect.any(String),
-    );
-  });
-
-  it("writes the canonical jsonc file when a legacy json config exists", async () => {
-    mocked.get_repository_config_path.mockReturnValue("/repo/.better-commits.json");
-    mocked.confirm.mockResolvedValue(true);
-
-    const { create_init_config } = await import("./init");
-    mocked.writeFileSync.mockClear();
-    mocked.confirm.mockClear();
-    mocked.outro.mockClear();
-
-    await create_init_config();
-
-    expect(mocked.confirm).toHaveBeenCalledTimes(1);
-    expect(mocked.writeFileSync).toHaveBeenCalledWith(
-      "/repo/.better-commits.jsonc",
-      expect.any(String),
-    );
-  });
-
-  it("does not overwrite when confirmation is declined", async () => {
-    mocked.get_repository_config_path.mockReturnValue("/repo/.better-commits.jsonc");
-    mocked.confirm.mockResolvedValue(false);
-
-    const { create_init_config } = await import("./init");
-    mocked.writeFileSync.mockClear();
-    mocked.confirm.mockClear();
-    mocked.outro.mockClear();
-
-    await create_init_config();
-
-    expect(mocked.confirm).toHaveBeenCalledTimes(1);
-    expect(mocked.writeFileSync).not.toHaveBeenCalled();
-    expect(mocked.outro).toHaveBeenCalledWith("Cancelled");
-  });
-});

package/src/init.ts

@@ -1,46 +0,0 @@
-#! /usr/bin/env node
-
-import * as p from "@clack/prompts";
-import fs from "fs";
-import color from "picocolors";
-import { DEFAULT_CONFIG_TEMPLATE } from "./default-config-template";
-import {
-  CONFIG_FILE_NAME,
-  get_git_root,
-  get_repository_config_path,
-} from "./utils";
-
-await create_init_config();
-
-export async function create_init_config() {
-  console.clear();
-  p.intro(`${color.bgCyan(color.black(" better-commits-init "))}`);
-  const root = get_git_root();
-  const existing_config_path = get_repository_config_path(root);
-  const root_path = `${root}/${CONFIG_FILE_NAME}`;
-
-  if (existing_config_path) {
-    const should_overwrite = (await p.confirm({
-      message: `${existing_config_path.split("/").pop()} already exists. Replace with default ${CONFIG_FILE_NAME}?`,
-    })) as boolean;
-
-    if (p.isCancel(should_overwrite) || !should_overwrite) {
-      p.outro("Cancelled");
-      return;
-    }
-  }
-
-  try {
-    fs.writeFileSync(root_path, DEFAULT_CONFIG_TEMPLATE);
-  } catch {
-    p.log.error(
-      `${color.red("Could not determine git root folder. better-commits-init must be used in a git repository")}`,
-    );
-  }
-  p.log.success(
-    `${color.green(`Successfully created ${root_path.split("/").pop()}`)}`,
-  );
-  p.outro(
-    `Run ${color.bgBlack(color.white("better-commits"))} to start the CLI`,
-  );
-}

package/src/prompts/autocomplete-multiselect.test.ts

@@ -1,129 +0,0 @@
-import type { Key } from "node:readline";
-import { PassThrough } from "node:stream";
-import { Prompt } from "@clack/core";
-import { afterEach, describe, expect, it, vi } from "vitest";
-import { autocompleteMultiselect } from "./autocomplete-multiselect";
-
-type InternalPrompt<Value> = {
-  _isActionKey: (char: string | undefined, key: Key) => boolean;
-  _setUserInput: (value: string | undefined, write?: boolean) => void;
-  onKeypress: (char: string | undefined, key: Key) => void;
-  selectedValues: Value[];
-  focusedValue: Value | undefined;
-  userInput: string;
-  state: string;
-  rl?: FakeReadLine;
-};
-
-type FakeReadLine = {
-  line: string;
-  cursor: number;
-  write: ReturnType<typeof vi.fn>;
-};
-
-function createOutput(): PassThrough {
-  const output = new PassThrough();
-  Object.assign(output, { columns: 80, rows: 24, isTTY: true });
-  return output;
-}
-
-function createReadLine(line: string): FakeReadLine {
-  const rl: FakeReadLine = {
-    line,
-    cursor: line.length,
-    write: vi.fn((_: string | null, key?: Key) => {
-      if (key?.ctrl && key.name === "h") {
-        rl.line = rl.line.slice(0, -1);
-        rl.cursor = Math.max(0, rl.cursor - 1);
-      }
-
-      if (key?.ctrl && key.name === "e") {
-        rl.cursor = rl.line.length;
-      }
-    }),
-  };
-
-  return rl;
-}
-
-async function createPrompt(): Promise<InternalPrompt<string>> {
-  vi.spyOn(Prompt.prototype, "prompt").mockImplementation(function () {
-    return Promise.resolve(this as never);
-  });
-
-  return (await autocompleteMultiselect({
-    message: "Pick files",
-    options: [
-      { value: "src/foo.ts", label: "src/foo.ts" },
-      { value: "test/foo.ts", label: "test/foo.ts" },
-    ],
-    output: createOutput(),
-    withGuide: false,
-  })) as unknown as InternalPrompt<string>;
-}
-
-afterEach(() => {
-  vi.restoreAllMocks();
-});
-
-describe("autocompleteMultiselect", () => {
-  it("uses space to toggle the focused option while searching", async () => {
-    const prompt = await createPrompt();
-    prompt.state = "active";
-    prompt._setUserInput("src");
-    prompt.rl = createReadLine("src ");
-
-    expect(prompt._isActionKey(" ", { name: "space", sequence: " " } as Key)).toBe(true);
-
-    prompt.onKeypress(" ", { name: "space", sequence: " " } as Key);
-
-    expect(prompt.selectedValues).toEqual(["src/foo.ts"]);
-    expect(prompt.userInput).toBe("src");
-    expect(prompt.rl.line).toBe("src");
-    expect(prompt.rl.write).toHaveBeenNthCalledWith(1, null, {
-      ctrl: true,
-      name: "h",
-    });
-    expect(prompt.rl.write).toHaveBeenNthCalledWith(2, "", {
-      ctrl: true,
-      name: "e",
-    });
-  });
-
-  it("keeps tab selection behavior unchanged", async () => {
-    const prompt = await createPrompt();
-    prompt.state = "active";
-    prompt._setUserInput("src");
-    prompt.rl = createReadLine("src\t");
-
-    prompt.onKeypress("\t", { name: "tab", sequence: "\t" } as Key);
-
-    expect(prompt.selectedValues).toEqual(["src/foo.ts"]);
-    expect(prompt.userInput).toBe("src");
-    expect(prompt.rl.line).toBe("src");
-    expect(prompt.rl.write).toHaveBeenCalledTimes(1);
-    expect(prompt.rl.write).toHaveBeenCalledWith(null, {
-      ctrl: true,
-      name: "h",
-    });
-  });
-
-  it("does not add whitespace to the filter when nothing matches", async () => {
-    const prompt = await createPrompt();
-    prompt.state = "active";
-    prompt._setUserInput("missing");
-    prompt.rl = createReadLine("missing ");
-
-    prompt.onKeypress(" ", { name: "space", sequence: " " } as Key);
-
-    expect(prompt.focusedValue).toBeUndefined();
-    expect(prompt.selectedValues).toEqual([]);
-    expect(prompt.userInput).toBe("missing");
-    expect(prompt.rl.line).toBe("missing");
-    expect(prompt.rl.write).toHaveBeenCalledTimes(1);
-    expect(prompt.rl.write).toHaveBeenCalledWith(null, {
-      ctrl: true,
-      name: "h",
-    });
-  });
-});

package/src/prompts/autocomplete-multiselect.ts

@@ -1,249 +0,0 @@
-import type { Key, ReadLine } from "node:readline";
-import type { Readable, Writable } from "node:stream";
-import { styleText } from "node:util";
-import { AutocompletePrompt } from "@clack/core";
-import {
-  S_BAR,
-  S_BAR_END,
-  S_CHECKBOX_INACTIVE,
-  S_CHECKBOX_SELECTED,
-  limitOptions,
-  settings,
-  symbol,
-} from "@clack/prompts";
-
-type Option<Value> = {
-  value: Value;
-  label?: string;
-  hint?: string;
-  disabled?: boolean;
-};
-
-type Filter<Value> = (search: string, option: Option<Value>) => boolean;
-
-type AutocompleteMultiselectOptions<Value> = {
-  message: string;
-  options:
-    | Option<Value>[]
-    | ((this: AutocompletePrompt<Option<Value>>) => Option<Value>[]);
-  maxItems?: number;
-  validate?: (value: Value[] | undefined) => string | Error | undefined;
-  filter?: Filter<Value>;
-  initialValues?: Value[];
-  required?: boolean;
-  input?: Readable;
-  output?: Writable;
-  signal?: AbortSignal;
-  withGuide?: boolean;
-};
-
-function getFilteredOption<Value>(
-  searchText: string,
-  option: Option<Value>,
-): boolean {
-  if (!searchText) return true;
-
-  const label = (option.label ?? String(option.value ?? "")).toLowerCase();
-  const hint = (option.hint ?? "").toLowerCase();
-  const value = String(option.value).toLowerCase();
-  const term = searchText.toLowerCase();
-
-  return label.includes(term) || hint.includes(term) || value.includes(term);
-}
-
-function is_ctrl_a(char: string | undefined, key: Key): boolean {
-  return char === "\u0001" || (key.ctrl === true && key.name === "a");
-}
-
-/**
- * Generated by 🤖. Mostly copying and extending from Clack AutocompletePrompt.
- *
- * This is to support ctrl+a to select all visible
- */
-class AutocompleteMultiselectPrompt<Value> extends AutocompletePrompt<
-  Option<Value>
-> {
-  protected override _isActionKey(char: string | undefined, key: Key): boolean {
-    return (
-      super._isActionKey(char, key) ||
-      (this.multiple && key.name === "space" && char !== undefined && char !== "")
-    );
-  }
-
-  constructor(
-    private readonly promptOptions: AutocompleteMultiselectOptions<Value>,
-  ) {
-    super({
-      options: promptOptions.options,
-      multiple: true,
-      filter:
-        promptOptions.filter ??
-        ((search, opt) => getFilteredOption(search, opt)),
-      validate: (value) => {
-        if (
-          promptOptions.required &&
-          (!Array.isArray(value) || value.length === 0)
-        ) {
-          return "Please select at least one item";
-        }
-
-        return promptOptions.validate?.(value as Value[] | undefined);
-      },
-      initialValue: promptOptions.initialValues,
-      signal: promptOptions.signal,
-      input: promptOptions.input,
-      output: promptOptions.output,
-      render() {
-        const hasGuide = promptOptions.withGuide ?? settings.withGuide;
-        const title = `${hasGuide ? `${styleText("gray", S_BAR)}\n` : ""}${symbol(this.state)}  ${promptOptions.message}\n`;
-        const userInput = this.userInput;
-        const searchText = this.userInputWithCursor;
-
-        const options = this.options;
-        const matches =
-          this.filteredOptions.length !== options.length
-            ? styleText(
-                "dim",
-                ` (${this.filteredOptions.length} match${this.filteredOptions.length === 1 ? "" : "es"})`,
-              )
-            : "";
-
-        switch (this.state) {
-          case "submit": {
-            return `${title}${hasGuide ? `${styleText("gray", S_BAR)}  ` : ""}${styleText("dim", `${this.selectedValues.length} items selected`)}`;
-          }
-
-          case "cancel": {
-            return `${title}${hasGuide ? `${styleText("gray", S_BAR)}  ` : ""}${styleText(["strikethrough", "dim"], userInput)}`;
-          }
-
-          default: {
-            const barStyle = this.state === "error" ? "yellow" : "cyan";
-            const guidePrefix = hasGuide
-              ? `${styleText(barStyle, S_BAR)}  `
-              : "";
-            const guidePrefixEnd = hasGuide
-              ? styleText(barStyle, S_BAR_END)
-              : "";
-            const instructions = [
-              `${styleText("dim", "↑/↓")} to navigate`,
-              `${styleText("dim", "Space/Tab:")} select`,
-              `${styleText("dim", "Ctrl+a:")} select visible`,
-              `${styleText("dim", "Enter:")} confirm`,
-              `${styleText("dim", "Type:")} to search`,
-            ];
-            const noResults =
-              this.filteredOptions.length === 0 && userInput
-                ? [`${guidePrefix}${styleText("yellow", "No matches found")}`]
-                : [];
-            const errorMessage =
-              this.state === "error"
-                ? [`${guidePrefix}${styleText("yellow", this.error)}`]
-                : [];
-            const headerLines = [
-              ...`${title}${hasGuide ? styleText(barStyle, S_BAR) : ""}`.split(
-                "\n",
-              ),
-              `${guidePrefix}${styleText("dim", "Search:")} ${searchText}${matches}`,
-              ...noResults,
-              ...errorMessage,
-            ];
-            const footerLines = [
-              `${guidePrefix}${instructions.join(" • ")}`,
-              guidePrefixEnd,
-            ];
-            const displayOptions = limitOptions({
-              cursor: this.cursor,
-              options: this.filteredOptions,
-              style: (option, active) => {
-                const isSelected = this.selectedValues.includes(option.value);
-                const label = option.label ?? String(option.value ?? "");
-                const hint =
-                  option.hint &&
-                  this.focusedValue !== undefined &&
-                  option.value === this.focusedValue
-                    ? styleText("dim", ` (${option.hint})`)
-                    : "";
-                const checkbox = isSelected
-                  ? styleText("green", S_CHECKBOX_SELECTED)
-                  : styleText("dim", S_CHECKBOX_INACTIVE);
-
-                if (option.disabled) {
-                  return `${styleText("gray", S_CHECKBOX_INACTIVE)} ${styleText(["strikethrough", "gray"], label)}`;
-                }
-
-                if (active) {
-                  return `${checkbox} ${label}${hint}`;
-                }
-
-                return `${checkbox} ${styleText("dim", label)}`;
-              },
-              maxItems: promptOptions.maxItems,
-              output: promptOptions.output,
-              rowPadding: headerLines.length + footerLines.length,
-            });
-
-            return [
-              ...headerLines,
-              ...displayOptions.map((option) => `${guidePrefix}${option}`),
-              ...footerLines,
-            ].join("\n");
-          }
-        }
-      },
-    });
-
-    this.on("key", (char, key) => {
-      if (
-        key.name === "space" &&
-        !this.isNavigating &&
-        this.focusedValue !== undefined
-      ) {
-        this.toggleSelected(this.focusedValue);
-        this.#restore_cursor_to_end();
-        return;
-      }
-
-      if (!is_ctrl_a(char, key)) return;
-
-      this.#toggle_all_visible();
-      this.isNavigating = true;
-      this.#restore_cursor_to_end();
-    });
-  }
-
-  #toggle_all_visible(): void {
-    const visible_values = this.filteredOptions
-      .filter((option) => !option.disabled)
-      .map((option) => option.value);
-
-    if (!visible_values.length) return;
-
-    const every_visible_selected = visible_values.every((value) =>
-      this.selectedValues.includes(value),
-    );
-
-    this.selectedValues = every_visible_selected
-      ? this.selectedValues.filter((value) => !visible_values.includes(value))
-      : [
-          ...this.selectedValues,
-          ...visible_values.filter(
-            (value) => !this.selectedValues.includes(value),
-          ),
-        ];
-  }
-
-  #restore_cursor_to_end(): void {
-    const rl = (this as unknown as { rl?: ReadLine }).rl;
-    rl?.write("", { ctrl: true, name: "e" });
-    this._cursor = rl?.cursor ?? this.userInput.length;
-  }
-}
-
-export function autocompleteMultiselect<Value>(
-  opts: AutocompleteMultiselectOptions<Value>,
-): Promise<Value[] | symbol> {
-  return new AutocompleteMultiselectPrompt(opts).prompt() as Promise<
-    Value[] | symbol
-  >;
-}

package/src/prompts/branch-checkout.prompt.ts

@@ -1,36 +0,0 @@
-import { InferOutput } from "valibot";
-import { BranchRunnable } from "./branch-runnable";
-import { V_BRANCH_ACTIONS } from "../valibot-consts";
-import * as p from "@clack/prompts";
-import { BRANCH_ACTION_OPTIONS } from "../utils";
-
-export class BranchCheckoutPrompt extends BranchRunnable {
-  async run(): Promise<void> {
-    if (this.#is_enabled) {
-      const branch_or_worktree = await p.select({
-        message: this.#message,
-        initialValue: this.#initival_values,
-        options: BRANCH_ACTION_OPTIONS,
-      });
-
-      if (p.isCancel(branch_or_worktree)) process.exit();
-      this.#post_run_effects(branch_or_worktree);
-    }
-  }
-
-  get #message() {
-    return `Checkout a branch or create a worktree?`;
-  }
-
-  get #is_enabled() {
-    return this.config.worktrees.enable;
-  }
-
-  get #initival_values() {
-    return this.branch_state.checkout || this.config.branch_action_default;
-  }
-
-  #post_run_effects(value: InferOutput<typeof V_BRANCH_ACTIONS>) {
-    this.branch_state.checkout = value;
-  }
-}

package/src/prompts/branch-confirm.prompt.test.ts

@@ -1,89 +0,0 @@
-import { beforeEach, describe, expect, it, vi } from "vitest";
-import { parse } from "valibot";
-import { BranchState, Config } from "../valibot-state";
-
-const mocked = vi.hoisted(() => ({
-  dry_run: true,
-  execSync: vi.fn(),
-  info: vi.fn(),
-}));
-
-vi.mock("child_process", () => ({
-  execSync: mocked.execSync,
-}));
-
-vi.mock("@clack/prompts", () => ({
-  log: {
-    info: mocked.info,
-    warning: vi.fn(),
-    error: vi.fn(),
-  },
-}));
-
-vi.mock("picocolors", () => ({
-  default: {
-    bgGreen: (value: string) => value,
-    bgMagenta: (value: string) => value,
-    black: (value: string) => value,
-    yellow: (value: string) => value,
-  },
-}));
-
-vi.mock("../branch-args", () => ({
-  branch_flags: {
-    git_args: "",
-    get dry_run() {
-      return mocked.dry_run;
-    },
-  },
-}));
-
-vi.mock("../utils", async () => {
-  const actual = await vi.importActual<typeof import("../utils")>("../utils");
-  return {
-    ...actual,
-    get_git_root: vi.fn(() => "/tmp/repo"),
-  };
-});
-
-describe("BranchConfirmPrompt", () => {
-  beforeEach(() => {
-    mocked.dry_run = true;
-    mocked.execSync.mockReset();
-    mocked.info.mockReset();
-  });
-
-  it("does not create a worktree during dry run", async () => {
-    const { BranchConfirmPrompt } = await import("./branch-confirm.prompt");
-    const config = parse(Config, {
-      worktrees: {
-        base_path: "../worktrees",
-      },
-    });
-    const branch_state = parse(BranchState, {
-      type: "feat",
-      scope: "cli",
-      ticket: "TAC-123",
-      description: "add-parser",
-      checkout: "worktree",
-    });
-
-    mocked.execSync.mockImplementation((command: string) => {
-      if (command.includes("show-ref")) throw new Error("branch missing");
-      return Buffer.from("");
-    });
-
-    await new BranchConfirmPrompt(config, branch_state, {} as never).run();
-
-    expect(mocked.execSync).toHaveBeenCalledTimes(1);
-    expect(mocked.execSync).toHaveBeenCalledWith(
-      "git  show-ref feat/TAC-123-cli-add-parser",
-      {
-        encoding: "utf-8",
-      },
-    );
-    expect(mocked.info).toHaveBeenCalledWith(
-      "Dry run: git  worktree add ../worktrees/repo-TAC-123-add-parser -b feat/TAC-123-cli-add-parser",
-    );
-  });
-});