better-commits 1.11.0 → 1.13.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

@@ -262,6 +262,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({}),
@@ -280,6 +281,7 @@ var Config = import_zod2.z.object({
   breaking_change: import_zod2.z.object({
     add_exclamation_to_title: import_zod2.z.boolean().default(true)
   }).default({}),
+  confirm_with_editor: import_zod2.z.boolean().default(false),
   confirm_commit: import_zod2.z.boolean().default(true),
   print_commit_output: import_zod2.z.boolean().default(true),
   branch_pre_commands: import_zod2.z.array(import_zod2.z.string()).default([]),

package/dist/index.js

@@ -326,6 +326,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({}),
@@ -344,6 +345,7 @@ var Config = import_zod2.z.object({
   breaking_change: import_zod2.z.object({
     add_exclamation_to_title: import_zod2.z.boolean().default(true)
   }).default({}),
+  confirm_with_editor: import_zod2.z.boolean().default(false),
   confirm_commit: import_zod2.z.boolean().default(true),
   print_commit_output: import_zod2.z.boolean().default(true),
   branch_pre_commands: import_zod2.z.array(import_zod2.z.string()).default([]),
@@ -535,7 +537,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) {
     }
@@ -550,6 +552,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",
@@ -646,6 +651,12 @@ async function main(config) {
       commit_state.trailer = "";
     }
   }
+  if (config.confirm_with_editor) {
+    const options = config.overrides.shell ? { shell: config.overrides.shell, stdio: "inherit" } : { stdio: "inherit" };
+    const trailer = commit_state.trailer ? `--trailer="${commit_state.trailer}"` : "";
+    (0, import_child_process3.execSync)(`git commit -m "${build_commit_string(commit_state, config, false, true, false)}" ${trailer} --edit`, options);
+    process.exit(0);
+  }
   let continue_commit = true;
   p3.note(build_commit_string(commit_state, config, true, false, true), "Commit Preview");
   if (config.confirm_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({}),
@@ -232,6 +233,7 @@ var Config = import_zod2.z.object({
   breaking_change: import_zod2.z.object({
     add_exclamation_to_title: import_zod2.z.boolean().default(true)
   }).default({}),
+  confirm_with_editor: import_zod2.z.boolean().default(false),
   confirm_commit: import_zod2.z.boolean().default(true),
   print_commit_output: import_zod2.z.boolean().default(true),
   branch_pre_commands: import_zod2.z.array(import_zod2.z.string()).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({}),
@@ -158,6 +159,7 @@ var Config = import_zod.z.object({
   breaking_change: import_zod.z.object({
     add_exclamation_to_title: import_zod.z.boolean().default(true)
   }).default({}),
+  confirm_with_editor: import_zod.z.boolean().default(false),
   confirm_commit: import_zod.z.boolean().default(true),
   print_commit_output: import_zod.z.boolean().default(true),
   branch_pre_commands: import_zod.z.array(import_zod.z.string()).default([]),

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({}),
@@ -230,6 +231,7 @@ var Config = import_zod2.z.object({
   breaking_change: import_zod2.z.object({
     add_exclamation_to_title: import_zod2.z.boolean().default(true)
   }).default({}),
+  confirm_with_editor: import_zod2.z.boolean().default(false),
   confirm_commit: import_zod2.z.boolean().default(true),
   print_commit_output: import_zod2.z.boolean().default(true),
   branch_pre_commands: import_zod2.z.array(import_zod2.z.string()).default([]),

package/package.json

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

package/readme.md

@@ -192,6 +192,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"
     },
@@ -217,6 +218,7 @@ Better-commits (& better-branch) are highly flexible with sane defaults. These o
         "add_exclamation_to_title": true
     },
     "confirm_commit": true,
+    "confirm_with_editor": false,
     "print_commit_output": true,
     "branch_pre_commands": [],
     "branch_post_commands": [],
@@ -262,8 +264,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>
 
@@ -296,7 +304,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...             |
@@ -307,6 +316,7 @@ Better-commits (& better-branch) are highly flexible with sane defaults. These o
 | `commit_footer.options`                    | Footer options                                              |
 | `breaking_change.add_exclamation_to_title` | If true adds exclamation mark to title for breaking changes |
 | `confirm_commit`                           | If true manually confirm commit at end                      |
+| `confirm_with_editor`                      | Confirm / Edit commit with $GIT_EDITOR / $EDITOR            |
 | `print_commit_output`                      | If true pretty print commit preview                         |
 | `overrides.shell`                          | Override default shell, useful for windows users            |
 
@@ -405,6 +415,10 @@ If you're using Github issues to track your work, and select the `closes` footer
 
 `better-commits` uses native `git` commands under the hood. So any hooks, tools, or staging should work as if it was a normal commit.
 
+Setting `confirm_with_editor=true` will allow you to edit/confirm a commit with your editor.
+- For example, to edit with Neovim: `git config --global core.editor "nvim"`
+- For VS Code, `git config --global core.editor "code -n --wait"`
+
 You can add this badge to your repository to display that you're using a better-commits repository config 
 
 | Markdown | Result |

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',
@@ -207,7 +215,13 @@ export async function main(config: z.infer<typeof Config>) {
       commit_state.trailer = '';
     }
   }
-  
+
+  if (config.confirm_with_editor) {
+    const options = config.overrides.shell ? { shell: config.overrides.shell, stdio: 'inherit' } :  { stdio: 'inherit' }
+    const trailer = commit_state.trailer ? `--trailer="${commit_state.trailer}"` : '';
+    execSync(`git commit -m "${build_commit_string(commit_state, config, false, true, false)}" ${trailer} --edit`, options);
+    process.exit(0);
+  }
 
   let continue_commit = true;
   p.note(build_commit_string(commit_state, config, true, false, true), 'Commit Preview')

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"),
       })
@@ -124,6 +125,7 @@ export const Config = z
         add_exclamation_to_title: z.boolean().default(true),
       })
       .default({}),
+    confirm_with_editor: z.boolean().default(false),
     confirm_commit: z.boolean().default(true),
     print_commit_output: z.boolean().default(true),
     branch_pre_commands: z.array(z.string()).default([]),