feat(hooks): add Conventional Commits normalizer#174
Open
pistell wants to merge 1 commit into
Open
Conversation
Standardize commit messages with a POSIX shell normalizer wired to the commit-msg hook. Lowercases the type, trims whitespace, enforces a 72-char subject limit, preserves trailers, and skips merge/fixup/revert commits. Ships with .gitmessage template, scripts/setup-hooks.sh, docs/commit-conventions.md, and 12 fixture-driven test cases. Enable for a clone with: scripts/setup-hooks.sh Nightshift-Task: commit-normalize Nightshift-Ref: https://github.com/marcus/nightshift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
scripts/commit-normalizer.sh) wired into acommit-msggit hook (.githooks/commit-msg).<type>(<scope>)!: <subject>with a 72-char subject limit; lowercases the type, trims whitespace, preserves bodies and trailers..gitmessagetemplate,scripts/setup-hooks.sh(configurescore.hooksPathandcommit.template),docs/commit-conventions.md, and a fixture-driven test harness (12 cases, all passing).make setup-hooksandmake test-commit-normalizertargets.Standard
Allowed types:
feat,fix,docs,style,refactor,perf,test,build,ci,chore,revert. Append!to mark a breaking change. Trailers likeCo-Authored-By,Fixes,Signed-off-by,Nightshift-Taskare preserved verbatim.Enable on a clone
./scripts/setup-hooks.sh # or make setup-hooksBypass once:
COMMIT_NORMALIZER=0 git commit -m "...".Test coverage
tests/commit-normalizer/cases/covers:!(preserved)#lines removed)Test plan
make test-commit-normalizer→ 12/12 passingmake setup-hooksand confirms a malformedgit commit -m "foo"is rejected with a helpful errorNightshift-Task: commit-normalize
Nightshift-Ref: https://github.com/marcus/nightshift