feat: block layout for long/multiline/markdown changelog entries#122
Merged
Conversation
|
The changes in this PR will be included in the next version bump.
|
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
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.


Problem
Both changelog formatters always jammed the entry description onto the same line as the metadata, e.g.
- #50 (major) Thanks @Saeris! - <summary>. That reads fine for a short one-liner, but badly when the summary is markdown or long (see discordkit's CHANGELOG).Change
Added a shared heuristic
summaryNeedsBlockLayout()that switches an entry to a block layout — metadata on its own line, summary indented below — when the summary is any of:#heading, list item,>blockquote,```/~~~fence, table row), anchored to line starts so a stray|in prose doesn't trigger it.Short single-line summaries stay inline exactly as before. The block path also now preserves internal blank lines so markdown paragraphs/lists render correctly. Applied to both the default and
githubformatters.Thresholds live as single constants (
INLINE_SUMMARY_MAX_LENGTH,MARKDOWN_BLOCK_RE) inchangelog.ts.Tests
oxlint+tsc --noEmitclean.