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

package/src/utils.ts

@@ -1,219 +0,0 @@
-import * as p from "@clack/prompts";
-import { execSync } from "child_process";
-import fs from "fs";
-import { homedir } from "os";
-import color from "picocolors";
-import { InferOutput, ValiError, parse } from "valibot";
-import { Config } from "./valibot-state";
-import { V_BRANCH_ACTIONS } from "./valibot-consts";
-import { flags } from "./args";
-import Configstore from "configstore";
-
-export const CONFIG_FILE_NAME = ".better-commits.json";
-export const SPACE_TO_SELECT = `${color.dim("(<space> to select)")}`;
-export const A_FOR_ALL = `${color.dim(
-  "(<space> to select, <a> to select all)",
-)}`;
-export const OPTIONAL_PROMPT = `${color.dim("(optional)")}`;
-export const COMMIT_FOOTER_OPTIONS = [
-  {
-    value: "closes",
-    label: "closes <issue/ticket>",
-    hint: "Attempts to infer ticket from branch",
-  },
-  {
-    value: "trailer",
-    label: "trailer",
-    hint: "Appends trailer based on commit type",
-  },
-  {
-    value: "breaking-change",
-    label: "breaking change",
-    hint: "Add breaking change",
-  },
-  { value: "deprecated", label: "deprecated", hint: "Add deprecated change" },
-  { value: "custom", label: "custom", hint: "Add a custom footer" },
-];
-export const BRANCH_ACTION_OPTIONS: {
-  value: InferOutput<typeof V_BRANCH_ACTIONS>;
-  label: string;
-  hint?: string;
-}[] = [
-  { value: "branch", label: "Branch" },
-  { value: "worktree", label: "Worktree" },
-];
-
-export const NOOP_PROMPT_CACHE = {
-  get: () => "",
-  set: (key: string, value: string) => {},
-  clear: () => {},
-} as unknown as Configstore;
-
-export type ConfigSource = "repository" | "global" | "none";
-
-export type LoadedSetup = {
-  config: InferOutput<typeof Config>;
-  config_source: ConfigSource;
-};
-
-/* LOAD */
-export function load_setup(
-  cli_name = " better-commits ",
-  git_args = flags.git_args,
-): LoadedSetup {
-  console.clear();
-  p.intro(`${color.bgCyan(color.black(cli_name))}`);
-
-  let global_config = null;
-  const home_path = get_default_config_path();
-  if (fs.existsSync(home_path)) {
-    global_config = read_config_from_path(home_path);
-  }
-
-  const root = get_git_root(git_args);
-  const root_path = `${root}/${CONFIG_FILE_NAME}`;
-  if (fs.existsSync(root_path)) {
-    p.log.step("Reading from Repository Config");
-    const repo_config = read_config_from_path(root_path);
-    return {
-      config: global_config
-        ? {
-            ...repo_config,
-            overrides: global_config.overrides.shell
-              ? global_config.overrides
-              : repo_config.overrides,
-            confirm_with_editor: global_config.confirm_with_editor,
-            cache_last_value: global_config.cache_last_value,
-          }
-        : repo_config,
-      config_source: "repository",
-    };
-  }
-
-  if (global_config) {
-    p.log.step("Reading from Global Config");
-    return {
-      config: global_config,
-      config_source: "global",
-    };
-  }
-
-  const default_config = parse(Config, {});
-  p.log.step(
-    "Config not found. Generating default .better-commit.json at $HOME",
-  );
-  fs.writeFileSync(home_path, JSON.stringify(default_config, null, 4));
-  return {
-    config: default_config,
-    config_source: "none",
-  };
-}
-
-function read_config_from_path(config_path: string) {
-  let res = null;
-  try {
-    res = JSON.parse(fs.readFileSync(config_path, "utf8"));
-  } catch (err) {
-    p.log.error("Invalid JSON file. Exiting.\n" + err);
-    process.exit(0);
-  }
-
-  return validate_config(res);
-}
-
-function validate_config(config: unknown): InferOutput<typeof Config> {
-  try {
-    return parse(Config, config);
-  } catch (err: any) {
-    if (err instanceof ValiError) {
-      const first_issue_path = err.issues[0].path ?? [];
-      const dot_path = first_issue_path
-        .map((item: { key?: unknown }) => item.key)
-        .filter(
-          (key: unknown): key is string | number =>
-            typeof key === "string" || typeof key === "number",
-        )
-        .join(".");
-      p.log.error(
-        `Invalid Configuration: ${color.red(dot_path)}\n` + err.message,
-      );
-    }
-    process.exit(0);
-  }
-}
-/* END LOAD */
-
-/*
-rev-parse will fail in a --bare repository root
-*/
-export function get_git_root(git_args = flags.git_args): string {
-  let path = ".";
-  try {
-    path = execSync(`git ${git_args} rev-parse --show-toplevel`)
-      .toString()
-      .trim();
-  } catch (err) {
-    p.log.warn(
-      "Could not find git root. If in a --bare repository, ignore this warning.",
-    );
-  }
-  return path;
-}
-
-export function get_default_config_path(): string {
-  return homedir() + "/" + CONFIG_FILE_NAME;
-}
-
-export function get_package_version(): string {
-  try {
-    const package_json = JSON.parse(
-      fs.readFileSync(new URL("../package.json", import.meta.url), "utf8"),
-    ) as { version?: string };
-
-    return package_json.version ?? "unknown";
-  } catch {
-    return "unknown";
-  }
-}
-
-export function addNewLine(arr: string[], i: number) {
-  return i === arr.length - 1 ? "" : "\n";
-}
-
-export function clean_commit_title(title: string): string {
-  const title_trimmed = title.trim();
-  const remove_period = title_trimmed.endsWith(".");
-  if (remove_period) {
-    return title_trimmed.substring(0, title_trimmed.length - 1).trim();
-  }
-  return title.trim();
-}
-
-export function get_value_from_cache(
-  config_store: Configstore,
-  key: string,
-): string {
-  try {
-    return config_store.get(key) ?? "";
-  } catch (err) {
-    p.log.warn(
-      `Could not access ${key} from cache. Check that "~/.config" exists. Set "cache_last_value" to false to disable.`,
-    );
-  }
-
-  return "";
-}
-
-export function set_value_cache(
-  config_store: Configstore,
-  key: string,
-  value: string,
-): void {
-  try {
-    config_store.set(key, value);
-  } catch (err) {
-    p.log.warn(
-      `Could not access ${key} from cache. Check that "~/.config" exists. Set "cache_last_value" to false to disable.`,
-    );
-  }
-}

package/src/valibot-consts.ts

@@ -1,114 +0,0 @@
-import * as v from "valibot";
-
-export const CUSTOM_SCOPE_KEY: "custom" = "custom";
-export const FOOTER_OPTION_VALUES: v.InferOutput<typeof V_FOOTER_OPTIONS>[] = [
-  "closes",
-  "trailer",
-  "breaking-change",
-  "deprecated",
-  "custom",
-];
-export const V_BRANCH_ACTIONS = v.picklist(["branch", "worktree"]);
-export const V_FOOTER_OPTIONS = v.picklist([
-  "closes",
-  "trailer",
-  "breaking-change",
-  "deprecated",
-  "custom",
-]);
-export const V_BRANCH_FIELDS = v.picklist([
-  "user",
-  "version",
-  "type",
-  "ticket",
-  "description",
-]);
-export const V_BRANCH_CONFIG_FIELDS = v.picklist([
-  "branch_user",
-  "branch_version",
-  "branch_type",
-  "branch_ticket",
-  "branch_description",
-]);
-export const BRANCH_ORDER_DEFAULTS: v.InferOutput<typeof V_BRANCH_FIELDS>[] = [
-  "user",
-  "version",
-  "type",
-  "ticket",
-  "description",
-];
-
-export const DEFAULT_SCOPE_OPTIONS = [
-  { value: "app", label: "app" },
-  { value: "shared", label: "shared" },
-  { value: "server", label: "server" },
-  { value: "tools", label: "tools" },
-  { value: "", label: "none" },
-];
-
-export const DEFAULT_TYPE_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" },
-];

package/src/valibot-state.test.ts

@@ -1,48 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { ValiError, parse } from "valibot";
-import { Config } from "./valibot-state";
-
-describe("Config", () => {
-  it("parses a defaulted config from empty input", () => {
-    const config = parse(Config, {});
-
-    expect(config.commit_type.initial_value).toBe("feat");
-    expect(config.commit_scope.initial_value).toBe("app");
-    expect(config.commit_type.options.length).toBeGreaterThan(0);
-    expect(config.commit_scope.options.length).toBeGreaterThan(0);
-  });
-
-  it("adds the custom scope option when custom_scope is enabled", () => {
-    const config = parse(Config, {
-      commit_scope: {
-        custom_scope: true,
-        initial_value: "custom",
-        options: [{ value: "app", label: "app" }],
-      },
-    });
-
-    expect(config.commit_scope.options.map((option) => option.value)).toContain(
-      "custom",
-    );
-  });
-
-  it("rejects commit_type.initial_value values outside options", () => {
-    expect(() =>
-      parse(Config, {
-        commit_type: {
-          initial_value: "unknown",
-          options: [{ value: "feat", label: "feat" }],
-        },
-      }),
-    ).toThrowError(ValiError);
-
-    expect(() =>
-      parse(Config, {
-        commit_type: {
-          initial_value: "unknown",
-          options: [{ value: "feat", label: "feat" }],
-        },
-      }),
-    ).toThrow(/must exist in options/);
-  });
-});

package/src/valibot-state.ts

@@ -1,265 +0,0 @@
-import * as v from "valibot";
-import {
-  BRANCH_ORDER_DEFAULTS,
-  CUSTOM_SCOPE_KEY,
-  DEFAULT_SCOPE_OPTIONS,
-  DEFAULT_TYPE_OPTIONS,
-  FOOTER_OPTION_VALUES,
-  V_BRANCH_ACTIONS,
-  V_BRANCH_FIELDS,
-  V_FOOTER_OPTIONS,
-} from "./valibot-consts";
-
-const CommitTypeConfig = v.pipe(
-  v.optional(
-    v.object({
-      enable: v.optional(v.boolean(), true),
-      initial_value: v.optional(v.string(), "feat"),
-      max_items: v.optional(v.pipe(v.number(), v.minValue(1)), 20),
-      infer_type_from_branch: v.optional(v.boolean(), true),
-      append_emoji_to_label: v.optional(v.boolean(), false),
-      append_emoji_to_commit: v.optional(v.boolean(), false),
-      emoji_commit_position: v.optional(
-        v.picklist(["Start", "After-Colon"]),
-        "Start",
-      ),
-      options: v.optional(
-        v.array(
-          v.object({
-            value: v.string(),
-            label: v.optional(v.string()),
-            hint: v.optional(v.string()),
-            emoji: v.optional(v.pipe(v.string(), v.emoji())),
-            trailer: v.optional(v.string()),
-          }),
-        ),
-        DEFAULT_TYPE_OPTIONS,
-      ),
-    }),
-    {},
-  ),
-  v.rawCheck(({ dataset, addIssue }) => {
-    if (
-      dataset.typed &&
-      !dataset.value.options.some(
-        (option) => option.value === dataset.value.initial_value,
-      )
-    ) {
-      addIssue({
-        message: `Type: initial_value "${dataset.value.initial_value}" must exist in options`,
-      });
-    }
-  }),
-  v.transform((value) => ({
-    ...value,
-    options: value.options.map((option) => ({
-      ...option,
-      label:
-        option.emoji && value.append_emoji_to_label
-          ? `${option.emoji} ${option.label}`
-          : option.label,
-    })),
-  })),
-);
-
-const CommitScopeConfig = v.pipe(
-  v.optional(
-    v.object({
-      enable: v.optional(v.boolean(), true),
-      custom_scope: v.optional(v.boolean(), false),
-      max_items: v.optional(v.pipe(v.number(), v.minValue(1)), 20),
-      initial_value: v.optional(v.string(), "app"),
-      options: v.optional(
-        v.array(
-          v.object({
-            value: v.string(),
-            label: v.optional(v.string()),
-            hint: v.optional(v.string()),
-          }),
-        ),
-        DEFAULT_SCOPE_OPTIONS,
-      ),
-    }),
-    {},
-  ),
-  v.rawCheck(({ dataset, addIssue }) => {
-    if (!dataset.typed) return;
-
-    const option_values = dataset.value.options.map((option) => option.value);
-    if (dataset.value.custom_scope) option_values.push(CUSTOM_SCOPE_KEY);
-
-    if (!option_values.includes(dataset.value.initial_value)) {
-      addIssue({
-        message: `Scope: initial_value "${dataset.value.initial_value}" must exist in options`,
-      });
-    }
-  }),
-  v.transform((value) => {
-    const option_values = value.options.map((option) => option.value);
-    if (value.custom_scope && !option_values.includes(CUSTOM_SCOPE_KEY)) {
-      return {
-        ...value,
-        options: [
-          ...value.options,
-          {
-            label: CUSTOM_SCOPE_KEY,
-            value: CUSTOM_SCOPE_KEY,
-            hint: "Write a custom scope",
-          },
-        ],
-      };
-    }
-
-    return value;
-  }),
-);
-
-export const Config = v.object({
-  check_status: v.optional(v.boolean(), true),
-  commit_type: CommitTypeConfig,
-  commit_scope: CommitScopeConfig,
-  check_ticket: v.optional(
-    v.object({
-      infer_ticket: v.optional(v.boolean(), true),
-      confirm_ticket: v.optional(v.boolean(), true),
-      add_to_title: v.optional(v.boolean(), true),
-      append_hashtag: v.optional(v.boolean(), false),
-      prepend_hashtag: v.optional(
-        v.picklist(["Never", "Always", "Prompt"]),
-        "Never",
-      ),
-      surround: v.optional(v.picklist(["", "()", "[]", "{}"]), ""),
-      title_position: v.optional(
-        v.picklist(["start", "end", "before-colon", "beginning"]),
-        "start",
-      ),
-    }),
-    {},
-  ),
-  commit_title: v.optional(
-    v.object({
-      max_size: v.optional(v.pipe(v.number(), v.minValue(1)), 70),
-    }),
-    {},
-  ),
-  commit_body: v.optional(
-    v.object({
-      enable: v.optional(v.boolean(), true),
-      required: v.optional(v.boolean(), false),
-      split_by_period: v.optional(v.boolean(), false),
-    }),
-    {},
-  ),
-  commit_footer: v.optional(
-    v.object({
-      enable: v.optional(v.boolean(), true),
-      initial_value: v.optional(v.array(V_FOOTER_OPTIONS), []),
-      options: v.optional(v.array(V_FOOTER_OPTIONS), FOOTER_OPTION_VALUES),
-    }),
-    {},
-  ),
-  breaking_change: v.optional(
-    v.object({
-      add_exclamation_to_title: v.optional(v.boolean(), true),
-    }),
-    {},
-  ),
-  cache_last_value: v.optional(v.boolean(), true),
-  confirm_with_editor: v.optional(v.boolean(), false),
-  confirm_commit: v.optional(v.boolean(), true),
-  print_commit_output: v.optional(v.boolean(), true),
-  branch_pre_commands: v.optional(v.array(v.string()), []),
-  branch_post_commands: v.optional(v.array(v.string()), []),
-  worktree_pre_commands: v.optional(v.array(v.string()), []),
-  worktree_post_commands: v.optional(v.array(v.string()), []),
-  branch_user: v.optional(
-    v.object({
-      enable: v.optional(v.boolean(), true),
-      required: v.optional(v.boolean(), false),
-      separator: v.optional(v.picklist(["/", "-", "_"]), "/"),
-    }),
-    {},
-  ),
-  branch_type: v.optional(
-    v.object({
-      enable: v.optional(v.boolean(), true),
-      separator: v.optional(v.picklist(["/", "-", "_"]), "/"),
-    }),
-    {},
-  ),
-  branch_version: v.optional(
-    v.object({
-      enable: v.optional(v.boolean(), false),
-      required: v.optional(v.boolean(), false),
-      separator: v.optional(v.picklist(["/", "-", "_"]), "/"),
-    }),
-    {},
-  ),
-  branch_ticket: v.optional(
-    v.object({
-      enable: v.optional(v.boolean(), true),
-      required: v.optional(v.boolean(), false),
-      separator: v.optional(v.picklist(["/", "-", "_"]), "-"),
-    }),
-    {},
-  ),
-  branch_description: v.optional(
-    v.object({
-      max_length: v.optional(v.pipe(v.number(), v.minValue(1)), 70),
-      separator: v.optional(v.picklist(["", "/", "-", "_"]), ""),
-    }),
-    {},
-  ),
-  branch_action_default: v.optional(V_BRANCH_ACTIONS, "branch"),
-  branch_order: v.optional(v.array(V_BRANCH_FIELDS), BRANCH_ORDER_DEFAULTS),
-  enable_worktrees: v.optional(v.boolean(), true),
-  worktrees: v.optional(
-    v.object({
-      enable: v.optional(v.boolean(), true),
-      base_path: v.optional(v.string(), ".."),
-      folder_template: v.optional(
-        v.string(),
-        "{{repo_name}}-{{ticket}}-{{branch_description}}",
-      ),
-    }),
-    {},
-  ),
-  overrides: v.optional(
-    v.object({
-      shell: v.optional(v.string()),
-    }),
-    {},
-  ),
-});
-
-export const COMMIT_STATE_ENTRIES = {
-  type: v.optional(v.string(), ""),
-  scope: v.optional(v.string(), ""),
-  title: v.optional(v.string(), ""),
-  body: v.optional(v.string(), ""),
-  closes: v.optional(v.string(), ""),
-  ticket: v.optional(v.string(), ""),
-  breaking_title: v.optional(v.string(), ""),
-  breaking_body: v.optional(v.string(), ""),
-  deprecates: v.optional(v.string(), ""),
-  deprecates_title: v.optional(v.string(), ""),
-  deprecates_body: v.optional(v.string(), ""),
-  custom_footer: v.optional(v.string(), ""),
-  trailer: v.optional(v.string(), ""),
-};
-
-export const CommitState = v.optional(v.object(COMMIT_STATE_ENTRIES), {});
-
-export const BRANCH_STATE_ENTRIES = {
-  user: v.optional(v.string(), ""),
-  type: v.optional(v.string(), ""),
-  ticket: v.optional(v.string(), ""),
-  description: v.optional(v.string(), ""),
-  version: v.optional(v.string(), ""),
-  checkout: v.optional(V_BRANCH_ACTIONS, "branch"),
-};
-
-export const BranchState = v.optional(
-  v.object(BRANCH_STATE_ENTRIES),
-  {},
-);

package/tsconfig.json

@@ -1,15 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "ESNext",
-    "target": "ESNext",
-    "declaration": true,
-    "moduleResolution": "bundler",
-    "emitDeclarationOnly": true,
-    "strict": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "allowJs": true,
-    "types": ["node"]
-  },
-  "exclude": ["dist", "node_modules", ".svelte-kit", ".opencode"]
-}

package/tsup.config.ts

@@ -1,12 +0,0 @@
-import { defineConfig } from "tsup";
-
-export default defineConfig([
-  {
-    entry: ["./src/index.ts", "./src/branch.ts", "./src/init.ts"],
-    clean: true,
-    format: ["esm"],
-    minify: true,
-    dts: false,
-    outDir: "./dist",
-  },
-]);

package/vitest.config.ts

@@ -1,8 +0,0 @@
-import { defineConfig } from "vitest/config";
-
-export default defineConfig({
-  test: {
-    environment: "node",
-    include: ["src/**/*.test.ts"],
-  },
-});