feat(commits): support breaking-change marker and preserve git footers - #197
Open
iamlasse wants to merge 2 commits into
Open
feat(commits): support breaking-change marker and preserve git footers#197iamlasse 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
Extend the Conventional Commits normalizer to close two spec gaps: the breaking-change marker is now parsed and preserved, and structured git footers are emitted verbatim instead of being reflowed into prose. - parse the "!" breaking marker after the type or scope (feat!: / feat(scope)!:) and round-trip it through the canonical header so the marker survives normalization - accept the "revert" type - detect a trailing footer block (Fixes marcus#123, BREAKING CHANGE:, Reviewed-by:, project trailers) and emit it verbatim, while prose paragraphs are still hard-wrapped at 72 columns - add table-driven tests for the new forms and confirm Normalize stays idempotent - document the format and the CLI / commit-msg hook usage in README.md - update the commit-msg hook help text to advertise "!" and "revert" 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
Closes two real Conventional Commits spec gaps in the existing normalizer (
internal/commits/normalizer.go), which previously rejected the breaking-change marker as an unknown type and reflowed structured git footers into prose.Breaking-change marker
!marker that sits between the type/scope and the colon —feat!:andfeat(scope)!:— inparseHeader, and carry abreakingflag throughformatHeaderso the canonical form preserves it. Without this,feat!was consumed into the type and rejected as unknown.reverttype.Footer preservation
Fixes #123,BREAKING CHANGE:,Reviewed-by:, project trailers likeNightshift-Task:) — and emit it verbatim instead of hard-wrapping it. Prose paragraphs are still wrapped at 72 columns; only the structured trailer block is left untouched.Tests & docs
!marker (with/without scope),revert, footer preservation, footer-line shape detection, andfeat!:round-tripping;Normalizeconfirmed idempotent on all new forms.README.mddocumenting<type>(<scope>)!: <subject>, the allowed type set, subject length, and hownightshift commit normalize/ thecommit-msghook consume it.commit-msg.shhelp text now advertises!andrevert.gofmt,go vet ./..., andgo test ./...are green.Nightshift-Task: commit-normalize
Nightshift-Ref: https://github.com/marcus/nightshift
Automated by nightshift