A table should be added to the Readme that explains what each property does

This would be a good first time issue / help wanted

I can fill in any gaps or help with any explanations if someone else ends up picking this up

Hi,

Would be nice to have support to emojis, the same way commitzen uses [emoji-cz)[https://github.com/kevin940726/emoji-cz].
Amazing job with better-commits. Thanks!

Kind regards
Vitor Jr.

SimpleGit makes up about 38% of the projects size.

But, better-commits only uses git status from SimpleGit. Which coincidentally creates one of the few known issue in better-commits. (Files that have both staged and unstaged changes only show up as staged)

Action Items

• Create a replacement for git status
• Remove SimpleGit

I have the following error: Something went wrong when committing: Error: spawnSync /bin/sh ENOENT.
I'm using Git Bash on a Windows 11 machine. Initiated the prompt with npx better-commits.
Is there something I could do to fix this issue?

This error looks like a cwd error with bin/sh but when I use the command /bin/sh -c ls bash could find the sh executable.

I've noticed this a couple times while writing a detailed description of the commit. It simply won't show when I look at the commit on GitHub or similar.

Can you reproduce this behaviour?

Not sure if this is possible, but when typing the title for the commit, a count of how many characters are left before hitting the max length would be helpful.

Create a homebrew formula for better-commits so that it can be installed globally with something like brew install better-commits on macOS and Linux.

Could either be a custom tap or included in homebrew/core.

Hi @Everduin94,

As there is currently no SECURITY.md policy in place, could you please activate private vulnerability reporting for this repo to facilitate coordinated vulnerability disclosure?

Thank you.

Hello. I am using the following .better-commits.json config:

{
    "check_status": true,
    "commit_type": {
        "enable": true,
        "initial_value": "feat",
        "infer_type_from_branch": true,
        "append_emoji_to_label": false,
        "append_emoji_to_commit": false,
        "options": [
            {
                "value": "feat",
                "label": "feat",
                "hint": "A new feature",
                "emoji": "✨",
				"trailer": "Changelog: feature"
            },
            {
                "value": "fix",
                "label": "fix",
                "hint": "A bug fix",
                "emoji": "🐛",
				"trailer": "Changelog: fixed"
            },
            {
                "value": "docs",
                "label": "docs",
                "hint": "Documentation only changes",
                "emoji": "📚",
				"trailer": "Changelog: documentation"
            },
            {
                "value": "test",
                "label": "test",
                "hint": "Adding missing tests or correcting existing tests",
                "emoji": "🚨",
				"trailer": "Changelog: test"
            },
            {
                "value": "ci",
                "label": "ci",
                "hint": "Changes to our CI configuration files and scripts",
                "emoji": "🤖",
				"trailer": "Changelog: ci"
            },
            {
                "value": "",
                "label": "none"
            }
        ]
    },
    "commit_scope": {
        "enable": false,
        "custom_scope": false,
        "initial_value": "app",
        "options": [
            {
                "value": "app",
                "label": "app"
            }
        ]
    },
    "check_ticket": {
        "infer_ticket": true,
        "confirm_ticket": true,
        "add_to_title": true,
        "append_hashtag": false,
        "title_position": "start"
    },
    "commit_title": {
        "max_size": 70
    },
    "commit_body": {
        "enable": false,
        "required": false
    },
    "commit_footer": {
        "enable": true,
        "initial_value": ["trailer"]
    },
    "breaking_change": {
        "add_exclamation_to_title": true
    },
    "confirm_commit": true,
    "print_commit_output": true,
    "branch_pre_commands": [],
    "branch_post_commands": [],
    "worktree_pre_commands": [],
    "worktree_post_commands": [],
    "branch_user": {
        "enable": true,
        "required": false,
        "separator": "/"
    },
    "branch_type": {
        "enable": true,
        "separator": "/"
    },
    "branch_ticket": {
        "enable": true,
        "required": false,
        "separator": "-"
    },
    "branch_description": {
        "max_length": 70
    },
    "branch_action_default": "branch",
    "enable_worktrees": true,
    "overrides": {}
}

As you can see from above, in my commit_footer, I only have the initial value left out:

    "commit_footer": {
        "enable": true,
         "initial_value": ["trailer"]
    },

I am trying to simplify the commit process and we do not really need to select from the below list:

Since I only left the "initial_value": ["trailer"] I was hoping that I will no longer need to select out of the other optional footers (closes, breaking change, deprecated, custom list and it will automatically select a trailer option for me but that is not the case.

I would very much appreciate if someone could clarify how can I remove this select list when I am performing commit whilst always appending trailers based on commit types.

Context

Based on #68 (@groovyghoul)

Today, although each part is optional, the order in the branch name when running better-branch is fixed.

USER/TYPE/TICKET-DESCRIPTION

Tasks

Create a property branch_template

• Default: user/type/ticket-description

Zod Validation

• Enforce key words: ["user", "type", "ticket", "description", "version"]
• Enforce separators: ["/", "-", "_"]

Regex

• Update builder to use template
• See #70 make sure to not break inference between these two changes

Add either

• A way to make custom fields / prompts
• Optional version number field (leaning towards this for now)

Outstanding Tasks

• This will effectively make fields like optional or separator redundant in some cases. Should we deprecate?

Create an example commit that uses most of better-commits features.

Add a video to the readme demonstrating this commit.

Better Commits has the git emoji configuration enabled.

However, semantic release is not setup to recognize this.

Thus, a commit such as: ✨ feat(something): my commit -- runs a successful build, but doesn't tag/deploy a new version.

Add plugin: https://github.com/momocow/semantic-release-gitmoji ?

Hi @Everduin94 thanks for the nice piece of software. Just curious, I saw on the commit type there is no 'chore' type. I am using commitizen before. Can we add?

i made a bare git repo in ~/.cfg, for my dotfiles i wanna do the following:

• a repo specific .better-commits.json
• use git --git-dir=$HOME/.cfg --work-tree=$HOME for using better commits for staged files only i have status.showUntrackedFiles = no

is it possible? thanks

Hey, thanks for making this! It looks really cool.

I just started playing around with it and noticed that my issue did not close. Can you maybe tell what went wrong?

T   better-commits
|
o  Found repository config
|
o   Checking Git Status
|
*  Changes to be committed:
|  .better-commits.json
|
o  Select a commit type
|  fix
|
o  Select a commit scope
|  yo momma
|
o  Ticket / issue infered from branch (confirm / edit)
|  1
|
o  Write a brief title describing the commit
|  Calculate weight of yo momma
|
o  Write a detailed description of the changes (optional)
|  So far it has not been possible to compute the weight of your mom but now we know she is so fat.
|
o  Select optional footers (<space> to select)
|  closes <issue/ticket>, breaking change
|
o  Breaking changes: Write a short title / summary
|  Yo momma breaks everything she sits on
|
o  Breaking Changes: Write a description & migration instructions (optional)
|  Breaks chairs, sofas, and so on
|
o  Commit Preview -----------------------------------------------------------------------------------+
|                                                                                                    |
|  fix(yo-momma)!: 1 Calculate weight of yo momma                                                    |
|                                                                                                    |
|  So far it has not been possible to compute the weight of your mom but now we know she is so fat.  |
|                                                                                                    |
|  BREAKING CHANGE: Yo momma breaks everything she sits on                                           |
|                                                                                                    |
|  Breaks chairs, sofas, and so on                                                                   |
|                                                                                                    |
|  Closes: 1                                                                                         |
|                                                                                                    |
+----------------------------------------------------------------------------------------------------+
|
o  Confirm Commit?
|  Yes

I then merged the branch (fix/1-yo-momma-so-fat) via a merge commit: grandeljay/better-commits-test@643c432 but the issue did not close or was mentioned/linked in any way.

What did I do wrong?

I can't find the way to write multi line in detailed description of the chages session

Context

Based on #69

Today, although each property is optional, the order in the title is fixed to match conventional commits.

TYPE(SCOPE): TICKET DESCRIPTION

Tasks

Create a property title_template

• Default: type(scope): ticket description

Zod Validation

• Enforce key words: ["type", "scope", "ticket", "description"]
• Enforce separators: ["/", "-", "_", "[]", "()", ":", "{}"]

Regex

• Update string builder to use template

Concerns

• More difficult to enforce things like "if () is empty remove, if no text before colon then remove colon" etc...

Outstanding Tasks

• This will effectively make fields like optional or separator redundant in some cases. Should we deprecate?
• We may want to add some way to add custom fields / prompts

Hello. I use Gitlab built-in feature (glab) to generate Changelogs for my projects based on Commit trailer messages as described here:
https://docs.gitlab.com/ee/user/project/changelogs.html

In order for glab to detect commits, each commit needs to have a commit trailer. My commit example:

git commit -m "fixed voltage measurement issue" --trailer "Changelog: fixed"

The following commit with a trailer will then show up in the Gitlab as shown below:

And when I generate the changelog, it will look something like:

## 1.0.2-5-g796eb48
 (2024-01-25)

### fixed (1 change)

- [fixed voltage measurement issue](testing/universal-testboard-v3@825b7b5474216ab7abc84af033b417a766952e8e) ([merge request](testing/universal-testboard-v3!1))

Since I am making all commit messages and commit trailers by hand, this method is very sensitive to human error. For example if I make typo when writing a commit trailer, the glab will not detect the commits.

I was hoping to use better-commits to automate this process and ensure each commit is tagged with appropriate commit trailer based on selected commit type.

For example, I have a list of commit types:

    "commit_type": {
        "enable": true,
        "initial_value": "feat",
        "infer_type_from_branch": true,
        "append_emoji_to_label": false,
        "append_emoji_to_commit": false,
        "options": [
            {
                "value": "feat",
                "label": "feat",
                "hint": "A new feature",
                "emoji": "✨"
            },
            {
                "value": "fix",
                "label": "fix",
                "hint": "A bug fix",
                "emoji": "🐛"
            },
            {
                "value": "docs",
                "label": "docs",
                "hint": "Documentation only changes",
                "emoji": "📚"
            },
            {
                "value": "test",
                "label": "test",
                "hint": "Adding missing tests or correcting existing tests",
                "emoji": "🚨"
            },
            {
                "value": "ci",
                "label": "ci",
                "hint": "Changes to our CI configuration files and scripts",
                "emoji": "🤖"
            },
            {
                "value": "",
                "label": "none"
            }
        ]
    },

Is there a possibility to append a trailer to commit message based on selected commit type? For example, if I select feat , I want to automatically append Changelog: added as my Commit trailer.

If I select fix, I want to append Changelog: fixed and etc...

Thanks in advance!

Hi there,

I am getting the following error, I did see this in the troubleshooting section, I wouldn't be hurt if you close this issue directly:

Steps to reproduce:

• npm install -g better-commits.
• go to folder which has an existing repository, open git bash.
• type: better-commits

Using:

• Windows 10
• NVM
• Node 19.8.1
• Git bash (seems to be the problem, powershell does work).

Hello. I have been using globally installed better-commits (using npm install -g better-commits) and everything was fine.

Since we have many people on the team working on the same project (repository), I would like to install the better-commits package locally to the repository and upload the node_modules and package.json to git to ensure that all team members can just simply use the package out of the box

I cd into my repository and installed the better-commits locally using npm install better-commits and uninstalled the global package using npm uninstall -g better-commits. After that, I uploaded all the generated node files to the git.

After I uninstalled the better-commits globally, I have tried to use the locally installed better-commits but that does not seem to work even though the npm list says that I have the package installed:

Could someone clarify to me what could be an issue and how to correctly use locally installed package?

My guess is that when I run better-commits it is looking for node_modules in the local directory which is:
C:\Users\petrikas.lu\AppData\Roaming\npm\node_modules

However, node_modules exist in the project directory

It'd be nice for performance nerd to be able to use pNPM.

We are using clickup and our branch name are structured as:
CU-863gvp799_Run-tests-only-if-not-PR-in-draft

When moving through the flow it wont pre-populate the ticket correctly and seems to cut off after the last number:

If there is no configuration that will cover this, I am happy to contribute.

My config:

{
    "check_status": true,
    "commit_type": {
        "enable": true,
        "initial_value": "feat",
        "infer_type_from_branch": true,
        "append_emoji_to_label": false,
        "append_emoji_to_commit": false,
        "options": [
            {
                "value": "hotfix",
                "label": "hotfix",
                "hint": "Hotfixing any critical bug",
                "emoji": "🚨"
            },
            {
                "value": "feat",
                "label": "feat",
                "hint": "A new feature",
                "emoji": "✨"
            },
            {
                "value": "fix",
                "label": "fix",
                "hint": "A bug fix",
                "emoji": "🐛"
            },
            {
                "value": "docs",
                "label": "docs",
                "hint": "Documentation only changes",
                "emoji": "📚"
            },
            {
                "value": "refactor",
                "label": "refactor",
                "hint": "A code change that neither fixes a bug nor adds a feature",
                "emoji": "🔨"
            },
            {
                "value": "perf",
                "label": "perf",
                "hint": "A code change that improves performance",
                "emoji": "🚀"
            },
            {
                "value": "test",
                "label": "test",
                "hint": "Adding missing tests or correcting existing tests",
                "emoji": "🚨"
            },
            {
                "value": "build",
                "label": "build",
                "hint": "Changes that affect the build system or external dependencies",
                "emoji": "🚧"
            },
            {
                "value": "ci",
                "label": "ci",
                "hint": "Changes to our CI configuration files and scripts",
                "emoji": "🤖"
            },
            {
                "value": "chore",
                "label": "chore",
                "hint": "Other changes that do not modify src or test files",
                "emoji": "🧹"
            },
            {
                "value": "",
                "label": "none"
            }
        ]
    },
    "commit_scope": {
        "enable": true,
        "custom_scope": false,
        "initial_value": "app",
        "options": [
            {
                "value": "app",
                "label": "app"
            },
            {
                "value": "config",
                "label": "config"
            },
            {
                "value": "tools",
                "label": "tools"
            },
            {
                "value": "infrastructure",
                "label": "infrastructure"
            },
            {
                "value": "",
                "label": "none"
            }
        ]
    },
    "check_ticket": {
        "infer_ticket": true,
        "confirm_ticket": true,
        "add_to_title": true,
        "append_hashtag": false,
        "title_position": "start"
    },
    "commit_title": {
        "max_size": 70
    },
    "commit_body": {
        "enable": true,
        "required": false
    },
    "commit_footer": {
        "enable": true,
        "initial_value": [],
        "options": [
            "deprecated",
            "closes",
            "breaking-change",
            "custom"
        ]
    },
    "breaking_change": {
        "add_exclamation_to_title": true
    },
    "confirm_commit": true,
    "print_commit_output": true,
    "branch_pre_commands": [],
    "branch_post_commands": [],
    "branch_user": {
        "enable": false,
        "required": false,
        "separator": "/"
    },
    "branch_type": {
        "enable": false,
        "separator": "/"
    },
    "branch_ticket": {
        "enable": true,
        "required": false,
        "separator": "_"
    },
    "branch_description": {
        "max_length": 70
    }
}

Hello,

I'm a developer working with a team where we follow a specific commit message convention: type(scope): [jira_id] Commit_title. We are interested in using the better-commits tool to streamline our development process. However, we have encountered an issue that better-commits does not seem to support customizing the ticket format in the check_ticket configuration, particularly adding brackets around the ticket ID.

Our team's convention requires the JIRA ticket ID to be enclosed in square brackets ([jira_id]), which is a crucial part of our workflow. Currently, the better-commits tool allows adding a ticket to the title but does not support this specific format.

I would like to inquire if there is any consideration for introducing a feature that allows customizing the ticket format, particularly for adding brackets around the ticket ID. If there's an interest in supporting this feature, I would be very eager to contribute to the project, ideally starting in early February.

Thank you for your time and consideration, and I look forward to any guidance or suggestions you may have on this matter.

Hi, if you're reading this, then I'd like your input 😅

A new feature I'm planning would be an additional prompt / cli for generating a branch following a common convention

Some features

• infer user name
• prompt feature
• prompt ticket / issue
• prompt title
• run pre-checkout scripts
• run post-checkout scripts

It would generate a branch name like this:

everduin94/feat/28-better-branches

And run any scripts like npm install, git pull, etc...

Does this feature make sense? Anything that should be added or considered? Does this seem useful to your workflow?

When I have a branch without a ticket that can be inferred, eg my-feature-branch, but specify the ticket manually, the hash is not added to the ticket. Example:

.better-commits.json (partial)

	"check_ticket": {
		"infer_ticket": true,
		"confirm_ticket": true,
		"add_to_title": true,
		"append_hashtag": true,
		"surround": "",
		"title_position": "start"
	},

output (branch my-branch):

┌   better-commits 
│
◇  Found repository config
│
◇   Checking Git Status 
│
◆  Changes to be committed:
│  styles.css
│
◇  Select a commit type
│  ✨ feat
│
◇  Add ticket / issue (optional)
│  5
│
◇  Write a brief title describing the commit
│  abc
│
◇  Write a detailed description of the changes (optional)
│  123
│
◇  Select optional footers (<space> to select)
│  closes <issue/ticket>
│
◇  Commit Preview ─╮
│                  │
│  ✨ feat: 5 abc   │
│                  │
│  123             │
│                  │
│  Closes: 5       │
│                  │
├──────────────────╯
│
◇  Confirm Commit?
│  No
│
●  Exiting without commit

First, thank you for this fantastic tool.

Just checking if there is a way to make it work with https://github.com/sds/overcommit

I tried twice but it's not evoking overcommit.

It would be nice if I could use my normal $EDITOR to see (or touch up) my commit message, rather than displaying it in-line for the final confirmation step.

How can I write multi-line description for commit?

❯ git status
On branch feat/productpage
Your branch is up to date with 'origin/feat/productpage'.

Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
        renamed:    content/en/products.md -> content/en/pricing.md

[15:04:11][patrick@Behemoth]~/gitlab.com/wonderland/wonderland-engine-website(+1|%0|ok)
❯ 

followed by better-commit:

┌   better-commits 
│
◇  Found global config
│
◇   Checking Git Status 
│
◆  Changes to be committed:
│  
│
■  no changes added to commit (use "git add" and/or "git commit -a")

How about adding a simple description next to commit types, such as the Angular convention:

And simply adding those here

I always struggle to choose the right one and end up opening my browser to find which is for what

Just tried to install on a new machine and when I first run the "better-commits" command. The following response was given:

Found global config
│
■ Invalid Configuration: commit_type.max_items
│ Invalid type: Expected number but received null

I've had a look into the base global configuration file and for both commit_type.max_items & commit_scope.max_items are both set to null by default. Tried inputting the default configuration provided in the README, but the compains about "Infinity". Only way I can resolve this is to hardcode the max_items property to a specific number.

We do pair programming a lot. We wanted to use this tool so badly, but it doesn't have co-authored by. Can you add this as well ????

Currently, better-commits process for deploying looks like this:

• manually bump version number in package.json
• manually build via npm run build
• manually publish via npm publish

Utilizing Github Actions + Semantic Release, we could automate this process. Which would make accepting other user's PRs simpler.

This would be a good first time issue / help wanted -- as I won't be able to get to this for a while

It could also be helpful to support JS configuration because scopes could be generated automatically based on folders structure using node path utils.

Issue:
A commit message containing " does not work.

Proposing:
Make it possible to add special characters into a commit message.

Zod makes up 30% of the size of better-commits. Zod is crucial to better-commits, so it shouldn't simply be removed. But, better-commits is a very small project and uses a minimal amount of the Zod API.

Thus, replacing Zod with Valibot seems like a pretty good choice for a project of this size.

Action Items

• Replace Zod with Valibot
• Replace Zod-Validation-Error
• Remove Zod

Caveat: Better-commits makes use of advanced utilities like refine and transform. See this documentation for replacements. Namely, custom and transform

Caveat: Unsure of effort needed to replace Zod-Validation-Error

no matter how long or short the title is, I can't make a commit.

I want to add Alias for better-commits cmd. Any recommended way?

To support a future feature "better-branch", a CLI for following branch naming conventions. We want to be able to infer the type from the branch name.

The description body still show when I'm using better-commit in cli.
But it disappeared after commit. It also disappeared in github UI. Just show only short description

Can you integrate AI to auto-generate a part of better-commits

For example: https://github.com/Nutlope/aicommits

Hi, please add license to project :)