better-commits 1.23.2 → 1.23.3

package/dist/init.js

@@ -1,2 +1,45 @@
 #! /usr/bin/env node
-import{g as c,h as e,m as a,n as p}from"./chunk-B7AGSPP3.js";import*as t from"@clack/prompts";import l from"fs";import o from"picocolors";await m();async function m(){console.clear(),t.intro(`${o.bgCyan(o.black(" better-commits-init "))}`);let r=a(),i=p(r),s=`${r}/${e}`;if(i){let n=await t.confirm({message:`${i.split("/").pop()} already exists. Replace with default ${e}?`});if(t.isCancel(n)||!n){t.outro("Cancelled");return}}try{l.writeFileSync(s,c)}catch{t.log.error(`${o.red("Could not determine git root folder. better-commits-init must be used in a git repository")}`)}t.log.success(`${o.green(`Successfully created ${s.split("/").pop()}`)}`),t.outro(`Run ${o.bgBlack(o.white("better-commits"))} to start the CLI`)}export{m as create_init_config};
+import {
+  CONFIG_FILE_NAME,
+  DEFAULT_CONFIG_TEMPLATE,
+  get_git_root,
+  get_repository_config_path
+} from "./chunk-GAAS3VS3.js";
+
+// src/init.ts
+import * as p from "@clack/prompts";
+import fs from "fs";
+import color from "picocolors";
+await create_init_config();
+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}?`
+    });
+    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`
+  );
+}
+export {
+  create_init_config
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "better-commits",
   "private": false,
-  "version": "1.23.2",
+  "version": "1.23.3",
   "description": "A CLI for creating better commits following the conventional commits specification",
   "author": "Erik Verduin (https://github.com/everduin94)",
   "type": "module",
@@ -13,6 +13,14 @@
     "commit"
   ],
   "main": "dist/index.js",
+  "engines": {
+    "node": ">=20"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "readme.md"
+  ],
   "bin": {
     "better-commits-init": "./dist/init.js",
     "better-commits": "./dist/index.js",
@@ -29,7 +37,7 @@
     "@bomb.sh/args": "^0.3.1",
     "@clack/core": "^1.2.0",
     "@clack/prompts": "^1.2.0",
-    "configstore": "^5.0.1",
+    "configstore": "^8.0.0",
     "jsonc-parser": "^3.3.1",
     "picocolors": "^1.0.0",
     "valibot": "^1.3.1"
@@ -44,12 +52,12 @@
   },
   "devDependencies": {
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/npm": "^13.1.3",
+    "@semantic-release/npm": "^13.1.5",
     "@types/configstore": "^6.0.0",
     "@types/node": "^24.10.1",
     "jiti": "^1.17.0",
     "prettier": "3.2.5",
-    "semantic-release": "^25.0.2",
+    "semantic-release": "^25.0.3",
     "tsup": "^8.0.2",
     "tsx": "^3.12.3",
     "typescript": "^5.4.5",

package/readme.md

@@ -3,7 +3,7 @@
 ![bc-gradient](https://github.com/Everduin94/better-commits/assets/14320878/2f94e6ea-a40f-4f3e-b0b2-5cc7d83a9a7d)
 
 [![better commits is enabled](https://img.shields.io/badge/better--commits-enabled?style=for-the-badge&logo=git&color=a6e3a1&logoColor=D9E0EE&labelColor=302D41)](https://github.com/Everduin94/better-commits)
-[![downloads](https://img.shields.io/npm/dt/better-commits.svg?style=for-the-badge&logo=npm&color=74c7ec&logoColor=D9E0EE&labelColor=302D41)](https://www.npmjs.com/package/better-commits)
+[![downloads](https://img.shields.io/npm/dt/better-commits.svg?style=for-the-badge&logo=npm&color=74c7ec&logoColor=D9E0EE&labelColor=302D41)](https://npmx.dev/package/better-commits)
 [![discord](https://img.shields.io/badge/discord-join--discord?style=for-the-badge&logo=discord&color=cba6f7&logoColor=D9E0EE&labelColor=302D41)](https://discord.gg/grHVnZwYup)
 
 </h3>
@@ -12,7 +12,7 @@
 A CLI for writing better commits, following the conventional commits specification.
 </p>
 
-<video src="https://github.com/Everduin94/better-commits/assets/14320878/8fb15d46-17c4-4e5d-80d9-79abe0a2a00a"></video> 
+<video src="https://github.com/Everduin94/better-commits/assets/14320878/8fb15d46-17c4-4e5d-80d9-79abe0a2a00a"></video>
 
 ## ✨ Features
 
@@ -36,6 +36,8 @@ As a side-effect of formatting messages
 
 ## 📦 Installation
 
+> Requires Node.js 20 or newer.
+
 ```sh
 npm install -g better-commits
 ```

package/.better-commits.json

@@ -1,52 +0,0 @@
-{
-  "commit_type": {
-    "append_emoji_to_label": true,
-    "append_emoji_to_commit": false
-  },
-  "commit_body": {
-    "split_by_period": true
-  },
-  "commit_scope": {
-    "enable": true,
-    "initial_value": "commit",
-    "options": [
-      {
-        "value": "commit",
-        "label": "commit"
-      },
-      {
-        "value": "branch",
-        "label": "branch"
-      },
-      {
-        "value": "init",
-        "label": "init"
-      },
-      {
-        "value": "util",
-        "label": "util"
-      },
-      {
-        "value": "build",
-        "label": "build"
-      },
-      {
-        "value": "help",
-        "label": "help"
-      },
-      {
-        "value": "",
-        "label": "none"
-      }
-    ]
-  },
-  "check_ticket": {
-    "prepend_hashtag": "Always"
-  },
-  "branch_pre_commands": [
-    "git stash",
-    "git checkout main",
-    "git pull -r origin main",
-    "npm install"
-  ]
-}

package/.github/workflows/publish.yml

@@ -1,34 +0,0 @@
-name: Publish to NPM
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  publish:
-    name: Publish
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      issues: write
-      pull-requests: write
-      id-token: write
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: "lts/*"
-          registry-url: "https://registry.npmjs.org"
-      - name: Install dependencies
-        run: npm ci
-      - name: Build package
-        run: npm run build
-      - name: Release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npx semantic-release

package/.github/workflows/test.yml

@@ -1,27 +0,0 @@
-name: Test
-
-on:
-  pull_request:
-  push:
-    branches:
-      - main
-
-jobs:
-  test:
-    name: npm test
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: "lts/*"
-          cache: npm
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Run tests
-        run: npm run test

package/.prettierignore

@@ -1,5 +0,0 @@
-# Ignore artifacts:
-build
-coverage
-node_modules
-dist

package/.prettierrc

@@ -1 +0,0 @@
-{}

package/dist/chunk-43H72S6V.js

@@ -1 +0,0 @@
-import{a as _,b as u,d as l,f as p}from"./chunk-B7AGSPP3.js";import*as s from"valibot";function g(t,n){let r=t.scope?t.scope.length+2:0,e=t.type?.length??0,i=n.include_ticket?t.ticket?.length??0:0,o=t.title?.length??0;return r+e+i+o}function a(t){return t.map(r=>r===""?'"" (none)':`"${r}"`).join(", ")}function G(t){let n=t.commit_type.options.map(e=>e.value),r=t.commit_scope.options.map(e=>e.value);return s.pipe(s.object(u),s.rawCheck(({dataset:e,addIssue:i})=>{if(!e.typed)return;let o=e.value.type?`"${e.value.type}"`:"(empty)";e.value.type&&!n.includes(e.value.type)&&i({message:`Invalid --type ${o}. Valid types: ${a(n)}.`})}),s.rawCheck(({dataset:e,addIssue:i})=>{if(!e.typed)return;let o=e.value.scope?`"${e.value.scope}"`:"(empty)";e.value.scope&&!t.commit_scope.custom_scope&&!r.includes(e.value.scope)&&i({message:`Invalid --scope ${o}. Valid scopes: ${a(r)}.`})}),s.rawCheck(({dataset:e,addIssue:i})=>{!e.typed||e.value.title.trim()||i({message:"Missing --title. Provide a non-empty commit title."})}),s.rawCheck(({dataset:e,addIssue:i})=>{if(!e.typed)return;let o=g(e.value,{include_ticket:t.check_ticket.add_to_title});o>t.commit_title.max_size&&i({message:`Title exceeds max width. Current size is ${o}, max is ${t.commit_title.max_size} (includes type, scope, and ticket when enabled).`})}),s.rawCheck(({dataset:e,addIssue:i})=>{e.typed&&t.commit_body.required&&!e.value.body.trim()&&i({message:"Missing --body. commit_body.required is enabled in config."})}),s.rawCheck(({dataset:e,addIssue:i})=>{e.typed&&e.value.closes&&!e.value.ticket&&i({message:'Invalid footer values: --closes requires --ticket (for example: --ticket "ABC-123").'})}),s.rawCheck(({dataset:e,addIssue:i})=>{e.typed&&e.value.breaking_body&&!e.value.breaking_title&&i({message:"Invalid breaking change values: --breaking-body requires --breaking-title."})}),s.rawCheck(({dataset:e,addIssue:i})=>{e.typed&&e.value.deprecates_body&&!e.value.deprecates_title&&i({message:"Invalid deprecation values: --deprecates-body requires --deprecates-title."})}))}function N(t){let n=t.commit_type.options.map(e=>e.value),r=t.commit_scope.options.map(e=>e.value);return s.pipe(s.object(l),s.rawCheck(({dataset:e,addIssue:i})=>{if(!e.typed)return;let o=e.value.type?`"${e.value.type}"`:"(empty)";e.value.type&&!n.includes(e.value.type)&&i({message:`Invalid --type ${o}. Valid types: ${a(n)}.`})}),s.rawCheck(({dataset:e,addIssue:i})=>{if(!e.typed)return;let o=e.value.scope?`"${e.value.scope}"`:"(empty)";e.value.scope&&!t.commit_scope.custom_scope&&!r.includes(e.value.scope)&&i({message:`Invalid --scope ${o}. Valid scopes: ${a(r)}.`})}),s.rawCheck(({dataset:e,addIssue:i})=>{!e.typed||e.value.description.trim()||i({message:"Missing --description. Provide a non-empty branch description."})}),s.rawCheck(({dataset:e,addIssue:i})=>{if(!e.typed)return;let o=e.value.description.trim();o.length>t.branch_description.max_length&&i({message:`Description exceeds max length. Current length is ${o.length}, max is ${t.branch_description.max_length}.`})}),s.rawCheck(({dataset:e,addIssue:i})=>{e.typed&&t.branch_user.required&&!e.value.user.trim()&&i({message:"Missing --user. branch_user.required is enabled in config."})}),s.rawCheck(({dataset:e,addIssue:i})=>{e.typed&&t.branch_ticket.required&&!e.value.ticket.trim()&&i({message:"Missing --ticket. branch_ticket.required is enabled in config."})}),s.rawCheck(({dataset:e,addIssue:i})=>{e.typed&&t.branch_version.required&&!e.value.version.trim()&&i({message:"Missing --branch-version. branch_version.required is enabled in config."})}))}import{execSync as h}from"child_process";var v=/\/(\w+-\d+)/,y=/^(\w+-\d+)/,k=/^([A-Z]+-[\[a-zA-Z\]\d]+)_/,b=/\/([A-Z]+-[\[a-zA-Z\]\d]+)_/,$=/\/(\d+)/,C=/^(\d+)/;function V(t){if(p.interactive)return;let n={ticket:"",type:"",scope:""};if(t.check_ticket.infer_ticket){let e=w({append_hashtag:t.check_ticket.append_hashtag,prepend_hashtag:t.check_ticket.prepend_hashtag},p.git_args);n.ticket=e}let r=x(t.commit_type.options,p.git_args);if(n.type=r,t.commit_scope.enable&&t.commit_scope.infer_scope_from_branch){let e=E(t.commit_scope.options,p.git_args);n.scope=e}return n}function x(t,n){let r=m(n);return r?T(r,t.map(e=>e.value)):""}function w(t,n){let r=m(n);return r?S(r,t):""}function E(t,n){let r=m(n);return r?z(r,t):""}function S(t,n){let r=[t.match(k),t.match(b),t.match(v),t.match($),t.match(y),t.match(C)].filter(e=>e!=null).map(e=>e&&e.length>=2?e[1]:"");return!r.length||!r[0]?"":n.append_hashtag||n.prepend_hashtag==="Always"?`#${r[0]}`:r[0]}function T(t,n){return n.find(e=>{let i=new RegExp(`^${e}-`),o=new RegExp(`-${e}-`),d=new RegExp(`${e}/`);return[t.match(i),t.match(o),t.match(d)].filter(f=>f!=null).length>0})??""}function A(t){return t.replace(/[.*+?^${}()|[\]\\]/g,"\\$&")}function z(t,n){return n.map(i=>i.value).filter(i=>i&&i!==_).sort((i,o)=>o.length-i.length).find(i=>new RegExp(`(?:^|[/_-])${A(i)}(?=$|[/_-])`).test(t))??""}function m(t){try{return h(`git ${t} branch --show-current`,{stdio:"pipe"}).toString().trim()}catch{return""}}import c from"picocolors";function D(t){return`${t} ${c.dim("\xB7 restored from cache")}`}function L(t){return`${t} ${c.dim("\xB7 inferred from branch")}`}function B(t){return`${t} ${c.dim("\xB7 optional")}`}function K(t){return`${t} ${c.dim("\xB7 <space> to select")}`}function Y(t){return`${t} ${c.dim("\xB7 <space> to select \xB7 <a> to select all")}`}function F(t){return`${t} ${c.dim("\xB7 dry run - changes will not be committed")}`}export{g as a,G as b,N as c,V as d,x as e,w as f,E as g,D as h,L as i,B as j,K as k,Y as l,F as m};

package/dist/chunk-B7AGSPP3.js

@@ -1,261 +0,0 @@
-import*as e from"valibot";import*as s from"valibot";var c="custom",d=["closes","trailer","breaking-change","deprecated","custom"],m=s.picklist(["branch","worktree"]),_=s.picklist(["closes","trailer","breaking-change","deprecated","custom"]),C=s.picklist(["user","version","type","scope","ticket","description"]),K=s.picklist(["branch_user","branch_version","branch_type","branch_scope","branch_ticket","branch_description"]),y=["user","version","type","ticket","scope","description"],k=[{value:"app",label:"app"},{value:"shared",label:"shared"},{value:"server",label:"server"},{value:"tools",label:"tools"},{value:"",label:"none"}],O=[{value:"feat",label:"feat",hint:"A new feature",emoji:"\u{1F31F}",trailer:"Changelog: feature"},{value:"fix",label:"fix",hint:"A bug fix",emoji:"\u{1F41B}",trailer:"Changelog: fix"},{value:"docs",label:"docs",hint:"Documentation only changes",emoji:"\u{1F4DA}",trailer:"Changelog: documentation"},{value:"refactor",label:"refactor",hint:"A code change that neither fixes a bug nor adds a feature",emoji:"\u{1F528}",trailer:"Changelog: refactor"},{value:"perf",label:"perf",hint:"A code change that improves performance",emoji:"\u{1F680}",trailer:"Changelog: performance"},{value:"test",label:"test",hint:"Adding missing tests or correcting existing tests",emoji:"\u{1F6A8}",trailer:"Changelog: test"},{value:"build",label:"build",hint:"Changes that affect the build system or external dependencies",emoji:"\u{1F6A7}",trailer:"Changelog: build"},{value:"ci",label:"ci",hint:"Changes to our CI configuration files and scripts",emoji:"\u{1F916}",trailer:"Changelog: ci"},{value:"chore",label:"chore",hint:"Other changes that do not modify src or test files",emoji:"\u{1F9F9}",trailer:"Changelog: chore"},{value:"",label:"none"}];var N=e.pipe(e.optional(e.object({enable:e.optional(e.boolean(),!0),initial_value:e.optional(e.string(),"feat"),max_items:e.optional(e.pipe(e.number(),e.minValue(1)),20),infer_type_from_branch:e.optional(e.boolean(),!0),append_emoji_to_label:e.optional(e.boolean(),!1),append_emoji_to_commit:e.optional(e.boolean(),!1),emoji_commit_position:e.optional(e.picklist(["Start","After-Colon"]),"Start"),autocomplete:e.optional(e.boolean(),!0),options:e.optional(e.array(e.object({value:e.string(),label:e.optional(e.string()),hint:e.optional(e.string()),emoji:e.optional(e.pipe(e.string(),e.emoji())),trailer:e.optional(e.string())})),O)}),{}),e.rawCheck(({dataset:o,addIssue:t})=>{o.typed&&!o.value.options.some(r=>r.value===o.value.initial_value)&&t({message:`Type: initial_value "${o.value.initial_value}" must exist in options`})}),e.transform(o=>({...o,options:o.options.map(t=>({...t,label:t.emoji&&o.append_emoji_to_label?`${t.emoji} ${t.label}`:t.label}))}))),R=e.pipe(e.optional(e.object({enable:e.optional(e.boolean(),!0),custom_scope:e.optional(e.boolean(),!1),max_items:e.optional(e.pipe(e.number(),e.minValue(1)),20),initial_value:e.optional(e.string(),"app"),infer_scope_from_branch:e.optional(e.boolean(),!0),autocomplete:e.optional(e.boolean(),!0),options:e.optional(e.array(e.object({value:e.string(),label:e.optional(e.string()),hint:e.optional(e.string())})),k)}),{}),e.rawCheck(({dataset:o,addIssue:t})=>{if(!o.typed)return;let r=o.value.options.map(n=>n.value);o.value.custom_scope&&r.push(c),r.includes(o.value.initial_value)||t({message:`Scope: initial_value "${o.value.initial_value}" must exist in options`})}),e.transform(o=>{let t=o.options.map(r=>r.value);return o.custom_scope&&!t.includes(c)?{...o,options:[...o.options,{label:c,value:c,hint:"Write a custom scope"}]}:o})),f=e.object({check_status:e.optional(e.boolean(),!0),check_status_autocomplete:e.optional(e.boolean(),!0),commit_type:N,commit_scope:R,check_ticket:e.optional(e.object({infer_ticket:e.optional(e.boolean(),!0),confirm_ticket:e.optional(e.boolean(),!0),add_to_title:e.optional(e.boolean(),!0),append_hashtag:e.optional(e.boolean(),!1),prepend_hashtag:e.optional(e.picklist(["Never","Always","Prompt"]),"Never"),surround:e.optional(e.picklist(["","()","[]","{}"]),""),title_position:e.optional(e.picklist(["start","end","before-colon","beginning"]),"start")}),{}),commit_title:e.optional(e.object({max_size:e.optional(e.pipe(e.number(),e.minValue(1)),70)}),{}),commit_body:e.optional(e.object({enable:e.optional(e.boolean(),!0),required:e.optional(e.boolean(),!1),split_by_period:e.optional(e.boolean(),!1)}),{}),commit_footer:e.optional(e.object({enable:e.optional(e.boolean(),!0),initial_value:e.optional(e.array(_),[]),options:e.optional(e.array(_),d)}),{}),breaking_change:e.optional(e.object({add_exclamation_to_title:e.optional(e.boolean(),!0)}),{}),cache_last_value:e.optional(e.boolean(),!0),confirm_with_editor:e.optional(e.boolean(),!1),confirm_commit:e.optional(e.boolean(),!0),print_commit_output:e.optional(e.boolean(),!0),branch_pre_commands:e.optional(e.array(e.string()),[]),branch_post_commands:e.optional(e.array(e.string()),[]),worktree_pre_commands:e.optional(e.array(e.string()),[]),worktree_post_commands:e.optional(e.array(e.string()),[]),branch_user:e.optional(e.object({enable:e.optional(e.boolean(),!0),required:e.optional(e.boolean(),!1),separator:e.optional(e.picklist(["/","-","_"]),"/")}),{}),branch_type:e.optional(e.object({enable:e.optional(e.boolean(),!0),separator:e.optional(e.picklist(["/","-","_"]),"/"),autocomplete:e.optional(e.boolean(),!0)}),{}),branch_scope:e.optional(e.object({enable:e.optional(e.boolean(),!0),separator:e.optional(e.picklist(["/","-","_"]),"-"),autocomplete:e.optional(e.boolean(),!0)}),{}),branch_version:e.optional(e.object({enable:e.optional(e.boolean(),!1),required:e.optional(e.boolean(),!1),separator:e.optional(e.picklist(["/","-","_"]),"/")}),{}),branch_ticket:e.optional(e.object({enable:e.optional(e.boolean(),!0),required:e.optional(e.boolean(),!1),separator:e.optional(e.picklist(["/","-","_"]),"-")}),{}),branch_description:e.optional(e.object({max_length:e.optional(e.pipe(e.number(),e.minValue(1)),70),separator:e.optional(e.picklist(["","/","-","_"]),"")}),{}),branch_action_default:e.optional(m,"branch"),branch_order:e.optional(e.array(C),y),enable_worktrees:e.optional(e.boolean(),!0),worktrees:e.optional(e.object({enable:e.optional(e.boolean(),!0),base_path:e.optional(e.string(),".."),folder_template:e.optional(e.string(),"{{repo_name}}-{{ticket}}-{{branch_description}}")}),{}),overrides:e.optional(e.object({shell:e.optional(e.string())}),{})}),P={type:e.optional(e.string(),""),scope:e.optional(e.string(),""),title:e.optional(e.string(),""),body:e.optional(e.string(),""),closes:e.optional(e.string(),""),ticket:e.optional(e.string(),""),breaking_title:e.optional(e.string(),""),breaking_body:e.optional(e.string(),""),deprecates:e.optional(e.string(),""),deprecates_title:e.optional(e.string(),""),deprecates_body:e.optional(e.string(),""),custom_footer:e.optional(e.string(),""),trailer:e.optional(e.string(),"")},X=e.optional(e.object(P),{}),F={user:e.optional(e.string(),""),type:e.optional(e.string(),""),scope:e.optional(e.string(),""),ticket:e.optional(e.string(),""),description:e.optional(e.string(),""),version:e.optional(e.string(),""),checkout:e.optional(m,"branch")},Z=e.optional(e.object(F),{});import{parse as L}from"@bomb.sh/args";var S=["type","scope","title","body","ticket","closes","trailer","breaking-title","breaking-body","deprecates-title","deprecates-body","custom-footer"],D=["git-dir","work-tree"],$=["interactive","dry-run","help","version"],g=class{#e;constructor(t){this.#e=t}get git_args(){return this.#e.git_args}get interactive(){return!this.#e.no_interactive}get dry_run(){return this.#e.dry_run}get help(){return this.#e.help}get version(){return this.#e.version}get commit_state(){return this.#e.commit_state}},b=new g(M(process.argv.slice(2)));function M(o){let t=L(o,{alias:{h:"help",v:"version"},boolean:$,string:[...S,...D]}),r={};return S.forEach(n=>{let a=t[n],l=V(n,a);if(l!==void 0){let u=n.replace("-","_");r[u]=l}}),{help:t.help===!0,version:t.version===!0,git_args:B(t["git-dir"],t["work-tree"]),no_interactive:t.interactive===!1,dry_run:t["dry-run"]===!0,commit_state:r}}function V(o,t){if(t===void 0)return;if(o!=="closes")return t;let r=t.trim().toLowerCase();if(r!=="false"&&(t===""||r))return"Closes:"}function B(o,t){return`${o?`--git-dir=${o}`:""} ${t?`--work-tree=${t}`:""}`.trim()}var x=`{
-  // 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": "\u{1F31F}",
-        "trailer": "Changelog: feature"
-      },
-      {
-        "value": "fix",
-        "label": "fix",
-        "hint": "A bug fix",
-        "emoji": "\u{1F41B}",
-        "trailer": "Changelog: fix"
-      },
-      {
-        "value": "docs",
-        "label": "docs",
-        "hint": "Documentation only changes",
-        "emoji": "\u{1F4DA}",
-        "trailer": "Changelog: documentation"
-      },
-      {
-        "value": "refactor",
-        "label": "refactor",
-        "hint": "A code change that neither fixes a bug nor adds a feature",
-        "emoji": "\u{1F528}",
-        "trailer": "Changelog: refactor"
-      },
-      {
-        "value": "perf",
-        "label": "perf",
-        "hint": "A code change that improves performance",
-        "emoji": "\u{1F680}",
-        "trailer": "Changelog: performance"
-      },
-      {
-        "value": "test",
-        "label": "test",
-        "hint": "Adding missing tests or correcting existing tests",
-        "emoji": "\u{1F6A8}",
-        "trailer": "Changelog: test"
-      },
-      {
-        "value": "build",
-        "label": "build",
-        "hint": "Changes that affect the build system or external dependencies",
-        "emoji": "\u{1F6A7}",
-        "trailer": "Changelog: build"
-      },
-      {
-        "value": "ci",
-        "label": "ci",
-        "hint": "Changes to our CI configuration files and scripts",
-        "emoji": "\u{1F916}",
-        "trailer": "Changelog: ci"
-      },
-      {
-        "value": "chore",
-        "label": "chore",
-        "hint": "Other changes that do not modify src or test files",
-        "emoji": "\u{1F9F9}",
-        "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"
-  }
-}
-`;import*as i from"@clack/prompts";import{execSync as H}from"child_process";import p from"fs";import{homedir as I}from"os";import{parse as U}from"jsonc-parser";import h from"picocolors";import{ValiError as G,parse as A}from"valibot";var E=[".better-commits.jsonc",".better-commits.json"],j=E[0],_e=[{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"}],fe=[{value:"branch",label:"Branch"},{value:"worktree",label:"Worktree"}],ge={get:()=>"",set:(o,t)=>{},clear:()=>{}};function be(o=" better-commits ",t=b.git_args){console.clear(),i.intro(`${h.bgCyan(h.black(o))}`);let r=null,n=W();p.existsSync(n)&&(r=T(n));let a=z(t),l=Y(a);if(l){i.log.step("Reading from Repository Config");let v=T(l);return{config:r?{...v,overrides:r.overrides.shell?r.overrides:v.overrides,confirm_with_editor:r.confirm_with_editor,cache_last_value:r.cache_last_value}:v,config_source:"repository"}}if(r)return i.log.step("Reading from Global Config"),{config:r,config_source:"global"};let u=A(f,{});return i.log.step(`Config not found. Generating default ${j} at $HOME`),p.writeFileSync(n,x),{config:u,config_source:"none"}}function T(o){let t=null;try{t=U(p.readFileSync(o,"utf8"))}catch(r){i.log.error(`Invalid JSON/JSONC config file at ${o}. Exiting.
-`+r),process.exit(0)}return q(t)}function q(o){try{return A(f,o)}catch(t){if(t instanceof G){let n=(t.issues[0].path??[]).map(a=>a.key).filter(a=>typeof a=="string"||typeof a=="number").join(".");i.log.error(`Invalid Configuration: ${h.red(n)}
-`+t.message)}process.exit(0)}}function z(o=b.git_args){let t=".";try{t=H(`git ${o} rev-parse --show-toplevel`).toString().trim()}catch{i.log.warn("Could not find git root. If in a --bare repository, ignore this warning.")}return t}function W(){return w(I())??I()+"/"+j}function Y(o){return w(o)}function w(o){for(let t of E){let r=`${o}/${t}`;if(p.existsSync(r))return r}return null}function he(){try{return JSON.parse(p.readFileSync(new URL("../package.json",import.meta.url),"utf8")).version??"unknown"}catch{return"unknown"}}function de(o,t){return t===o.length-1?"":`
-`}function Ce(o){let t=o.trim();return t.endsWith(".")?t.substring(0,t.length-1).trim():o.trim()}function ye(o,t){try{return o.get(t)??""}catch{i.log.warn(`Could not access ${t} from cache. Check that "~/.config" exists. Set "cache_last_value" to false to disable.`)}return""}function ke(o,t,r){try{o.set(t,r)}catch{i.log.warn(`Could not access ${t} from cache. Check that "~/.config" exists. Set "cache_last_value" to false to disable.`)}}export{c as a,P as b,X as c,F as d,Z as e,b as f,x as g,j as h,_e as i,fe as j,ge as k,be as l,z as m,Y as n,he as o,de as p,Ce as q,ye as r,ke as s};

package/src/args.test.ts

@@ -1,128 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { parse_runtime_flags } from "./args";
-
-describe("parse_runtime_flags", () => {
-  it("uses interactive mode by default", () => {
-    const parsed = parse_runtime_flags([]);
-
-    expect(parsed.no_interactive).toBe(false);
-    expect(parsed.dry_run).toBe(false);
-    expect(parsed.git_args).toBe("");
-    expect(parsed.commit_state).toEqual({});
-  });
-
-  it("parses --no-interactive and --dry-run", () => {
-    const parsed = parse_runtime_flags(["--no-interactive", "--dry-run"]);
-
-    expect(parsed.no_interactive).toBe(true);
-    expect(parsed.dry_run).toBe(true);
-  });
-
-  it("parses --version and -v", () => {
-    const long_flag = parse_runtime_flags(["--version"]);
-    const short_flag = parse_runtime_flags(["-v"]);
-
-    expect(long_flag.version).toBe(true);
-    expect(short_flag.version).toBe(true);
-  });
-
-  it("maps commit flags into commit_state keys", () => {
-    const parsed = parse_runtime_flags([
-      "--type",
-      "feat",
-      "--title",
-      "ship feature",
-      "--breaking-title",
-      "api changed",
-      "--custom-footer",
-      "Reviewed-by: Jane",
-    ]);
-
-    expect(parsed.commit_state).toEqual({
-      type: "feat",
-      title: "ship feature",
-      breaking_title: "api changed",
-      custom_footer: "Reviewed-by: Jane",
-    });
-  });
-
-  it("treats bare --closes as enabling the default closes footer", () => {
-    const parsed = parse_runtime_flags(["--closes"]);
-
-    expect(parsed.commit_state).toEqual({
-      closes: "Closes:",
-    });
-  });
-
-  it("normalizes boolean-style closes values", () => {
-    const enabled = parse_runtime_flags(["--closes=true"]);
-    const disabled = parse_runtime_flags(["--closes=false"]);
-
-    expect(enabled.commit_state).toEqual({
-      closes: "Closes:",
-    });
-    expect(disabled.commit_state).toEqual({});
-  });
-
-  it("treats any truthy closes value as the default closes footer", () => {
-    const parsed = parse_runtime_flags(["--closes", "Resolves:"]);
-
-    expect(parsed.commit_state).toEqual({
-      closes: "Closes:",
-    });
-  });
-
-  it("builds git args from --git-dir and --work-tree", () => {
-    const parsed = parse_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",
-    );
-  });
-
-  it("builds git args when only one git location flag is provided", () => {
-    const with_git_dir = parse_runtime_flags(["--git-dir", "/tmp/repo/.git"]);
-    const with_work_tree = parse_runtime_flags(["--work-tree", "/tmp/repo"]);
-
-    expect(with_git_dir.git_args).toBe("--git-dir=/tmp/repo/.git");
-    expect(with_work_tree.git_args).toBe("--work-tree=/tmp/repo");
-  });
-
-  it("maps dashed commit flags to snake_case commit_state keys", () => {
-    const parsed = parse_runtime_flags([
-      "--breaking-body",
-      "major impact",
-      "--deprecates-title",
-      "legacy endpoint",
-      "--deprecates-body",
-      "use v2 endpoint",
-      "--custom-footer",
-      "Reviewed-by: Alex",
-      "--breaking-title",
-      "v1 removed",
-    ]);
-
-    expect(parsed.commit_state).toEqual({
-      breaking_body: "major impact",
-      deprecates_title: "legacy endpoint",
-      deprecates_body: "use v2 endpoint",
-      custom_footer: "Reviewed-by: Alex",
-      breaking_title: "v1 removed",
-    });
-  });
-
-  it("honors interactive flag semantics", () => {
-    const default_flags = parse_runtime_flags([]);
-    const explicit_interactive = parse_runtime_flags(["--interactive"]);
-    const no_interactive = parse_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);
-  });
-});