fix(prd): stop PRD titles corrupting the README index#31
Merged
ralyodio merged 1 commit intoJul 21, 2026
Merged
Conversation
regenerateIndex() passed the new index block to String.replace() as a replacement string, so a PRD title containing a special pattern ($&, $`, $', $$) was interpreted instead of inserted literally — splicing the old index back into itself and corrupting prd/README.md. Use a function replacement (() => block) so the block is written verbatim regardless of title content. Adds a regression test.
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
2 participants
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
regenerateIndex()rebuilds theprd/README.mdindex by callingbody.replace(regex, replacementString)with the freshly rendered index blockas the replacement string.
String.prototype.replacetreats$&,$`,$',$$and$nin a replacement string as special patterns. PRD titles areuser-supplied, so a title such as
Add $& live supportgets its$&expandedinto the matched text — splicing the old index block back into itself and
corrupting the README.
Reproduction (before this change)
Fix
Pass a function replacement (
() => block). A function's return value isinserted verbatim, so no
$-sequence in a title is ever interpreted. One-linechange, no behaviour change for normal titles.
Test
Adds a regression test to
test/prd.test.mjsthat creates a PRD whose titleholds
$&and asserts the index markers still appear exactly once. It fails onmainand passes with this fix. Full suite green (node --test).