better-commits 1.12.0 → 1.14.0

package/.better-commits.json

@@ -34,7 +34,7 @@
     ]
   },
   "check_ticket": {
-    "append_hashtag": true
+    "prepend_hashtag": "Always"
   },
   "branch_pre_commands": [
     "git stash",

package/dist/branch.js

@@ -140,17 +140,25 @@ var BRANCH_ACTION_OPTIONS = [
 function load_setup(cli_name = " better-commits ") {
   console.clear();
   p.intro(`${import_picocolors.default.bgCyan(import_picocolors.default.black(cli_name))}`);
+  let global_config = null;
+  const home_path = get_default_config_path();
+  if (import_fs.default.existsSync(home_path)) {
+    p.log.step("Found global config");
+    global_config = read_config_from_path(home_path);
+  }
   const root = get_git_root();
   const root_path = `${root}/${CONFIG_FILE_NAME}`;
   if (import_fs.default.existsSync(root_path)) {
     p.log.step("Found repository config");
-    return read_config_from_path(root_path);
-  }
-  const home_path = get_default_config_path();
-  if (import_fs.default.existsSync(home_path)) {
-    p.log.step("Found global config");
-    return read_config_from_path(home_path);
+    const repo_config = read_config_from_path(root_path);
+    return global_config ? {
+      ...repo_config,
+      overrides: global_config.overrides.shell ? global_config.overrides : repo_config.overrides,
+      confirm_with_editor: global_config.confirm_with_editor
+    } : repo_config;
   }
+  if (global_config)
+    return global_config;
   const default_config = Config.parse({});
   p.log.step(
     "Config not found. Generating default .better-commit.json at $HOME"
@@ -262,6 +270,7 @@ var Config = import_zod2.z.object({
     confirm_ticket: import_zod2.z.boolean().default(true),
     add_to_title: import_zod2.z.boolean().default(true),
     append_hashtag: import_zod2.z.boolean().default(false),
+    prepend_hashtag: import_zod2.z.enum(["Never", "Always", "Prompt"]).default("Never"),
     surround: import_zod2.z.enum(["", "()", "[]", "{}"]).default(""),
     title_position: import_zod2.z.enum(["start", "end", "before-colon"]).default("start")
   }).default({}),

package/dist/index.js

@@ -171,17 +171,25 @@ var FOOTER_OPTION_VALUES = [
 function load_setup(cli_name = " better-commits ") {
   console.clear();
   p.intro(`${import_picocolors.default.bgCyan(import_picocolors.default.black(cli_name))}`);
-  const root = get_git_root();
-  const root_path = `${root}/${CONFIG_FILE_NAME}`;
-  if (import_fs.default.existsSync(root_path)) {
-    p.log.step("Found repository config");
-    return read_config_from_path(root_path);
-  }
+  let global_config = null;
   const home_path = get_default_config_path();
   if (import_fs.default.existsSync(home_path)) {
     p.log.step("Found global config");
-    return read_config_from_path(home_path);
+    global_config = read_config_from_path(home_path);
   }
+  const root = get_git_root();
+  const root_path = `${root}/${CONFIG_FILE_NAME}`;
+  if (import_fs.default.existsSync(root_path)) {
+    p.log.step("Found repository config");
+    const repo_config = read_config_from_path(root_path);
+    return global_config ? {
+      ...repo_config,
+      overrides: global_config.overrides.shell ? global_config.overrides : repo_config.overrides,
+      confirm_with_editor: global_config.confirm_with_editor
+    } : repo_config;
+  }
+  if (global_config)
+    return global_config;
   const default_config = Config.parse({});
   p.log.step(
     "Config not found. Generating default .better-commit.json at $HOME"
@@ -326,6 +334,7 @@ var Config = import_zod2.z.object({
     confirm_ticket: import_zod2.z.boolean().default(true),
     add_to_title: import_zod2.z.boolean().default(true),
     append_hashtag: import_zod2.z.boolean().default(false),
+    prepend_hashtag: import_zod2.z.enum(["Never", "Always", "Prompt"]).default("Never"),
     surround: import_zod2.z.enum(["", "()", "[]", "{}"]).default(""),
     title_position: import_zod2.z.enum(["start", "end", "before-colon"]).default("start")
   }).default({}),
@@ -536,7 +545,7 @@ async function main(config) {
         branch.match(REGEX_START_NUM)
       ].filter((v) => v != null).map((v) => v && v.length >= 2 ? v[1] : "");
       if (found.length && found[0]) {
-        commit_state.ticket = config.check_ticket.append_hashtag ? "#" + found[0] : found[0];
+        commit_state.ticket = config.check_ticket.append_hashtag || config.check_ticket.prepend_hashtag === "Prompt" ? "#" + found[0] : found[0];
       }
     } catch (err) {
     }
@@ -551,6 +560,9 @@ async function main(config) {
       process.exit(0);
     commit_state.ticket = user_commit_ticket ?? "";
   }
+  if (config.check_ticket.prepend_hashtag === "Always" && commit_state.ticket && !commit_state.ticket.startsWith("#")) {
+    commit_state.ticket = "#" + commit_state.ticket;
+  }
   const commit_title = await p3.text(
     {
       message: "Write a brief title describing the commit",

package/dist/init.js

@@ -214,6 +214,7 @@ var Config = import_zod2.z.object({
     confirm_ticket: import_zod2.z.boolean().default(true),
     add_to_title: import_zod2.z.boolean().default(true),
     append_hashtag: import_zod2.z.boolean().default(false),
+    prepend_hashtag: import_zod2.z.enum(["Never", "Always", "Prompt"]).default("Never"),
     surround: import_zod2.z.enum(["", "()", "[]", "{}"]).default(""),
     title_position: import_zod2.z.enum(["start", "end", "before-colon"]).default("start")
   }).default({}),

package/dist/utils.js

@@ -140,6 +140,7 @@ var Config = import_zod.z.object({
     confirm_ticket: import_zod.z.boolean().default(true),
     add_to_title: import_zod.z.boolean().default(true),
     append_hashtag: import_zod.z.boolean().default(false),
+    prepend_hashtag: import_zod.z.enum(["Never", "Always", "Prompt"]).default("Never"),
     surround: import_zod.z.enum(["", "()", "[]", "{}"]).default(""),
     title_position: import_zod.z.enum(["start", "end", "before-colon"]).default("start")
   }).default({}),
@@ -342,17 +343,25 @@ var BRANCH_ACTION_OPTIONS = [
 function load_setup(cli_name = " better-commits ") {
   console.clear();
   p.intro(`${import_picocolors.default.bgCyan(import_picocolors.default.black(cli_name))}`);
+  let global_config = null;
+  const home_path = get_default_config_path();
+  if (import_fs.default.existsSync(home_path)) {
+    p.log.step("Found global config");
+    global_config = read_config_from_path(home_path);
+  }
   const root = get_git_root();
   const root_path = `${root}/${CONFIG_FILE_NAME}`;
   if (import_fs.default.existsSync(root_path)) {
     p.log.step("Found repository config");
-    return read_config_from_path(root_path);
-  }
-  const home_path = get_default_config_path();
-  if (import_fs.default.existsSync(home_path)) {
-    p.log.step("Found global config");
-    return read_config_from_path(home_path);
+    const repo_config = read_config_from_path(root_path);
+    return global_config ? {
+      ...repo_config,
+      overrides: global_config.overrides.shell ? global_config.overrides : repo_config.overrides,
+      confirm_with_editor: global_config.confirm_with_editor
+    } : repo_config;
   }
+  if (global_config)
+    return global_config;
   const default_config = Config.parse({});
   p.log.step(
     "Config not found. Generating default .better-commit.json at $HOME"

package/dist/zod-state.js

@@ -212,6 +212,7 @@ var Config = import_zod2.z.object({
     confirm_ticket: import_zod2.z.boolean().default(true),
     add_to_title: import_zod2.z.boolean().default(true),
     append_hashtag: import_zod2.z.boolean().default(false),
+    prepend_hashtag: import_zod2.z.enum(["Never", "Always", "Prompt"]).default("Never"),
     surround: import_zod2.z.enum(["", "()", "[]", "{}"]).default(""),
     title_position: import_zod2.z.enum(["start", "end", "before-colon"]).default("start")
   }).default({}),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "better-commits",
   "private": false,
-  "version": "1.12.0",
+  "version": "1.14.0",
   "description": "A CLI for creating better commits following the conventional commits specification",
   "author": "Erik Verduin (https://github.com/everduin94)",
   "keywords": [

package/readme.md

@@ -65,8 +65,9 @@ Your first time running `better-commits`, a default config will be generated in
 ### Repository
 
 To create a **repository-specific config**, navigate to the root of your project.
-- run `better-commits-init`
+- Run `better-commits-init`
 - This will create a default config named `.better-commits.json`
+- Properties such as `confirm_with_editor` and `overrides` will prefer the global config
 
 ### Options
 
@@ -192,6 +193,7 @@ Better-commits (& better-branch) are highly flexible with sane defaults. These o
         "confirm_ticket": true,
         "add_to_title": true,
         "append_hashtag": false,
+        "prepend_hashtag": "Never",
         "surround": "",
         "title_position": "start"
     },
@@ -263,8 +265,14 @@ Better-commits (& better-branch) are highly flexible with sane defaults. These o
 
 </details>
 
+> [!NOTE]<br>
+> Some properties use sets of string values
+> See *confile file explanations* for possible values
+
 ### 🔭 Config File Explanations
 
+Expand to see explanations and possible values
+
 <details>
 <summary>Expand / Collapse</summary>
 
@@ -297,7 +305,8 @@ Better-commits (& better-branch) are highly flexible with sane defaults. These o
 | `check_ticket.infer_ticket`                | If true infer ticket from branch name                       |
 | `check_ticket.confirm_ticket`              | If true manually confirm inference                          |
 | `check_ticket.add_to_title`                | If true add ticket to title                                 |
-| `check_ticket.append_hashtag`              | If true add hashtag to ticket (Ideal for Github Issues)     |
+| `check_ticket.append_hashtag`              | **Deprecated**: see prepend_hashtag                         |
+| `check_ticket.prepend_hashtag`             | "Never" (default), "Prompt", or "Always"                    |
 | `check_ticket.title_position`              | "start" (of description) (default), "end", "before-colon"   |
 | `check_ticket.surround`                    | "" (default), "[]", "()", "{}" - Wraps ticket in title      |
 | `commit_title.max_size`                    | Max size of title including scope, type, etc...             |

package/src/index.ts

@@ -98,7 +98,9 @@ export async function main(config: z.infer<typeof Config>) {
       .filter(v => v != null)
       .map(v => v && v.length >= 2 ?  v[1] : '')
       if (found.length && found[0]) {
-        commit_state.ticket = config.check_ticket.append_hashtag ? '#' + found[0] : found[0]
+        commit_state.ticket = config.check_ticket.append_hashtag 
+          || config.check_ticket.prepend_hashtag === 'Prompt'
+          ? '#' + found[0] : found[0]
       }
     } catch(err: any) {
       // Can't find branch, fail silently
@@ -115,6 +117,12 @@ export async function main(config: z.infer<typeof Config>) {
     commit_state.ticket = user_commit_ticket ?? '';
   }
 
+  if (config.check_ticket.prepend_hashtag === 'Always' 
+    && commit_state.ticket 
+    && !commit_state.ticket.startsWith('#')) {
+    commit_state.ticket = '#' + commit_state.ticket;
+  }
+
   const commit_title = await p.text(
       {
 					message: 'Write a brief title describing the commit',

package/src/utils.ts

@@ -148,18 +148,26 @@ export function load_setup(
   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)) {
+    p.log.step("Found global config");
+    global_config = read_config_from_path(home_path);
+  }
+
   const root = get_git_root();
   const root_path = `${root}/${CONFIG_FILE_NAME}`;
   if (fs.existsSync(root_path)) {
     p.log.step("Found repository config");
-    return read_config_from_path(root_path);
+    const repo_config = read_config_from_path(root_path);
+    return global_config ? {
+      ...repo_config,
+      overrides: global_config.overrides.shell ? global_config.overrides : repo_config.overrides,
+      confirm_with_editor: global_config.confirm_with_editor
+    } : repo_config
   }
 
-  const home_path = get_default_config_path();
-  if (fs.existsSync(home_path)) {
-    p.log.step("Found global config");
-    return read_config_from_path(home_path);
-  }
+  if (global_config) return global_config
 
   const default_config = Config.parse({});
   p.log.step(

package/src/zod-state.ts

@@ -97,6 +97,7 @@ export const Config = z
         confirm_ticket: z.boolean().default(true),
         add_to_title: z.boolean().default(true),
         append_hashtag: z.boolean().default(false),
+        prepend_hashtag: z.enum(['Never', 'Always', 'Prompt']).default("Never"),
         surround: z.enum(["", "()", "[]", "{}"]).default(""),
         title_position: z.enum(["start", "end", "before-colon"]).default("start"),
       })