I like Husky, but I don't like conventional commits until I'm merging to Main.
ShutUpHusky automates your commit messages. Doesn't do it well, but doesn't fail either.
This project should probably be called "ShutUpConventionalCommits", but "ShutUpHusky" is much more catchy.
Stage your changes as you normally would, then:
dotnet run -- --repo C:\Users\You\SomeRepo\
If you want to commit directly without waiting for hooks to run:
dotnet run -- --repo C:\Users\You\SomeRepo\ --in-process true --name "Your Name" --email "you@mail.com"
Less meaningful commit message snippets are discarded if the commit title would exceed 72 characters.
If you want to include discarded commit message snippets in the body:
dotnet run -- --repo C:\Users\You\SomeRepo\ --enable-body true
If you've updated SomeFile.ts, your commit message will read:
chore: updated some-file
If you've updated/created/deleted/renamed a number of files which include a common word:
chore: common > updated common-file, deleted un-common-file, renamed common-ish-file
If you're on a branch matching the regex [a-zA-Z]+\-[0-9]+ such as TICKET-1234:
feat(ticket-1234): updated a-file-on-this-branch
If you have any of the common conventional commit types in your branch name, such as branch/fix/TICKET-4321:
fix(ticket-4321): updated a-file-on-this-branch
If you've mostly been changing tests:
test: updated some-test
If you've mostly been changing yaml files:
ci: updated dev3-deployment
If you've mostly been changing md files:
docs: updated readme
You can scroll through this repo's commits for other examples. All but the first were written by this tool.
To enable experimental features:
dotnet run -- --repo C:\Users\You\SomeRepo\ --experimental true
The current experimental features are:
- CSharpDiffSummarizer.cs
- TypescriptDiffSummarizer.cs
ShutUpHusky will attempt to understand your typescript and csharp code, and write a more useful commit message corresponding to what you've changed. This feature is by no means perfect and sometimes results in strange commit messages such as:
test: created typescript-heuristic-tests, added After = , ,, added , (248a530887b544fde6f74d3aa76b0268d503a596).
However, the messages are often quite handy. For example:
chore: updated constants, added const int LanguageSpecificPriority = 3 (3c78e7bf2a79b1468799d9af2c1079d463b0f7c2).
MIT