better-commits 1.0.2 → 1.0.4

package/dist/index.js

@@ -72,7 +72,7 @@ var FOOTER_OPTION_VALUES = ["closes", "breaking-change", "deprecated"];
 function infer_type_from_branch(types) {
   let branch = "";
   try {
-    branch = (0, import_child_process.execSync)("git rev-parse --abbrev-ref HEAD", { stdio: "pipe" }).toString();
+    branch = (0, import_child_process.execSync)("git branch --show-current", { stdio: "pipe" }).toString();
   } catch (err) {
     return "";
   }
@@ -267,7 +267,7 @@ async function main(config) {
   }
   if (config.check_ticket.infer_ticket) {
     try {
-      const branch = (0, import_child_process2.execSync)("git rev-parse --abbrev-ref HEAD", { stdio: "pipe" }).toString();
+      const branch = (0, import_child_process2.execSync)("git branch --show-current", { stdio: "pipe" }).toString();
       const found = [branch.match(REGEX_SLASH_TAG), branch.match(REGEX_SLASH_NUM), branch.match(REGEX_START_TAG), 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];

package/dist/utils.js

@@ -86,7 +86,7 @@ var FOOTER_OPTION_VALUES = ["closes", "breaking-change", "deprecated"];
 function infer_type_from_branch(types) {
   let branch = "";
   try {
-    branch = (0, import_child_process.execSync)("git rev-parse --abbrev-ref HEAD", { stdio: "pipe" }).toString();
+    branch = (0, import_child_process.execSync)("git branch --show-current", { stdio: "pipe" }).toString();
   } catch (err) {
     return "";
   }

package/package.json

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

package/readme.md

@@ -38,12 +38,12 @@ To modify, these prompts, see `configuration`.
 
 ## ⚙️ Configuration
  
-Your first time running `better-commits`, a default config will be generated in your `$HOME` directory. -- This is your global config, it will be used if a repository-specific config cannot be found.
+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.
 
 To create a **repository-specific config**, navigate to the root of your project.
 - run `better-commits-init`
 
-This will create a config with all of the defaults. From there, you can modify it to suit your needs.
+This will create a config named `.better-commits.json` with all of the defaults. From there, you can modify it to suit your needs.
 
 All properties are optional, they can be removed from your configuration and will be replaced by the defaults at run-time.
 
@@ -181,6 +181,10 @@ 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)
 
+## ❓ Troubleshooting
+
+`TTY initialization failed: uv_tty_init returned EBADF (bad file descriptor)`. This may happen because you're running something like git-bash on Windows. Try another terminal/command-prompt or `winpty` to see if its still an issue.
+
 ## Alternatives
 - Commitizen
 

package/src/index.ts

@@ -120,7 +120,7 @@ async function main(config: z.infer<typeof Config>) {
 
   if (config.check_ticket.infer_ticket) {
     try {
-      const branch = execSync('git rev-parse --abbrev-ref HEAD', {stdio : 'pipe' }).toString();
+      const branch = execSync('git branch --show-current', {stdio : 'pipe' }).toString();
       const found: string[] = [branch.match(REGEX_SLASH_TAG), branch.match(REGEX_SLASH_NUM) , branch.match(REGEX_START_TAG), branch.match(REGEX_START_NUM)]
       .filter(v => v != null)
       .map(v => v && v.length >= 2 ?  v[1] : '')

package/src/utils.ts

@@ -41,7 +41,7 @@ export const FOOTER_OPTION_VALUES: FOOTER_OPTIONS[] = ['closes', 'breaking-chang
 export function infer_type_from_branch(types: string[]): string {
   let branch = ''
   try {
-    branch = execSync('git rev-parse --abbrev-ref HEAD', {stdio : 'pipe' }).toString();
+    branch = execSync('git branch --show-current', {stdio : 'pipe' }).toString();
   } catch (err) {
     return ''
   }