better-commits 1.11.0 → 1.12.0

package/dist/branch.js

@@ -280,6 +280,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

@@ -344,6 +344,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([]),
@@ -646,6 +647,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

@@ -232,6 +232,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

@@ -158,6 +158,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

@@ -230,6 +230,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.12.0",
   "description": "A CLI for creating better commits following the conventional commits specification",
   "author": "Erik Verduin (https://github.com/everduin94)",
   "keywords": [

package/readme.md

@@ -217,6 +217,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": [],
@@ -307,6 +308,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 +407,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

@@ -207,7 +207,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

@@ -124,6 +124,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([]),