skalt/git-cc

a git extension to help write conventional commits

git-cc's Issues

fuzzy search rather than prefix-match search

When I have many scopes, I'd prefer to use fuzzy search rather than strict prefix matching.

bug: `git cc -m "feat"` supplies "feat " to TUI

bug: scope coerced to lowercase

Which isn't required by the conventional commits spec

search git repo root for configuration

Currently, only the CWD and $HOME are searched!

Write some end-to-end tests

Not having a good test suite is a perpetual source of shame. To prevent further dishonor:

• research how to test bubbletea applications
• test at least the selectors
• run the tests in github actions

feature request: warn about replacing - with _ in `commit-convention.{yaml,toml,json}`

feature request: `--redo` flag

Often, I find myself doing

git cc -m "feat: ..." 
echo "pre-commit hooks rejected my commit"
# make fixes
git commit -m "$(cat ./.git/COMMIT_EDITMSG)"

It would be nice to encode this workflow as git cc --redo

bug: newline in input invisibly halts matching

Reproduction:

git cc -m "feat
"

Expected behavior: identical to git cc -m "feat"
Actual behavior: deletion of newline required prior to matching "feat\n" as "feat"

RFC: rename the binary to `git-conventional-commit`, retaining `git-cc` as a symlink/alias

The name git-cc doesn't tell you what it does. cc could stand for anything, from email's carbon-copy to cubic centimeters. Worse still, cc is impractically short for tab-completion. git c<tab> brings up all the git subcommand which start with c, with cc somewhere below the top of the list.

Proposal: rename the binary to git-conventional-commit, with git-cc retained as a symlink and/or git-alias. That way, git conv<tab> will complete to git conventional-commit without additional configuration, while git cc [...] will still work normally. Based on my initial experimentation, symlinking git-conventional-commit -> git-cc breaks git tab-completion in bash/zsh, likely due to the symlink's file-mode being different than just a user-executable file: I got lrwxrwxrwx

To avoid renaming the binary, you could git config --global alias.conventional-commit 'cc'. However, that's another installation step in a tool that's meant to be maximally convenient.

To my ~1-2 users: Thoughts?

feature request: show an error message when the user tries to select an invalid option

Selection resets when cursor blinks

Using up/down to select an item gets reset to the first item when the app re-renders as the cursor blinks.

migrate licence to indiecc's standard deal

This code was previously made available under stricteq's standard deal (for reference, here's the archive of stricteq). The operator of stricteq migrated the site to indecc.com and updated the standard deal to https://indiecc.com/deal/4.0.1 (pessimistically, here's an archive of indiecc too).
I'm still interested in participating in their licensing experiment, so the TODOs are:

• update LICENSE.md
• register this project on indiecc.com

support signoff flags

i.e. -s/--signoff/--no-signoff

bug: --no-verify not passed to git-commit

which makes dealing with pre-commit git hooks a pain.

Error when installing (`arch: command not found`)

I tried to install following the README guide:

repo=skalt/git-cc
branch=master
curl -sL https://raw.githubusercontent.com/$repo/$branch/scripts/install.sh | sh

I got this error:

main: line 77: arch: command not found

feature request: make adding new scopes/types easier

When I want to enter a new commit-type or scope, I have to

• remember what the new item was called
• write out the new item in the appropriate place in the configuration document.

I'd like to

• have the new item copied to my clipboard so that I don't have to remember it
• if possible, place my cursor at the appropriate location within the config document
• if possible, place a template entry for the new item within the config document at the right location

sign releases for mac

Add to Scoop Installler or Winget Installer for Windows Support

Can the CLI be pushed to Winget or Scoop package managers for windows officially ?
so one can easily
scoop install git-cc
or
winget install git-cc

For now the only option is to use eget which doesn't perform global updates

feature request: update list of available scopes on close of the config file

currently, I've got to close the file, focus the terminal, and press a key before the updated scope becomes available.

feature request: respect other conventional-commit tools' configuration

i.e. conventional-changelog / commitlint config to start with.

feature request: `--init` flag or subcommand

I'd like to run

git cc init --yaml

to render the default configuration file to ${repo_root}/.config/commit_convention.yaml

bug: git cc -m "valid(commit): message" breaks into GIT_EDITOR

instead of being validated and committing directly.

publish homebrew tap

see https://goreleaser.com/customization/homebrew/?h=tap

scope prompt goes offscreen when too many scopes are present

Like 20 of 'em should do the trick.

Expected behavior:

• list cuts off at screen height with some indicator of pagination
• scrolling down/up maintains a smooth view of the scope candidates, the prompt, and the help-bar

Unable to create custom scopes using CLI

I tried to create new scopes using the CLI and after typing scope's name and hit enter, scope was not created and no response was given. After looking into the code, I found the reason: $EDITOR is not set and vi is not installed in my system

Navigation with Ctrl+n/p

In addition to up/down

selector lines get mangled on each keystroke on small terminals

On small terminals (I'm not yet sure what exact column width) each keystroke prints extra lines. This is likely due to how line-wrapping and listening for terminal resizing works in pkg/single_select.

select a commit type:
select a commit type:
select a commit type:
select a commit type:
select a commit type:
   type to select
   feat     adds a new feature
   fix      fixes a bug
   docs     changes only the documentation
   style    changes the style but not the meaning of the code (such as formatting)
 > perf     improves performance
   test     adds or corrects tests
   build    changes the build system or external dependencies
   chore    changes outside the code, docs, or tests
   ci       changes to the Continuous Inegration (CI) system
   refactor changes the code without changing behavior
   revert   reverts prior changes

submit: tab/enter; navigate: up/down; cancel: ctrl+c

feature request: allow using subdirs as scopes

like pkg/* should let me use any of the pkg/* directories' names as scopes.

feature request: allow drawing scopes from a subshell/callback

like sh -c ./scripts/get-scopes.sh

support multiple -m|--message flags

In vanilla git, if you git commit -m "foo" -m "bar", this should produce

foo

bar

See https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--mltmsggt