better-commits 1.0.5 → 1.0.8-print-output

package/dist/index.js

@@ -47,12 +47,14 @@ var REGEX_START_TAG = new RegExp(/^(\w+-\d+)/);
 var REGEX_SLASH_NUM = new RegExp(/\/(\d+)/);
 var REGEX_START_NUM = new RegExp(/^(\d+)/);
 var DEFAULT_TYPE_OPTIONS = [
-  { value: "feat", label: "feat" },
-  { value: "fix", label: "fix" },
-  { value: "docs", label: "docs" },
-  { value: "refactor", label: "refactor" },
-  { value: "perf", label: "perf" },
-  { value: "test", label: "test" },
+  { value: "feat", label: "feat", hint: "A new feature" },
+  { value: "fix", label: "fix", hint: "A bug fix" },
+  { value: "docs", label: "docs", hint: "Documentation only changes" },
+  { value: "refactor", label: "refactor", hint: "A code change that neither fixes a bug nor adds a feature" },
+  { value: "perf", label: "perf", hint: "A code change that improves performance" },
+  { value: "test", label: "test", hint: "Adding missing tests or correcting existing tests" },
+  { value: "build", label: "build", hint: "Changes that affect the build system or external dependencies" },
+  { value: "ci", label: "ci", hint: "Changes to our CI configuration files and scripts" },
   { value: "", label: "none" }
 ];
 var DEFAULT_SCOPE_OPTIONS = [
@@ -153,7 +155,8 @@ var Config = import_zod2.z.object({
   breaking_change: import_zod2.z.object({
     add_exclamation_to_title: import_zod2.z.boolean().default(true)
   }).default({}),
-  confirm_commit: import_zod2.z.boolean().default(true)
+  confirm_commit: import_zod2.z.boolean().default(true),
+  print_commit_output: import_zod2.z.boolean().default(true)
 }).default({});
 var CommitState = import_zod2.z.object({
   type: import_zod2.z.string().default(""),
@@ -279,7 +282,8 @@ async function main(config) {
   }
   if (config.check_ticket.confirm_ticket) {
     const user_commit_ticket = await p.text({
-      message: commit_state.ticket ? `Ticket / issue infered from branch ${import_picocolors2.default.dim("(confirm / edit)")}` : `Add ticket / issue ${OPTIONAL_PROMPT}`,
+      message: commit_state.ticket ? `Ticket / issue inferred from branch ${import_picocolors2.default.dim("(confirm / edit)")}` : `Add ticket / issue ${OPTIONAL_PROMPT}`,
+      placeholder: "",
       initialValue: commit_state.ticket
     });
     if (p.isCancel(user_commit_ticket))
@@ -315,7 +319,7 @@ async function main(config) {
     });
     if (p.isCancel(commit_body))
       process.exit(0);
-    commit_state.body = commit_body;
+    commit_state.body = commit_body ?? "";
   }
   if (config.commit_footer.enable) {
     const commit_footer = await p.multiselect({
@@ -335,10 +339,14 @@ async function main(config) {
             return "Please enter a title / summary";
         }
       });
+      if (p.isCancel(breaking_changes_title))
+        process.exit(0);
       const breaking_changes_body = await p.text({
         message: `Breaking Changes: Write a description & migration instructions ${OPTIONAL_PROMPT}`,
         placeholder: ""
       });
+      if (p.isCancel(breaking_changes_body))
+        process.exit(0);
       commit_state.breaking_title = breaking_changes_title;
       commit_state.breaking_body = breaking_changes_body;
     }
@@ -351,10 +359,14 @@ async function main(config) {
             return "Please enter a title / summary";
         }
       });
+      if (p.isCancel(deprecated_title))
+        process.exit(0);
       const deprecated_body = await p.text({
         message: `Deprecated: Write a description ${OPTIONAL_PROMPT}`,
         placeholder: ""
       });
+      if (p.isCancel(deprecated_body))
+        process.exit(0);
       commit_state.deprecates_body = deprecated_body;
       commit_state.deprecates_title = deprecated_title;
     }
@@ -366,6 +378,8 @@ async function main(config) {
         message: "Write a custom footer",
         placeholder: ""
       });
+      if (p.isCancel(custom_footer))
+        process.exit(0);
       commit_state.custom_footer = custom_footer;
     }
   }
@@ -376,8 +390,17 @@ async function main(config) {
     if (p.isCancel(continue_commit))
       process.exit(0);
   }
-  if (continue_commit)
-    (0, import_simple_git.simpleGit)().commit(build_commit_string(commit_state, config, false));
+  if (!continue_commit) {
+    p.log.info("Exiting without commit");
+    process.exit(0);
+  }
+  try {
+    const output = (0, import_child_process2.execSync)(`git commit -m "${build_commit_string(commit_state, config, false)}"`).toString().trim();
+    if (config.print_commit_output)
+      p.log.info(output);
+  } catch (err) {
+    p.log.error("Something went wrong when committing: " + err);
+  }
 }
 function build_commit_string(commit_state, config, colorize = false) {
   let commit_string = "";

package/dist/init.js

@@ -37,12 +37,14 @@ var REGEX_START_TAG = new RegExp(/^(\w+-\d+)/);
 var REGEX_SLASH_NUM = new RegExp(/\/(\d+)/);
 var REGEX_START_NUM = new RegExp(/^(\d+)/);
 var DEFAULT_TYPE_OPTIONS = [
-  { value: "feat", label: "feat" },
-  { value: "fix", label: "fix" },
-  { value: "docs", label: "docs" },
-  { value: "refactor", label: "refactor" },
-  { value: "perf", label: "perf" },
-  { value: "test", label: "test" },
+  { value: "feat", label: "feat", hint: "A new feature" },
+  { value: "fix", label: "fix", hint: "A bug fix" },
+  { value: "docs", label: "docs", hint: "Documentation only changes" },
+  { value: "refactor", label: "refactor", hint: "A code change that neither fixes a bug nor adds a feature" },
+  { value: "perf", label: "perf", hint: "A code change that improves performance" },
+  { value: "test", label: "test", hint: "Adding missing tests or correcting existing tests" },
+  { value: "build", label: "build", hint: "Changes that affect the build system or external dependencies" },
+  { value: "ci", label: "ci", hint: "Changes to our CI configuration files and scripts" },
   { value: "", label: "none" }
 ];
 var DEFAULT_SCOPE_OPTIONS = [
@@ -104,7 +106,8 @@ var Config = import_zod2.z.object({
   breaking_change: import_zod2.z.object({
     add_exclamation_to_title: import_zod2.z.boolean().default(true)
   }).default({}),
-  confirm_commit: import_zod2.z.boolean().default(true)
+  confirm_commit: import_zod2.z.boolean().default(true),
+  print_commit_output: import_zod2.z.boolean().default(true)
 }).default({});
 var CommitState = import_zod2.z.object({
   type: import_zod2.z.string().default(""),

package/dist/utils.js

@@ -61,12 +61,14 @@ var REGEX_START_TAG = new RegExp(/^(\w+-\d+)/);
 var REGEX_SLASH_NUM = new RegExp(/\/(\d+)/);
 var REGEX_START_NUM = new RegExp(/^(\d+)/);
 var DEFAULT_TYPE_OPTIONS = [
-  { value: "feat", label: "feat" },
-  { value: "fix", label: "fix" },
-  { value: "docs", label: "docs" },
-  { value: "refactor", label: "refactor" },
-  { value: "perf", label: "perf" },
-  { value: "test", label: "test" },
+  { value: "feat", label: "feat", hint: "A new feature" },
+  { value: "fix", label: "fix", hint: "A bug fix" },
+  { value: "docs", label: "docs", hint: "Documentation only changes" },
+  { value: "refactor", label: "refactor", hint: "A code change that neither fixes a bug nor adds a feature" },
+  { value: "perf", label: "perf", hint: "A code change that improves performance" },
+  { value: "test", label: "test", hint: "Adding missing tests or correcting existing tests" },
+  { value: "build", label: "build", hint: "Changes that affect the build system or external dependencies" },
+  { value: "ci", label: "ci", hint: "Changes to our CI configuration files and scripts" },
   { value: "", label: "none" }
 ];
 var DEFAULT_SCOPE_OPTIONS = [

package/dist/zod-state.js

@@ -46,12 +46,14 @@ var REGEX_START_TAG = new RegExp(/^(\w+-\d+)/);
 var REGEX_SLASH_NUM = new RegExp(/\/(\d+)/);
 var REGEX_START_NUM = new RegExp(/^(\d+)/);
 var DEFAULT_TYPE_OPTIONS = [
-  { value: "feat", label: "feat" },
-  { value: "fix", label: "fix" },
-  { value: "docs", label: "docs" },
-  { value: "refactor", label: "refactor" },
-  { value: "perf", label: "perf" },
-  { value: "test", label: "test" },
+  { value: "feat", label: "feat", hint: "A new feature" },
+  { value: "fix", label: "fix", hint: "A bug fix" },
+  { value: "docs", label: "docs", hint: "Documentation only changes" },
+  { value: "refactor", label: "refactor", hint: "A code change that neither fixes a bug nor adds a feature" },
+  { value: "perf", label: "perf", hint: "A code change that improves performance" },
+  { value: "test", label: "test", hint: "Adding missing tests or correcting existing tests" },
+  { value: "build", label: "build", hint: "Changes that affect the build system or external dependencies" },
+  { value: "ci", label: "ci", hint: "Changes to our CI configuration files and scripts" },
   { value: "", label: "none" }
 ];
 var DEFAULT_SCOPE_OPTIONS = [
@@ -113,7 +115,8 @@ var Config = import_zod2.z.object({
   breaking_change: import_zod2.z.object({
     add_exclamation_to_title: import_zod2.z.boolean().default(true)
   }).default({}),
-  confirm_commit: import_zod2.z.boolean().default(true)
+  confirm_commit: import_zod2.z.boolean().default(true),
+  print_commit_output: import_zod2.z.boolean().default(true)
 }).default({});
 var CommitState = import_zod2.z.object({
   type: import_zod2.z.string().default(""),

package/package.json

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

package/readme.md

@@ -1,13 +1,13 @@
-# 📝 Better Commits
+# Better Commits
 
-![better commits is enabled](https://img.shields.io/badge/better--commits-enabled-brightgreen)
-[![downloads](https://img.shields.io/npm/dt/better-commits.svg)](https://www.npmjs.com/package/better-commits)
-[![install size](https://packagephobia.com/badge?p=better-commits)](https://packagephobia.com/result?p=better-commits)
-![GitHub issues](https://img.shields.io/github/issues-raw/everduin94/better-commits)
+[![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)
+<a href="https://github.com/everduin94/better-commits/issues">
+		<img alt="Issues" src="https://img.shields.io/github/issues/everduin94/better-commits?style=for-the-badge&logo=gitbook&color=cba6f7&logoColor=D9E0EE&labelColor=302D41"></a>
 
 A CLI for writing better commits, following the conventional commit guidelines, written with Typescript | ZOD | Clack
 
-https://user-images.githubusercontent.com/14320878/224050591-c6035ac5-1120-40c8-97b0-c33ebcb11b3e.mov
+https://user-images.githubusercontent.com/14320878/225088948-43073a0e-400c-4c5f-a6e3-4f4961cfe43d.mov
 
 ## ✨ Features
 - Follows the conventional commit guidelines
@@ -43,12 +43,17 @@ To modify, these prompts, see `configuration`.
 
 ## ⚙️ Configuration
  
-Your first time running `better-commits`, a default config will be generated in your `$HOME` directory, named `.better-commits.json`. -- This is your global config, it will be used if a repository-specific config cannot be found.
+ 
+### Global
+
+Your first time running `better-commits`, a default config will be generated in your `$HOME` directory, named `.better-commits.json`
+- This config will be used if a repository-specific config cannot be found.
+
+### Repository
 
 To create a **repository-specific config**, navigate to the root of your project.
 - run `better-commits-init`
-
-This will create a config named `.better-commits.json` with all of the defaults. From there, you can modify it to suit your needs.
+- This will create a default config named `.better-commits.json`
 
 All properties are optional, they can be removed from your configuration and will be replaced by the defaults at run-time.
 
@@ -64,27 +69,43 @@ All properties are optional, they can be removed from your configuration and wil
 		"options": [
 			{
 				"value": "feat",
-				"label": "feat"
+				"label": "feat",
+				"hint": "A new feature"
 			},
 			{
 				"value": "fix",
-				"label": "fix"
+				"label": "fix",
+				"hint": "A bug fix"
 			},
 			{
 				"value": "docs",
-				"label": "docs"
+				"label": "docs",
+				"hint": "Documentation only changes"
 			},
 			{
 				"value": "refactor",
-				"label": "refactor"
+				"label": "refactor",
+				"hint": "A code change that neither fixes a bug nor adds a feature"
 			},
 			{
 				"value": "perf",
-				"label": "perf"
+				"label": "perf",
+				"hint": "A code change that improves performance"
 			},
 			{
 				"value": "test",
-				"label": "test"
+				"label": "test",
+				"hint": "Adding missing tests or correcting existing tests"
+			},
+			{
+				"value": "build",
+				"label": "build",
+				"hint": "Changes that affect the build system or external dependencies"
+			},
+			{
+				"value": "ci",
+				"label": "ci",
+				"hint": "Changes to our CI configuration files and scripts"
 			},
 			{
 				"value": "",
@@ -137,13 +158,15 @@ All properties are optional, they can be removed from your configuration and wil
 		"options": [
 			"closes",
 			"breaking-change",
-			"deprecated"
+			"deprecated",
+			"custom"
 		]
 	},
 	"breaking_change": {
 		"add_exclamation_to_title": true
 	},
-	"confirm_commit": true
+	"confirm_commit": true,
+	"print_commit_output": true
 }
 ```
 
@@ -159,6 +182,8 @@ To simplify the CLI, some rules are enforced at runtime to make sure the program
 - `commit_footer` options are supplied from a fixed list, because they have specific functionality
   - thus, you can remove from that list, but you can't add custom values to it
 
+TODO: Add table explaining properties
+
 #### 🔎 Inference
 
 `better-commits` will attempt to infer the ticket/issue and the type from your branch name. It will auto populate the corresponding field if found. 
@@ -186,6 +211,14 @@ To simplify the CLI, some rules are enforced at runtime to make sure the program
 - if you're using Github issues to track your work, and select the `closes` footer option when writing your commit. Github will **automatically link and close** that issue when your **pr is merged**
 - [better-commits](https://packagephobia.com/result?p=better-commits) is much smaller than its alternative [commitizen](https://packagephobia.com/result?p=commitizen)
 - `better-commits` uses native `git` commands under the hood. So any hooks, tools, or staging should work as if it was a normal commit.
+- You can add this badge to your repository to display that you're using a better-commits repository config 
+```
+[![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)
+```
+
+[![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)
+
+
 
 ## ❓ Troubleshooting
 

package/src/index.ts

@@ -13,7 +13,6 @@ import { CONFIG_FILE_NAME, get_default_config_path, check_missing_stage, addNewL
 main(load_setup());
 
 function load_setup(): z.infer<typeof Config> {
-
   console.clear();
   p.intro(`${color.bgCyan(color.black(' better-commits '))}`);
 
@@ -34,7 +33,6 @@ function load_setup(): z.infer<typeof Config> {
   p.log.step('Config not found. Generating default .better-commit.json at $HOME')
   fs.writeFileSync(home_path, JSON.stringify(default_config, null, '\t'));
   return default_config;
-
 }
 
 function read_config_from_path(config_path: string) {
@@ -102,7 +100,7 @@ async function main(config: z.infer<typeof Config>) {
           initialValue: initial_value,
           options: config.commit_type.options,
         }
-    ) as string
+    )
     if (p.isCancel(commit_type)) process.exit(0)
     commit_state.type = commit_type;
   }
@@ -112,7 +110,7 @@ async function main(config: z.infer<typeof Config>) {
       message: 'Select a commit scope',
       initialValue: config.commit_scope.initial_value,
       options: config.commit_scope.options
-    }) as string
+    })
     if (p.isCancel(commit_scope)) process.exit(0)
     commit_state.scope = commit_scope;
   }
@@ -130,14 +128,14 @@ async function main(config: z.infer<typeof Config>) {
       // Can't find branch, fail silently
     }
   }
+
   if (config.check_ticket.confirm_ticket) {
     const user_commit_ticket = await p.text({
-      message: commit_state.ticket ?  `Ticket / issue infered from branch ${color.dim('(confirm / edit)')}`: `Add ticket / issue ${OPTIONAL_PROMPT}`,
+      message: commit_state.ticket ?  `Ticket / issue inferred from branch ${color.dim('(confirm / edit)')}`: `Add ticket / issue ${OPTIONAL_PROMPT}`,
+      placeholder: '',
       initialValue: commit_state.ticket,
-    }) as string
+    })
     if (p.isCancel(user_commit_ticket)) process.exit(0)
-    // TODO: Symbol can be null. Would be ideal if it just returned empty string. 
-    // Seems like a bug that it only returns undefined if previously set.
     commit_state.ticket = user_commit_ticket ?? '';
   }
 
@@ -154,8 +152,7 @@ async function main(config: z.infer<typeof Config>) {
 					},
           
       }
-  ) as string
-
+  )
   if (p.isCancel(commit_title)) process.exit(0)
   commit_state.title = clean_commit_title(commit_title);
 
@@ -167,9 +164,9 @@ async function main(config: z.infer<typeof Config>) {
               if (config.commit_body.required && !val) return 'Please enter a description' 
             }
         
-    }) as string
+    })
     if (p.isCancel(commit_body)) process.exit(0)
-    commit_state.body = commit_body;
+    commit_state.body = commit_body ?? '';
   }
 
   if (config.commit_footer.enable) {
@@ -188,11 +185,13 @@ async function main(config: z.infer<typeof Config>) {
               validate: (value) => {
                 if (!value) return 'Please enter a title / summary'
               }
-      }) as string
+      })
+      if (p.isCancel(breaking_changes_title)) process.exit(0)
       const breaking_changes_body = await p.text({
               message: `Breaking Changes: Write a description & migration instructions ${OPTIONAL_PROMPT}`,
               placeholder: '',
-      }) as string
+      })
+      if (p.isCancel(breaking_changes_body)) process.exit(0)
       commit_state.breaking_title = breaking_changes_title;
       commit_state.breaking_body = breaking_changes_body;
     }
@@ -204,11 +203,13 @@ async function main(config: z.infer<typeof Config>) {
               validate: (value) => {
                 if (!value) return 'Please enter a title / summary'
               }
-      }) as string
+      })
+      if (p.isCancel(deprecated_title)) process.exit(0)
       const deprecated_body = await p.text({
               message: `Deprecated: Write a description ${OPTIONAL_PROMPT}`,
               placeholder: '',
-      }) as string
+      })
+      if (p.isCancel(deprecated_body)) process.exit(0)
       commit_state.deprecates_body = deprecated_body;
       commit_state.deprecates_title = deprecated_title;
     }
@@ -221,7 +222,8 @@ async function main(config: z.infer<typeof Config>) {
       const custom_footer = await p.text({
               message: 'Write a custom footer',
               placeholder: '',
-      }) as string
+      })
+      if (p.isCancel(custom_footer)) process.exit(0)
       commit_state.custom_footer = custom_footer;
     }
   }
@@ -234,7 +236,17 @@ async function main(config: z.infer<typeof Config>) {
     if (p.isCancel(continue_commit)) process.exit(0)
   }
 
-  if (continue_commit) simpleGit().commit(build_commit_string(commit_state, config, false))
+  if (!continue_commit) {
+    p.log.info('Exiting without commit')
+    process.exit(0)
+  } 
+
+  try {      
+    const output = execSync(`git commit -m "${build_commit_string(commit_state, config, false)}"`).toString().trim();
+    if (config.print_commit_output) p.log.info(output)
+  } catch(err) {
+    p.log.error('Something went wrong when committing: ' + err)
+  }
 }
 
 function build_commit_string(commit_state: z.infer<typeof CommitState>, config: z.infer<typeof Config>, colorize: boolean = false): string {
@@ -300,7 +312,6 @@ function build_commit_string(commit_state: z.infer<typeof CommitState>, config:
     commit_string += colorize ? `\n\n${color.reset(commit_state.closes)} ${color.magenta(commit_state.ticket)}` : `\n\n${commit_state.closes} ${commit_state.ticket}`;
   }
 
-
   return commit_string;
 }
 

package/src/utils.ts

@@ -12,12 +12,14 @@ export const REGEX_START_TAG = new RegExp(/^(\w+-\d+)/)
 export const REGEX_SLASH_NUM = new RegExp(/\/(\d+)/)
 export const REGEX_START_NUM = new RegExp(/^(\d+)/)
 export const DEFAULT_TYPE_OPTIONS = [
-    { value: 'feat', label: 'feat' },
-    { value: 'fix', label: 'fix' },
-    { value: 'docs', label: 'docs'},
-    { value: 'refactor', label: 'refactor'},
-    { value: 'perf', label: 'perf'},
-    { value: 'test', label: 'test'},
+    { value: 'feat', label: 'feat' , hint: 'A new feature'},
+    { value: 'fix', label: 'fix' , hint: 'A bug fix'},
+    { value: 'docs', label: 'docs', hint: 'Documentation only changes'},
+    { value: 'refactor', label: 'refactor', hint: 'A code change that neither fixes a bug nor adds a feature'},
+    { value: 'perf', label: 'perf', hint: 'A code change that improves performance'},
+    { value: 'test', label: 'test', hint: 'Adding missing tests or correcting existing tests'},
+    { value: 'build', label: 'build', hint: 'Changes that affect the build system or external dependencies'},
+    { value: 'ci', label: 'ci', hint: 'Changes to our CI configuration files and scripts'},
     { value: '', label: 'none'},
 ]
 export const DEFAULT_SCOPE_OPTIONS = [

package/src/zod-state.ts

@@ -51,7 +51,8 @@ export const Config = z.object({
    breaking_change: z.object({
       add_exclamation_to_title: z.boolean().default(true)
    }).default({}),
-   confirm_commit: z.boolean().default(true)
+   confirm_commit: z.boolean().default(true),
+   print_commit_output: z.boolean().default(true)
 }).default({})
 
 export const CommitState = z.object({