Commit Message Parser #42
Merged
Conversation
This file contains 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
Commit message parsed into 3 parts, summary line, body and footer.
Wrote exhaustive tests for commit parsing.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Commit Message Parser
Overview
This PR implements a commit message parser that extracts the summary, body, and footer from messages adhering to common conventions. It handles various edge cases, including messages with random whitespace and multiple footers.
Key Features
Parser Functionality: The parse_commit_message function identifies:
Summary: First line of the message.
Body: Content following the summary.
Footer: Lines that match footer patterns (e.g., "BREAKING CHANGE").
Edge Case Handling: Gracefully manages empty messages, single-line messages, and body content containing footer-like text.
Regular Expressions: Uses regex to accurately identify footer lines.
Testing
Comprehensive unit tests cover a range of scenarios, ensuring reliable functionality across different commit message formats.
Conclusion
This parser improves commit message management, enforcing conventions and enhancing commit quality. Feedback and suggestions are welcome!