feat(commits): add Conventional Commits message normalizer#178
Open
iamlasse wants to merge 1 commit into
Open
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
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
Adds a reusable Conventional Commits commit-message normalizer for nightshift, exposed both as a library and a CLI subcommand, plus an installable commit-msg hook.
Changes
internal/commits/normalizer.go— pure, dependency-freeNormalize(msg string) (string, error)plus typed validation. Enforces the allowed type set (feat/fix/docs/style/refactor/test/chore/perf/build/ci), lowercases the type, requires a lowercase subject ≤ 72 chars, trims whitespace and trailing periods, strips git comment lines, and hard-wraps the body at 72 columns. Normalization is idempotent.internal/commits/normalizer_test.go— table-driven tests covering valid messages, scope handling, comment stripping, body wrapping, missing/unknown type, missing subject, capitalized subject, overlong subject, empty input, and idempotency.cmd/nightshift/commands/commit.go—nightshift commit normalizesubcommand accepting a positional argument,--file(for the commit-msg hook), or stdin, with--checkfor validate-only.scripts/commit-msg.sh— git commit-msg hook that normalizes the message file in place and rejects non-conforming messages.docs/commit-messages.md— documents the format, the command, and hook installation.Verification
go build ./...✅go vet ./...✅go test ./...✅ (all packages pass, including newinternal/commits)nightshift commit normalize(positional,--file, valid + rejected cases)Closes the commit-normalize task.
Nightshift-Task: commit-normalize
Nightshift-Ref: https://github.com/marcus/nightshift