better-commits 1.20.0-cli-flags → 1.20.1-temp.0

package/src/branch-help.ts

@@ -1,114 +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_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).",
-  "--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 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("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,95 +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 { 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,
-  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;

package/src/git.ts

@@ -1,60 +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"));
-    }
-  }
-}

package/src/help.ts

@@ -1,131 +0,0 @@
-import { execSync } from "child_process";
-import { InferOutput } from "valibot";
-import { flags } from "./args";
-import { get_package_version } from "./utils";
-import { 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.json config in this repository.",
-};
-
-const CLI_FLAG_DEFINITIONS: Record<string, string> = {
-  "--interactive": "Run in interactive prompt mode (default behavior).",
-  "--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 (for example feat, fix, docs).",
-  "--scope": "Set commit scope.",
-  "--title": "Set commit title/description.",
-  "--body": "Set commit body text.",
-  "--closes": "Set issue/ticket id for a closes footer.",
-  "--ticket": "Set ticket value used in the title.",
-  "--trailer": "Set trailer footer value.",
-  "--deprecates": "Set issue/ticket id for a deprecates footer.",
-  "--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 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("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,100 +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) ?? "",
-    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 --no-interactive commit input: ${err.message}`);
-      } else {
-        p.log.error(`Failed to validate --no-interactive 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();
-  }
-}

package/src/init.ts

@@ -1,25 +0,0 @@
-#! /usr/bin/env node
-
-import * as p from "@clack/prompts";
-import fs from "fs";
-import color from "picocolors";
-import { parse } from "valibot";
-import { CONFIG_FILE_NAME, get_git_root } from "./utils";
-import { Config } from "./valibot-state";
-
-try {
-  console.clear();
-  p.intro(`${color.bgCyan(color.black(" better-commits-init "))}`);
-  const root = get_git_root();
-  const root_path = `${root}/${CONFIG_FILE_NAME}`;
-  const default_config = parse(Config, {});
-  fs.writeFileSync(root_path, JSON.stringify(default_config, null, 4));
-  p.log.success(`${color.green("Successfully created .better-commits.json")}`);
-  p.outro(
-    `Run ${color.bgBlack(color.white("better-commits"))} to start the CLI`,
-  );
-} catch (err: any) {
-  p.log.error(
-    `${color.red("Could not determine git root folder. better-commits-init must be used in a git repository")}`,
-  );
-}

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;
-  }
-}