better-commits 1.23.2 → 1.23.3

package/src/default-config-template.ts

@@ -1,258 +0,0 @@
-export const DEFAULT_CONFIG_TEMPLATE = `{
-  // Run interactive \`git status\` before composing a commit
-  "check_status": true,
-  "check_status_autocomplete": true,
-
-  /* COMMIT FIELDS */
-  "commit_type": {
-    "enable": true,
-
-    // Default selected type from options
-    "initial_value": "feat",
-
-    "max_items": 20,
-
-    // Infer type from the current branch name: user/TYPE/my-branch
-    "infer_type_from_branch": true,
-
-    // Include emoji in prompt label
-    "append_emoji_to_label": false,
-
-    // Include emoji from prompt label in commit message
-    "append_emoji_to_commit": false,
-
-    // "Start" | "After-Colon"
-    "emoji_commit_position": "Start",
-
-    "autocomplete": true,
-
-    "options": [
-      {
-        "value": "feat",
-        "label": "feat",
-        "hint": "A new feature",
-        "emoji": "🌟",
-        "trailer": "Changelog: feature"
-      },
-      {
-        "value": "fix",
-        "label": "fix",
-        "hint": "A bug fix",
-        "emoji": "🐛",
-        "trailer": "Changelog: fix"
-      },
-      {
-        "value": "docs",
-        "label": "docs",
-        "hint": "Documentation only changes",
-        "emoji": "📚",
-        "trailer": "Changelog: documentation"
-      },
-      {
-        "value": "refactor",
-        "label": "refactor",
-        "hint": "A code change that neither fixes a bug nor adds a feature",
-        "emoji": "🔨",
-        "trailer": "Changelog: refactor"
-      },
-      {
-        "value": "perf",
-        "label": "perf",
-        "hint": "A code change that improves performance",
-        "emoji": "🚀",
-        "trailer": "Changelog: performance"
-      },
-      {
-        "value": "test",
-        "label": "test",
-        "hint": "Adding missing tests or correcting existing tests",
-        "emoji": "🚨",
-        "trailer": "Changelog: test"
-      },
-      {
-        "value": "build",
-        "label": "build",
-        "hint": "Changes that affect the build system or external dependencies",
-        "emoji": "🚧",
-        "trailer": "Changelog: build"
-      },
-      {
-        "value": "ci",
-        "label": "ci",
-        "hint": "Changes to our CI configuration files and scripts",
-        "emoji": "🤖",
-        "trailer": "Changelog: ci"
-      },
-      {
-        "value": "chore",
-        "label": "chore",
-        "hint": "Other changes that do not modify src or test files",
-        "emoji": "🧹",
-        "trailer": "Changelog: chore"
-      },
-      {
-        "value": "",
-        "label": "none"
-      }
-    ]
-  },
-
-  "commit_scope": {
-    "enable": true,
-
-    // If true, users can type a scope not listed in options
-    "custom_scope": false,
-
-    // Default selected scope from options
-    "initial_value": "app",
-
-    // Infer scope from the current branch name: user/type/ticket-SCOPE-my-branch
-    "infer_scope_from_branch": true,
-
-    "max_items": 20,
-    "autocomplete": true,
-    "options": [
-      { "value": "app", "label": "app" },
-      { "value": "shared", "label": "shared" },
-      { "value": "server", "label": "server" },
-      { "value": "tools", "label": "tools" },
-      { "value": "", "label": "none" }
-    ]
-  },
-
-  "check_ticket": {
-    // Infer ticket / issue from the branch name - user/type/TICKET-my-branch
-    "infer_ticket": true,
-
-    // Prompt for confirmation / edit before using an inferred ticket
-    "confirm_ticket": true,
-
-    // Add the ticket to the commit title - feat(app): TICKET my commit title
-    "add_to_title": true,
-
-    // Deprecated, prefer \`prepend_hashtag\`
-    "append_hashtag": false,
-
-    // "Never" | "Prompt" | "Always" - 12345 --> #12345
-    "prepend_hashtag": "Never",
-
-    // Wrap the ticket in the commit title: "" | "[]" | "()" | "{}"
-    "surround": "",
-
-    // "start" | "end" | "before-colon" | "beginning"
-    "title_position": "start"
-  },
-
-  "commit_title": {
-    // Includes total size of title + type + scope + ticket
-    "max_size": 70
-  },
-
-  "commit_body": {
-    "enable": true,
-    "required": false,
-
-    // Split sentences into multiple lines automatically
-    "split_by_period": false
-  },
-
-  "commit_footer": {
-    "enable": true,
-    "initial_value": [],
-
-    // "closes", "trailer", "breaking-change", "deprecated", "custom"
-    "options": ["closes", "trailer", "breaking-change", "deprecated", "custom"]
-  },
-
-  "breaking_change": {
-    // Adds \`!\` to the commit title when a breaking change is selected
-    "add_exclamation_to_title": true
-  },
-
-  // Confirm / edit with $GIT_EDITOR or $EDITOR
-  "confirm_with_editor": false,
-
-  // Show a final confirmation prompt before running git commit
-  "confirm_commit": true,
-
-  // Reuse the last known value from a previous canceled or failed commit
-  "cache_last_value": true,
-
-  // Pretty-print the final commit preview before execution
-  "print_commit_output": true,
-
-  /* BRANCH FIELDS */
-  // Optional shell commands to run before / after creating branches or worktrees
-  "branch_pre_commands": [],
-  "branch_post_commands": [],
-  "worktree_pre_commands": [],
-  "worktree_post_commands": [],
-
-  "branch_user": {
-    "enable": true,
-    "required": false,
-
-    // "/" | "-" | "_" - user/feat/my-branch
-    "separator": "/"
-  },
-
-  "branch_type": {
-    "enable": true,
-    "separator": "/",
-    "autocomplete": true,
-  },
-
-  "branch_scope": {
-    "enable": true,
-    "separator": "-",
-    "autocomplete": true,
-  },
-
-  "branch_ticket": {
-    "enable": true,
-    "required": false,
-    "separator": "-"
-  },
-
-  "branch_version": {
-    "enable": false,
-    "required": false,
-    "separator": "/"
-  },
-
-  "branch_description": {
-    // Maximum length for the description segment of the branch name
-    "max_length": 70,
-
-    // Allowed values: "" | "/" | "-" | "_"
-    "separator": ""
-  },
-
-  // "branch" | "worktree"
-  "branch_action_default": "branch",
-
-  // Order of values in the final branch name
-  "branch_order": ["user", "version", "type", "ticket", "scope", "description"],
-
-  // Deprecated, prefer \`worktrees.enable\`
-  "enable_worktrees": true,
-
-  "worktrees": {
-    // If false, always create a branch instead of prompting for a worktree
-    "enable": true,
-
-    // Directory where worktrees are created
-    "base_path": "..",
-
-    // Available template variables include:
-    // {{repo_name}}, {{branch_description}}, {{user}}, {{type}}, {{scope}}, {{ticket}}, {{version}}
-    "folder_template": "{{repo_name}}-{{ticket}}-{{branch_description}}"
-  },
-
-  /* OTHER FIELDS */
-  "overrides": {
-    // Useful on Windows or for shells with different multiline behavior
-    "shell": "/bin/sh"
-  }
-}
-`;

package/src/git.test.ts

@@ -1,64 +0,0 @@
-import { beforeEach, describe, expect, it, vi } from "vitest";
-
-const mocked = vi.hoisted(() => ({
-  error: vi.fn(),
-  execSync: vi.fn(),
-}));
-
-vi.mock("child_process", () => ({
-  execSync: mocked.execSync,
-}));
-
-vi.mock("@clack/prompts", () => ({
-  log: {
-    error: mocked.error,
-  },
-}));
-
-vi.mock("picocolors", () => ({
-  default: {
-    red: (value: string) => value,
-  },
-}));
-
-vi.mock("./args", () => ({
-  flags: {
-    git_args: "",
-  },
-}));
-
-describe("ensure_staged_changes", () => {
-  beforeEach(() => {
-    mocked.error.mockReset();
-    mocked.execSync.mockReset();
-  });
-
-  it("does not exit when staged changes exist", async () => {
-    const { ensure_staged_changes } = await import("./git");
-    const exit = vi.spyOn(process, "exit").mockImplementation(() => {
-      throw new Error("process.exit");
-    });
-
-    mocked.execSync.mockReturnValue(Buffer.from("A  src/git.ts\n"));
-
-    ensure_staged_changes();
-
-    expect(exit).not.toHaveBeenCalled();
-    expect(mocked.error).not.toHaveBeenCalled();
-  });
-
-  it("exits early when no staged changes exist", async () => {
-    const { ensure_staged_changes } = await import("./git");
-    const exit = vi.spyOn(process, "exit").mockImplementation(() => {
-      throw new Error("process.exit");
-    });
-
-    mocked.execSync.mockReturnValue(Buffer.from(" M src/git.ts\n"));
-
-    expect(() => ensure_staged_changes()).toThrow("process.exit");
-    expect(mocked.error).toHaveBeenCalledWith(
-      'no changes added to commit (use "git add" and/or "git commit -a")',
-    );
-    expect(exit).toHaveBeenCalledWith(0);
-  });
-});

package/src/git.ts

@@ -1,72 +0,0 @@
-#! /usr/bin/env node
-import { execSync } from "child_process";
-import * as p from "@clack/prompts";
-import color from "picocolors";
-import { flags } from "./args";
-
-const porcelain_states = ["M", "T", "R", "D", "A", "C"];
-
-export function git_status(): { index: string[]; work_tree: string[] } {
-  let status = "";
-  try {
-    status = execSync(`git ${flags.git_args} status --porcelain`, {
-      stdio: "pipe",
-    }).toString();
-  } catch (err) {
-    p.log.error(color.red("Failed to git status" + err));
-    return { index: [], work_tree: [] };
-  }
-
-  const lines = status.split("\n");
-  const work_tree: string[] = [];
-  const index: string[] = [];
-  lines.forEach((v) => {
-    const line = v.trimEnd();
-    if (!line) return;
-
-    const path_plus_file = line.substring(2).trim();
-    const first_char = line.charAt(0).trim();
-    const second_char = line.charAt(1).trim();
-
-    // Untracked, always dirty
-    if (first_char === "?" || second_char === "?") {
-      work_tree.push(path_plus_file);
-    }
-
-    if (porcelain_states.includes(first_char)) {
-      index.push(path_plus_file);
-    }
-
-    if (porcelain_states.includes(second_char)) {
-      work_tree.push(path_plus_file);
-    }
-  });
-
-  return { index, work_tree };
-}
-
-export function git_add(files: string[]) {
-  const space_delimited_files = files.join(" ");
-  if (space_delimited_files) {
-    try {
-      execSync(`git ${flags.git_args} add ${space_delimited_files}`, {
-        stdio: "pipe",
-      }).toString();
-      p.log.success(color.green("Changes successfully staged"));
-    } catch (err) {
-      p.log.error(color.red("Failed to stage changes"));
-    }
-  }
-}
-
-export function ensure_staged_changes(): void {
-  const updated_status = git_status();
-  if (updated_status.index.length) return;
-
-  p.log.error(
-    color.red(
-      'no changes added to commit (use "git add" and/or "git commit -a")',
-    ),
-  );
-  process.exit(0);
-}

package/src/help.ts

@@ -1,138 +0,0 @@
-import { execSync } from "child_process";
-import { InferOutput } from "valibot";
-import { flags } from "./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 ADDITIONAL_COMMAND_DEFINITIONS: Record<string, string> = {
-  "better-branch": "Create a branch or worktree from a guided prompt flow.",
-  "better-commits-init":
-    "Create a .better-commits.jsonc config in this repository.",
-};
-
-const CLI_FLAG_DEFINITIONS: Record<string, string> = {
-  "--no-interactive": "Run without tui prompts.",
-  "--dry-run": "Print the commit command without creating a commit.",
-  "--help": "Show help information and exit.",
-};
-
-const COMMIT_FLAG_DEFINITIONS: Record<string, string> = {
-  "--type": "Set commit type (can be inferred from branch).",
-  "--scope": "Set commit scope (can be inferred from branch).",
-  "--title": "Set commit title/description.",
-  "--body": "Set commit body text.",
-  "--ticket": "Set ticket / issue (can be inferred from branch).",
-  "--closes": "Set closes footer (true/false).",
-  "--trailer": "Set trailer footer value.",
-  "--breaking-title": "Set breaking-change title footer.",
-  "--breaking-body": "Set breaking-change body footer.",
-  "--deprecates-title": "Set deprecates footer title text.",
-  "--deprecates-body": "Set deprecates footer body text.",
-  "--custom-footer": "Set a custom footer line.",
-};
-
-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 ${flags.git_args} branch --show-current`, { stdio: "pipe" })
-        .toString()
-        .trim() || "(none)";
-  } catch {
-    // noop
-  }
-
-  const inferred_type =
-    infer_type_from_git(config.commit_type.options, 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,
-        },
-        flags.git_args,
-      ) || "Unknown"
-    : "Infer Disabled";
-  const inferred_scope = config.commit_scope.infer_scope_from_branch
-    ? infer_scope_from_git(config.commit_scope.options, 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 commit_flags = to_definition_lines(COMMIT_FLAG_DEFINITIONS);
-  const additional_commands = to_definition_lines(
-    ADDITIONAL_COMMAND_DEFINITIONS,
-  );
-
-  console.log(`
-${color.green(" better-commits")} ${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("Commit Flags")} 
-${commit_flags}
-
-${color.gray("Git Flags (Advanced)")} 
-${git_flags}
-
-${color.gray("ADDITIONAL COMMANDS")} 
-${additional_commands}
-
-`);
-}

package/src/index.test.ts

@@ -1,7 +0,0 @@
-import { describe, expect, it } from "vitest";
-
-describe("project test setup", () => {
-  it("runs Vitest in this TypeScript project", () => {
-    expect(true).toBe(true);
-  });
-});

package/src/index.ts

@@ -1,101 +0,0 @@
-#! /usr/bin/env node
-
-import { chdir } from "process";
-import * as p from "@clack/prompts";
-import { InferInput, InferOutput, ValiError, parse } from "valibot";
-import { CommitState, Config } from "./valibot-state";
-import {
-  load_setup,
-  get_git_root,
-  NOOP_PROMPT_CACHE,
-  ConfigSource,
-} from "./utils";
-import { create_strict_commit_state } from "./utils/no-interactive-validation";
-import Configstore from "configstore";
-import { CommitTypePrompt } from "./prompts/commit-type.prompt";
-import { Runnable } from "./prompts/runnable";
-import { CommitScopePrompt } from "./prompts/commit-scope.prompt";
-import { CommitTicketPrompt } from "./prompts/commit-ticket.prompt";
-import { CommitTitlePrompt } from "./prompts/commit-title.prompt";
-import { CommitBodyPrompt } from "./prompts/commit-body.prompt";
-import { CommitFooterPrompt } from "./prompts/commit-footer.prompt";
-import { CommitConfirmPrompt } from "./prompts/commit-confirm.prompt";
-import { CommitStatusPrompt } from "./prompts/commit-status.prompt";
-import { flags } from "./args";
-import { get_package_version } from "./utils";
-import { infer_not_interactive } from "./utils/infer";
-import { print_help_text } from "./help";
-
-type PromptCtor = new (
-  config: InferOutput<typeof Config>,
-  commit_state: InferOutput<typeof CommitState>,
-  prompt_cache: Configstore,
-) => Runnable;
-
-const promptCtors: PromptCtor[] = [
-  CommitStatusPrompt,
-  CommitTypePrompt,
-  CommitScopePrompt,
-  CommitTicketPrompt,
-  CommitTitlePrompt,
-  CommitBodyPrompt,
-  CommitFooterPrompt,
-  CommitConfirmPrompt,
-];
-
-const { config, config_source } = load_setup();
-
-main(config, config_source);
-
-export async function main(
-  config: InferOutput<typeof Config>,
-  config_source: ConfigSource,
-) {
-  chdir(get_git_root());
-
-  if (flags.version) {
-    const version = get_package_version();
-    p.log.step("Better Commits v" + version);
-    return;
-  }
-
-  if (flags.help) {
-    print_help_text(config, config_source);
-    return;
-  }
-
-  const infer_state = infer_not_interactive(config);
-  const flags_plus_infer: InferInput<typeof CommitState> = {
-    ...flags.commit_state,
-    type: (flags.commit_state.type || infer_state?.type) ?? "",
-    scope: (flags.commit_state.scope || infer_state?.scope) ?? "",
-    ticket: (flags.commit_state.ticket || infer_state?.ticket) ?? "",
-  };
-
-  const commit_state = parse(CommitState, flags_plus_infer);
-
-  if (!flags.interactive) {
-    try {
-      parse(create_strict_commit_state(config), commit_state);
-    } catch (err) {
-      if (err instanceof ValiError) {
-        p.log.error(`Invalid commit input: ${err.message}`);
-      } else {
-        p.log.error(`Failed to validate commit input: ${err}`);
-      }
-      process.exit(0);
-    }
-  }
-
-  const prompt_cache = config.cache_last_value
-    ? new Configstore("better-commits")
-    : NOOP_PROMPT_CACHE;
-
-  const prompts_to_run = flags.interactive
-    ? promptCtors
-    : [CommitConfirmPrompt];
-
-  for (const Prompt of prompts_to_run) {
-    await new Prompt(config, commit_state, prompt_cache).run();
-  }
-}