chore(commits): install commit-msg hook via make install-hooks - #209
Open
iamlasse wants to merge 2 commits into
Open
chore(commits): install commit-msg hook via make install-hooks#209iamlasse wants to merge 2 commits into
iamlasse wants to merge 2 commits into
Conversation
Add internal/commits with pure Normalize/validate functions enforcing the project's Conventional Commits rules (known type set, lowercase type, lowercase subject, 72-char subject limit, whitespace trimming, and 72-column body wrapping). Wire it into the CLI as 'nightshift commit normalize' (positional, --file, and stdin sources; --check to validate only), ship a commit-msg git hook under scripts/, and document the format and installation in docs/commit-messages.md. Nightshift-Task: commit-normalize Nightshift-Ref: https://github.com/marcus/nightshift
Wire scripts/commit-msg.sh into 'make install-hooks' so the Conventional Commits normalizer is enforced (and installed) out of the box, alongside the existing pre-commit hook. Update the Makefile help text and the README hooks section to document both hooks. 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
Finishes the Commit Message Normalizer feature by wiring up the already-implemented
nightshift commit normalizetooling so it is enforced out of the box, and documenting it.Problem
The normalizer library (
internal/commits), thenightshift commit normalizeCLI command, thescripts/commit-msg.shenforcement hook, anddocs/commit-messages.mdall exist — but Conventional Commits enforcement was invisible by default:make install-hookswired up onlyscripts/pre-commit.shand never installedscripts/commit-msg.sh, so the normalizer was never active on commits.Changes
install-hooksnow also symlinksscripts/commit-msg.shinto.git/hooks/commit-msg(in addition to pre-commit). Help text in both theinstall-hookstarget and thehelptarget updated to say "git pre-commit and commit-msg hooks".make install-hooksalso installs a commit-msg hook that enforces/rewrites Conventional Commits vianightshift commit normalize, linking todocs/commit-messages.md.No new library logic — the normalizer and CLI are unchanged. This branch also carries the existing normalizer commit (
feat(commits): add Conventional Commits message normalizer) since it is not yet onmain.Verification
go test ./internal/commits/...— greengo build ./...— compilesmake install-hooks— both.git/hooks/pre-commitand.git/hooks/commit-msgsymlinked toscripts/✓commit-msghook being wired up here ✓Nightshift-Task: commit-normalize
Nightshift-Ref: https://github.com/marcus/nightshift
Automated by nightshift