Skip to content

Release notes window: numbered lists, wrapped items, one title - #92

Open
TheMightyTRex wants to merge 1 commit into
logabell:mainfrom
TheMightyTRex:contrib/release-notes-window
Open

TheMightyTRex wants to merge 1 commit into
logabell:mainfrom
TheMightyTRex:contrib/release-notes-window

Conversation

@TheMightyTRex

Copy link
Copy Markdown

Problem

The release notes window, opened from the version in the sidebar, does not show Dewarr's own release notes well:

  • The release's name appears twice. The window shows it as the entry's title, and the notes themselves start with the same line, for example "# Dewarr v0.3.9".
  • Numbered lists lose their numbers. The notes parser only recognises lines starting with - or * , so a numbered list is shown as a run of plain text.
  • A list item that continues on an indented line is broken up. The continuation line is shown as a separate paragraph after the list.

Change

  • releaseNotes.ts: the parser recognises numbered list items (1. ), keeps an indented continuation line with the item above it, and keeps nested items in the same list. List blocks now say whether they are ordered.
  • ApplicationRelease.tsx: ordered lists render as <ol>. When the first block of the notes is a heading that matches the release's name, it is not shown again.
  • styles.css: headings in the notes are bold and sized by level, numbered lists show their numbers, and list items have a little more space between them.

Testing

  • Unit tests in releaseNotes.test.ts for wrapped items, nested items and numbered lists (3 of 3 pass).
  • New mocked UI test tests/ui/release-notes-layout.spec.ts: the release's name appears once, a wrapped item stays one item, a numbered list is shown with numbers, and section headings are bold.
  • npm run typecheck, npm run build and prettier --check src tests pass.
  • Full mocked UI suite (playwright.ui.config.ts, Chromium): 148 of 148 pass.

🤖 Generated with Claude Code

The release notes window opened from the version in the sidebar showed
Dewarr's notes badly. The release's name appeared twice, because the
notes themselves start with "# Dewarr vX.Y.Z". Numbered lists lost
their numbers and became plain paragraphs, and a list item that
continued on an indented line was split off from its item.

- The notes parser recognises numbered lists and keeps an indented
  continuation line with the item above it. Nested items are kept in
  the same list.
- A first heading that matches the release's name is not shown again.
- Headings in the notes are bold and sized by level, and numbered
  lists show their numbers.

Adds unit tests for the parser and a mocked UI test of the window.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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