better-commits 1.0.1 → 1.0.3

package/dist/index.js

@@ -28,7 +28,7 @@ var p = __toESM(require("@clack/prompts"));
 var import_picocolors2 = __toESM(require("picocolors"));
 var import_simple_git = require("simple-git");
 var import_fs = __toESM(require("fs"));
-var import_child_process = require("child_process");
+var import_child_process2 = require("child_process");
 var import_zod_validation_error = require("zod-validation-error");
 
 // src/zod-state.ts
@@ -38,6 +38,7 @@ var import_zod2 = require("zod");
 var import_os = require("os");
 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)")}`;
@@ -68,6 +69,22 @@ var COMMIT_FOOTER_OPTIONS = [
 ];
 var Z_FOOTER_OPTIONS = import_zod.z.enum(["closes", "breaking-change", "deprecated"]);
 var FOOTER_OPTION_VALUES = ["closes", "breaking-change", "deprecated"];
+function infer_type_from_branch(types) {
+  let branch = "";
+  try {
+    branch = (0, import_child_process.execSync)("git branch --show-current", { stdio: "pipe" }).toString();
+  } catch (err) {
+    return "";
+  }
+  const found = types.find((t) => {
+    const start_dash = new RegExp(`^${t}-`);
+    const between_dash = new RegExp(`-${t}-`);
+    const before_slash = new RegExp(`${t}/`);
+    const re = [branch.match(start_dash), branch.match(between_dash), branch.match(before_slash)].filter((v) => v != null);
+    return re?.length;
+  });
+  return found ?? "";
+}
 function get_default_config_path() {
   return (0, import_os.homedir)() + "/" + CONFIG_FILE_NAME;
 }
@@ -92,6 +109,7 @@ var Config = import_zod2.z.object({
   commit_type: import_zod2.z.object({
     enable: import_zod2.z.boolean().default(true),
     initial_value: import_zod2.z.string().default("feat"),
+    infer_type_from_branch: import_zod2.z.boolean().default(true),
     options: import_zod2.z.array(import_zod2.z.object({
       value: import_zod2.z.string(),
       label: import_zod2.z.string().optional(),
@@ -155,7 +173,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_process.execSync)("git rev-parse --show-toplevel").toString().trim();
+  const root = (0, import_child_process2.execSync)("git rev-parse --show-toplevel").toString().trim();
   const root_path = `${root}/${CONFIG_FILE_NAME}`;
   if (import_fs.default.existsSync(root_path)) {
     p.log.step("Found repository config");
@@ -219,10 +237,17 @@ async function main(config) {
     process.exit(0);
   }
   if (config.commit_type.enable) {
+    let initial_value = config.commit_type.initial_value;
+    if (config.commit_type.infer_type_from_branch) {
+      const options = config.commit_type.options.map((o) => o.value);
+      const type_from_branch = infer_type_from_branch(options);
+      if (type_from_branch)
+        initial_value = type_from_branch;
+    }
     const commit_type = await p.select(
       {
         message: `Select a commit type`,
-        initialValue: config.commit_type.initial_value,
+        initialValue: initial_value,
         options: config.commit_type.options
       }
     );
@@ -242,7 +267,7 @@ async function main(config) {
   }
   if (config.check_ticket.infer_ticket) {
     try {
-      const branch = (0, import_child_process.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/init.js

@@ -61,6 +61,7 @@ var Config = import_zod2.z.object({
   commit_type: import_zod2.z.object({
     enable: import_zod2.z.boolean().default(true),
     initial_value: import_zod2.z.string().default("feat"),
+    infer_type_from_branch: import_zod2.z.boolean().default(true),
     options: import_zod2.z.array(import_zod2.z.object({
       value: import_zod2.z.string(),
       label: import_zod2.z.string().optional(),

package/dist/utils.js

@@ -45,12 +45,14 @@ __export(utils_exports, {
   addNewLine: () => addNewLine,
   check_missing_stage: () => check_missing_stage,
   clean_commit_title: () => clean_commit_title,
-  get_default_config_path: () => get_default_config_path
+  get_default_config_path: () => get_default_config_path,
+  infer_type_from_branch: () => infer_type_from_branch
 });
 module.exports = __toCommonJS(utils_exports);
 var import_os = require("os");
 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)")}`;
@@ -81,6 +83,22 @@ var COMMIT_FOOTER_OPTIONS = [
 ];
 var Z_FOOTER_OPTIONS = import_zod.z.enum(["closes", "breaking-change", "deprecated"]);
 var FOOTER_OPTION_VALUES = ["closes", "breaking-change", "deprecated"];
+function infer_type_from_branch(types) {
+  let branch = "";
+  try {
+    branch = (0, import_child_process.execSync)("git branch --show-current", { stdio: "pipe" }).toString();
+  } catch (err) {
+    return "";
+  }
+  const found = types.find((t) => {
+    const start_dash = new RegExp(`^${t}-`);
+    const between_dash = new RegExp(`-${t}-`);
+    const before_slash = new RegExp(`${t}/`);
+    const re = [branch.match(start_dash), branch.match(between_dash), branch.match(before_slash)].filter((v) => v != null);
+    return re?.length;
+  });
+  return found ?? "";
+}
 function get_default_config_path() {
   return (0, import_os.homedir)() + "/" + CONFIG_FILE_NAME;
 }
@@ -115,5 +133,6 @@ function clean_commit_title(title) {
   addNewLine,
   check_missing_stage,
   clean_commit_title,
-  get_default_config_path
+  get_default_config_path,
+  infer_type_from_branch
 });

package/dist/zod-state.js

@@ -70,6 +70,7 @@ var Config = import_zod2.z.object({
   commit_type: import_zod2.z.object({
     enable: import_zod2.z.boolean().default(true),
     initial_value: import_zod2.z.string().default("feat"),
+    infer_type_from_branch: import_zod2.z.boolean().default(true),
     options: import_zod2.z.array(import_zod2.z.object({
       value: import_zod2.z.string(),
       label: import_zod2.z.string().optional(),

package/package.json

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

package/readme.md

@@ -1,8 +1,8 @@
 # 📝 Better Commits
 
-A CLI to write better commits, written with Typescript | ZOD | Clack
+A CLI for writing better commits, following the conventional commit guidelines, written with Typescript | ZOD | Clack
 
-GIF
+https://user-images.githubusercontent.com/14320878/224050591-c6035ac5-1120-40c8-97b0-c33ebcb11b3e.mov
 
 ## ✨ Features
 - Follows the conventional commit guidelines
@@ -10,7 +10,7 @@ GIF
 - Easy install with sane defaults
 - Checks git status with interactive git add
 - Works globally or in your repository
-- Attempts to infer ticket/issue from branch
+- Attempts to infer ticket/issue and type from branch
 - Pretty prints preview in color
 - Validates config at runtime
 
@@ -55,6 +55,7 @@ All properties are optional, they can be removed from your configuration and wil
 	"commit_type": {
 		"enable": true,
 		"initial_value": "feat",
+		"infer_type_from_branch": true,
 		"options": [
 			{
 				"value": "feat",
@@ -68,15 +69,15 @@ All properties are optional, they can be removed from your configuration and wil
 				"value": "docs",
 				"label": "docs"
 			},
-      {
+			{
 				"value": "refactor",
 				"label": "refactor"
 			},
-      {
+			{
 				"value": "perf",
 				"label": "perf"
 			},
-      {
+			{
 				"value": "test",
 				"label": "test"
 			},
@@ -102,7 +103,7 @@ All properties are optional, they can be removed from your configuration and wil
 				"value": "server",
 				"label": "server"
 			},
-      {
+			{
 				"value": "tools",
 				"label": "tools"
 			},
@@ -116,7 +117,7 @@ All properties are optional, they can be removed from your configuration and wil
 		"infer_ticket": true,
 		"confirm_ticket": true,
 		"add_to_title": true,
-    "append_hashtag": false
+		"append_hashtag": false
 	},
 	"commit_title": {
 		"max_size": 70
@@ -141,16 +142,44 @@ All properties are optional, they can be removed from your configuration and wil
 }
 ```
 
-#### Config Validation
-To simplify the CLI, some rules are enforced at runtime to make sure the program runs properly. Most of these are fairly straight forward.
-- any property can be removed, but it will be replaced by the default
-- if a property is a string/number/boolean in the default, it must maintain that type when modified
-- the `initial_value` must be a valid value in `options`
-- `commit_scope` and `commit_type` can be populated with as many or whatever options you like, as long as they maintain the shape `{value: string, label?: string, hint?: string}`
+#### ✅ 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 strings to it
+  - thus, you can remove from that list, but you can't add custom values to it
+
+#### 🔎 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. 
+
+**Ticket**
+- `STRING-NUMBER` -- If a string-number is at the start of the branch
+- `/STRING-NUMBER` -- If a string-number comes after a /
+
+**Issue**
+- `NUMBER` -- If a number is at the start of the branch
+- `/NUMBER` -- If a number comes after a /
+
+**Type**
+- `TYPE-` -- If a type is at the start of the branch
+- `TYPE/` -- If a slash comes after the type
+- `-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)
 
 ## Alternatives
 - Commitizen

package/src/index.ts

@@ -8,7 +8,8 @@ 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 } 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 } from './utils';
+
 
 main(load_setup());
 
@@ -90,10 +91,16 @@ async function main(config: z.infer<typeof Config>) {
   }
 
   if (config.commit_type.enable) {
+    let initial_value = config.commit_type.initial_value 
+    if (config.commit_type.infer_type_from_branch) {
+      const options = config.commit_type.options.map(o => o.value)
+      const type_from_branch = infer_type_from_branch(options)
+      if (type_from_branch) initial_value = type_from_branch
+    }
     const commit_type = await p.select(
         {
           message: `Select a commit type`,
-          initialValue: config.commit_type.initial_value,
+          initialValue: initial_value,
           options: config.commit_type.options,
         }
     ) as string
@@ -113,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

@@ -2,6 +2,7 @@ import {homedir}  from 'os';
 import { StatusResult } from 'simple-git';
 import { z } from 'zod';
 import color from 'picocolors';
+import { execSync } from 'child_process';
 
 export const CONFIG_FILE_NAME = '.better-commits.json'
 export const SPACE_TO_SELECT = `${color.dim('(<space> to select)')}`
@@ -37,6 +38,25 @@ export const COMMIT_FOOTER_OPTIONS = [
 export const Z_FOOTER_OPTIONS = z.enum(['closes', 'breaking-change', 'deprecated'])
 export const FOOTER_OPTION_VALUES: FOOTER_OPTIONS[] = ['closes', 'breaking-change', 'deprecated']
 
+export function infer_type_from_branch(types: string[]): string {
+  let branch = ''
+  try {
+    branch = execSync('git branch --show-current', {stdio : 'pipe' }).toString();
+  } catch (err) {
+    return ''
+  }
+  const found = types.find(t => {
+    const start_dash = new RegExp(`^${t}-`)
+    const between_dash = new RegExp(`-${t}-`)
+    const before_slash = new RegExp(`${t}\/`)
+    const re = [branch.match(start_dash), branch.match(between_dash), branch.match(before_slash)]
+      .filter(v => v != null)
+    return re?.length
+  })
+
+  return found ?? ''
+}
+
 export function get_default_config_path(): string {
   return homedir()+'/'+CONFIG_FILE_NAME
 }

package/src/zod-state.ts

@@ -1,12 +1,14 @@
 import { z } from "zod"
 import { DEFAULT_SCOPE_OPTIONS, DEFAULT_TYPE_OPTIONS, FOOTER_OPTION_VALUES, Z_FOOTER_OPTIONS } from "./utils"
 
+
 // TODO: add "Ref", "Fixes", ability to change phrase "Closes/closes/closes:"
 export const Config = z.object({
    check_status: z.boolean().default(true),
    commit_type: z.object({
      enable: z.boolean().default(true),
      initial_value: z.string().default('feat'),
+     infer_type_from_branch: z.boolean().default(true),
      options: z.array(z.object({
       value: z.string(),
       label: z.string().optional(),