better-commits 1.1.0 → 1.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Erik Verduin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.js

@@ -90,6 +90,9 @@ function infer_type_from_branch(types) {
   });
   return found ?? "";
 }
+function get_git_root() {
+  return (0, import_child_process.execSync)("git rev-parse --show-toplevel").toString().trim();
+}
 function get_default_config_path() {
   return (0, import_os.homedir)() + "/" + CONFIG_FILE_NAME;
 }
@@ -190,7 +193,7 @@ main(load_setup());
 function load_setup() {
   console.clear();
   p.intro(`${import_picocolors2.default.bgCyan(import_picocolors2.default.black(" better-commits "))}`);
-  const root = (0, import_child_process2.execSync)("git rev-parse --show-toplevel").toString().trim();
+  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");
@@ -203,7 +206,7 @@ function load_setup() {
   }
   const default_config = Config.parse({});
   p.log.step("Config not found. Generating default .better-commit.json at $HOME");
-  import_fs.default.writeFileSync(home_path, JSON.stringify(default_config, null, "	"));
+  import_fs.default.writeFileSync(home_path, JSON.stringify(default_config, null, 4));
   return default_config;
 }
 function read_config_from_path(config_path) {
@@ -226,7 +229,8 @@ function validate_config(config) {
 }
 async function main(config) {
   let commit_state = CommitState.parse({});
-  let git_status = await (0, import_simple_git.simpleGit)().status();
+  const simple_git = (0, import_simple_git.simpleGit)({ baseDir: get_git_root() });
+  let git_status = await simple_git.status();
   if (config.check_status) {
     p.log.step(import_picocolors2.default.black(import_picocolors2.default.bgGreen(" Checking Git Status ")));
     const missing_files = check_missing_stage(git_status);
@@ -242,8 +246,8 @@ async function main(config) {
       });
       if (p.isCancel(selected_for_staging))
         process.exit(0);
-      await (0, import_simple_git.simpleGit)().add(selected_for_staging);
-      git_status = await (0, import_simple_git.simpleGit)().status();
+      await simple_git.add(selected_for_staging);
+      git_status = await simple_git.status();
       if (selected_for_staging?.length) {
         p.log.success(import_picocolors2.default.green("Changes successfully staged"));
       }

package/dist/init.js

@@ -29,6 +29,7 @@ var import_zod2 = require("zod");
 // src/utils.ts
 var import_zod = require("zod");
 var import_picocolors = __toESM(require("picocolors"));
+var import_child_process = require("child_process");
 var CONFIG_FILE_NAME = ".better-commits.json";
 var SPACE_TO_SELECT = `${import_picocolors.default.dim("(<space> to select)")}`;
 var OPTIONAL_PROMPT = `${import_picocolors.default.dim("(optional)")}`;
@@ -58,6 +59,9 @@ var DEFAULT_SCOPE_OPTIONS = [
 var CUSTOM_SCOPE_KEY = "custom";
 var Z_FOOTER_OPTIONS = import_zod.z.enum(["closes", "breaking-change", "deprecated", "custom"]);
 var FOOTER_OPTION_VALUES = ["closes", "breaking-change", "deprecated", "custom"];
+function get_git_root() {
+  return (0, import_child_process.execSync)("git rev-parse --show-toplevel").toString().trim();
+}
 
 // src/zod-state.ts
 var Config = import_zod2.z.object({
@@ -139,15 +143,14 @@ var CommitState = import_zod2.z.object({
 // src/init.ts
 var import_picocolors2 = __toESM(require("picocolors"));
 var import_fs = __toESM(require("fs"));
-var import_child_process = require("child_process");
 var p = __toESM(require("@clack/prompts"));
 try {
   console.clear();
   p.intro(`${import_picocolors2.default.bgCyan(import_picocolors2.default.black(" better-commits-init "))}`);
-  const root = (0, import_child_process.execSync)("git rev-parse --show-toplevel").toString().trim();
+  const root = get_git_root();
   const root_path = `${root}/${CONFIG_FILE_NAME}`;
   const default_config = Config.parse({});
-  import_fs.default.writeFileSync(root_path, JSON.stringify(default_config, null, "	"));
+  import_fs.default.writeFileSync(root_path, JSON.stringify(default_config, null, 4));
   p.log.success(`${import_picocolors2.default.green("Successfully created .better-commits.json")}`);
   p.outro(`Run ${import_picocolors2.default.bgBlack(import_picocolors2.default.white("better-commits"))} to start the CLI`);
 } catch (err) {

package/dist/utils.js

@@ -47,6 +47,7 @@ __export(utils_exports, {
   check_missing_stage: () => check_missing_stage,
   clean_commit_title: () => clean_commit_title,
   get_default_config_path: () => get_default_config_path,
+  get_git_root: () => get_git_root,
   infer_type_from_branch: () => infer_type_from_branch
 });
 module.exports = __toCommonJS(utils_exports);
@@ -105,6 +106,9 @@ function infer_type_from_branch(types) {
   });
   return found ?? "";
 }
+function get_git_root() {
+  return (0, import_child_process.execSync)("git rev-parse --show-toplevel").toString().trim();
+}
 function get_default_config_path() {
   return (0, import_os.homedir)() + "/" + CONFIG_FILE_NAME;
 }
@@ -141,5 +145,6 @@ function clean_commit_title(title) {
   check_missing_stage,
   clean_commit_title,
   get_default_config_path,
+  get_git_root,
   infer_type_from_branch
 });

package/package.json

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

package/readme.md

@@ -61,136 +61,143 @@ All properties are optional, they can be removed from your configuration and wil
 
 ```json
 {
-	"check_status": true,
-	"commit_type": {
-		"enable": true,
-		"initial_value": "feat",
-		"infer_type_from_branch": true,
-		"options": [
-			{
-				"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": "chore",
-				"label": "chore",
-				"hint": "Other changes that do not modify src or test files"
-			},
-			{
-				"value": "",
-				"label": "none"
-			}
-		]
-	},
-	"commit_scope": {
-		"enable": true,
-    "custom_scope": false,
-		"initial_value": "app",
-		"options": [
-			{
-				"value": "app",
-				"label": "app"
-			},
-			{
-				"value": "shared",
-				"label": "shared"
-			},
-			{
-				"value": "server",
-				"label": "server"
-			},
-			{
-				"value": "tools",
-				"label": "tools"
-			},
-			{
-				"value": "",
-				"label": "none"
-			}
-		]
-	},
-	"check_ticket": {
-		"infer_ticket": true,
-		"confirm_ticket": true,
-		"add_to_title": true,
-		"append_hashtag": false
-	},
-	"commit_title": {
-		"max_size": 70
-	},
-	"commit_body": {
-		"enable": true,
-		"required": false
-	},
-	"commit_footer": {
-		"enable": true,
-		"initial_value": [],
-		"options": [
-			"closes",
-			"breaking-change",
-			"deprecated",
-			"custom"
-		]
-	},
-	"breaking_change": {
-		"add_exclamation_to_title": true
-	},
-	"confirm_commit": true,
-	"print_commit_output": true
+    "check_status": true,
+    "commit_type": {
+        "enable": true,
+        "initial_value": "feat",
+        "infer_type_from_branch": true,
+        "options": [
+            {
+                "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": "chore",
+                "label": "chore",
+                "hint": "Other changes that do not modify src or test files"
+            },
+            {
+                "value": "",
+                "label": "none"
+            }
+        ]
+    },
+    "commit_scope": {
+        "enable": true,
+        "custom_scope": false,
+        "initial_value": "app",
+        "options": [
+            {
+                "value": "app",
+                "label": "app"
+            },
+            {
+                "value": "shared",
+                "label": "shared"
+            },
+            {
+                "value": "server",
+                "label": "server"
+            },
+            {
+                "value": "tools",
+                "label": "tools"
+            },
+            {
+                "value": "",
+                "label": "none"
+            }
+        ]
+    },
+    "check_ticket": {
+        "infer_ticket": true,
+        "confirm_ticket": true,
+        "add_to_title": true,
+        "append_hashtag": false
+    },
+    "commit_title": {
+        "max_size": 70
+    },
+    "commit_body": {
+        "enable": true,
+        "required": false
+    },
+    "commit_footer": {
+        "enable": true,
+        "initial_value": [],
+        "options": [
+            "closes",
+            "breaking-change",
+            "deprecated",
+            "custom"
+        ]
+    },
+    "breaking_change": {
+        "add_exclamation_to_title": true
+    },
+    "confirm_commit": true,
+    "print_commit_output": true
 }
 ```
 
-#### ✅ Config Validation
-To simplify the CLI, some rules are enforced at runtime to make sure the program runs properly.
-- any property can be removed from the config, it will be replaced by the default at run-time
-- if a property is a string/number/boolean in the default, it must stay that type
-- the `initial_value` must be a valid value in the corresponding `options`
-- `commit_scope` and `commit_type` can be populated with as many or whatever options
-  - must maintain the shape `{value: string, label?: string, hint?: string}`
-  - `hint` and `label` are optional
-  - to force scope or type to be required, remove `None`
-- `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
+### ✅ Config Validation
+
+Any property can be removed from the config, it will be replaced by the default at run-time
+- See `.better-commits.json` in this repository as an example
+
+#### Types
+if a property is a string/number/boolean in the default, it must stay that type
+
+#### Scope & Type
+The `initial_value` must be a `value` in the corresponding `options`
+
+`commit_scope` and `commit_type` can be populated with as many or whatever options you like
+- `hint` and `label` are optional
+- to make scope or type required, remove `None`
+  
+#### Footer
+`commit_footer` options are supplied from a fixed list, because they have specific functionality
+  - You can remove from that list, but you can't add custom values to it
 
 TODO: Add table explaining properties
 
-#### 🔎 Inference
+### 🔎 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. 
 
@@ -208,23 +215,30 @@ TODO: Add table explaining properties
 - `-TYPE-` -- If a type is between two dashes
 
 ## 😮 Mildly Interesting
-- `better-commits` works with [Semantic Release](https://github.com/semantic-release/semantic-release)
-- if you use `better-commits` to create your *first* commit on a new branch, when you open a PR for that branch, it will properly **auto-populate the title and body**.
-- when you squash / merge with github, if `better-commits` is your *first* commit, all later commits like "addressing comments", "fixing mistake". Will be prefixed with an asterisk for easy deletion. This way you **maintain your pretty commit even when squashing**.
-- if you use a branch name like the ones below, better-commits will be able to infer your ticket/issue and type
-  - `TYPE/TICKET-description`
-  - `USER/TYPE/TICKET-description`
-- 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 
+
+### Building / Versioning
+`better-commits` works with [Semantic Release](https://github.com/semantic-release/semantic-release)
+
+### Github
+if you use `better-commits` to create your *first* commit on a new branch
+- when you open a PR for that branch, it will properly **auto-populate the title and body**.
+- when you squash/merge, all later commits like "addressing comments" or "fixing mistake". Will be prefixed with an asterisk for easy deletion. This way, you **maintain your pretty commit even when squashing**.
+
+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**
+
+### Fun Facts
+[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

@@ -2,13 +2,13 @@
 
 import * as p from '@clack/prompts';
 import color from 'picocolors';
-import { simpleGit } from "simple-git"
+import { SimpleGit, simpleGit } from "simple-git"
 import fs from 'fs'
 import { execSync } from 'child_process';
 import { z } from "zod";
 import { fromZodError } from 'zod-validation-error';
 import { CommitState, Config } from './zod-state';
-import { CONFIG_FILE_NAME, get_default_config_path, check_missing_stage, addNewLine, SPACE_TO_SELECT, REGEX_SLASH_TAG, REGEX_SLASH_NUM, REGEX_START_TAG, REGEX_START_NUM, OPTIONAL_PROMPT, clean_commit_title, COMMIT_FOOTER_OPTIONS, infer_type_from_branch, Z_FOOTER_OPTIONS, CUSTOM_SCOPE_KEY } from './utils';
+import { CONFIG_FILE_NAME, get_default_config_path, check_missing_stage, addNewLine, SPACE_TO_SELECT, REGEX_SLASH_TAG, REGEX_SLASH_NUM, REGEX_START_TAG, REGEX_START_NUM, OPTIONAL_PROMPT, clean_commit_title, COMMIT_FOOTER_OPTIONS, infer_type_from_branch, Z_FOOTER_OPTIONS, CUSTOM_SCOPE_KEY,  get_git_root } from './utils';
 
 main(load_setup());
 
@@ -16,7 +16,7 @@ function load_setup(): z.infer<typeof Config> {
   console.clear();
   p.intro(`${color.bgCyan(color.black(' better-commits '))}`);
 
-  const root = execSync('git rev-parse --show-toplevel').toString().trim();
+  const root = get_git_root();
   const root_path = `${root}/${CONFIG_FILE_NAME}`
   if (fs.existsSync(root_path)) {
     p.log.step('Found repository config')
@@ -31,7 +31,7 @@ function load_setup(): z.infer<typeof Config> {
 
   const default_config = Config.parse({})
   p.log.step('Config not found. Generating default .better-commit.json at $HOME')
-  fs.writeFileSync(home_path, JSON.stringify(default_config, null, '\t'));
+  fs.writeFileSync(home_path, JSON.stringify(default_config, null, 4));
   return default_config;
 }
 
@@ -58,7 +58,8 @@ function validate_config(config: z.infer<typeof Config>): z.infer<typeof Config>
 
 async function main(config: z.infer<typeof Config>) {
   let commit_state = CommitState.parse({})
-  let git_status = await simpleGit().status();
+  const simple_git = simpleGit({ baseDir: get_git_root() })
+  let git_status = await simple_git.status();
   if (config.check_status) {
     p.log.step(color.black(color.bgGreen(' Checking Git Status ')))
     const missing_files = check_missing_stage(git_status);
@@ -74,8 +75,8 @@ async function main(config: z.infer<typeof Config>) {
      }) as string[]
     if (p.isCancel(selected_for_staging)) process.exit(0)
 
-     await simpleGit().add(selected_for_staging)
-     git_status = await simpleGit().status();
+     await simple_git.add(selected_for_staging)
+     git_status = await simple_git.status();
      if (selected_for_staging?.length){
         p.log.success(color.green('Changes successfully staged'))    
      }

package/src/init.ts

@@ -3,17 +3,16 @@
 import { Config } from "./zod-state";
 import color from 'picocolors';
 import fs from 'fs'
-import { execSync } from "child_process";
 import * as p from '@clack/prompts';
-import { CONFIG_FILE_NAME } from "./utils";
+import { CONFIG_FILE_NAME, get_git_root } from "./utils";
 
 try {
   console.clear();
   p.intro(`${color.bgCyan(color.black(' better-commits-init '))}`)
-  const root = execSync('git rev-parse --show-toplevel').toString().trim();
+  const root = get_git_root();
   const root_path = `${root}/${CONFIG_FILE_NAME}`
   const default_config = Config.parse({})
-  fs.writeFileSync(root_path, JSON.stringify(default_config, null, '\t'));
+  fs.writeFileSync(root_path, JSON.stringify(default_config, null, 4));
   p.log.success(`${color.green('Successfully created .better-commits.json')}`)
   p.outro(`Run ${color.bgBlack(color.white('better-commits'))} to start the CLI`)
 } catch (err: any) {

package/src/utils.ts

@@ -60,6 +60,10 @@ export function infer_type_from_branch(types: string[]): string {
   return found ?? ''
 }
 
+export function get_git_root(): string {
+  return execSync('git rev-parse --show-toplevel').toString().trim();
+}
+
 export function get_default_config_path(): string {
   return homedir()+'/'+CONFIG_FILE_NAME
 }

package/src/zod-state.ts

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