fix: URL-encode rule doc link targets - #997
Open
bmish wants to merge 1 commit into
Open
Conversation
Encode path segments and urlRuleDoc name substitutions so spaces, parentheses, and similar characters do not break CommonMark links. Co-authored-by: Cursor <cursoragent@cursor.com>
This was referenced Jul 19, 2026
bmish
marked this pull request as ready for review
July 19, 2026 15:07
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.
Summary
pathToUrl), including charactersencodeURIComponentleaves alone that break CommonMark destinations ((,),!){name}portion of string--url-rule-doctemplates; leave the template itself untouchedurlRuleDocfunction return values; leave absolute URLs (://) as-is so callers own encodingTest plan
npm run lintnpm testno foo (bar)assert exact%20/%28/%29in snapshots for relative links, string templates, and relative function returnsMade with Cursor
Context
From the post-#987 standards audit:
pathToUrlhandled Windows separator conversion but never URL-encoded, so a rule doc path containing a space or parenthesis produced a broken link — CommonMark terminates a plain link destination at whitespace or an unbalanced).(,), and!also pass throughencodeURIComponentuntouched, hence the explicit replacements.Scope guard: only tool-generated relative paths and the substituted
{name}portion are encoded; user-supplied absolute URLs and template text are left to the caller, so nothing pre-encoded gets double-encoded.