Skip to content

feat: parse categorized changeset summaries - #41

Draft
GuillaumeRx wants to merge 7 commits into
mainfrom
gr/changeset-utils-parser
Draft

GuillaumeRx wants to merge 7 commits into
mainfrom
gr/changeset-utils-parser

Conversation

@GuillaumeRx

Copy link
Copy Markdown
Contributor

Explanation

This is PR 2 of the stacked @metamask/changeset-utils implementation. It adds the canonical parser for categorized Changeset summaries.

parseChangesetSummary accepts top-level bullets with the ADDED, CHANGED, REMOVED, or FIXED prefixes. It supports optional **BREAKING:** markers and keeps nested bullets in the parent description. Invalid summaries throw GrammarError with the source line, stable rule identifier, and a correction hint.

The parser does not parse or validate PR links. Later tooling will generate those links when rendering changelogs.

References

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've communicated my changes to consumers by updating changelogs for packages I've changed
  • I've introduced breaking changes in this PR and have prepared draft pull requests for clients and consumer packages to resolve them

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant